Skip to content

Companion

object Companion

NameSummary
arrivalfun arrival(referrerWallet: String?, referrerClientId: String?, referrerMerchantId: String?, referralTimestamp: Long?): Interaction
A referral arrival. Built for you by id.frak.sdk.AppLinkApi.handleReferral; tracking one yourself for a link the SDK already handled double-counts it, as the arrival schema carries no idempotency key.
customfun custom(customType: String): Interaction
Anything the three built-in shapes do not cover. customType is free-form; the route’s schema is the authority, so an unrecognised value comes back as a 4xx.
fun custom(customType: String, data: Map<String, String>): Interaction
data is sent verbatim as the event’s data object.
fun custom(customType: String, data: Map<String, String>, idempotencyKey: String?): Interaction
sharingfun sharing(): Interaction
A share, timestamped at enqueue. What the sharing sheet reports when the user shares.
fun sharing(purchaseId: String?): Interaction
A share tied to a purchase, timestamped at enqueue.
fun sharing(sharingTimestamp: Long?, purchaseId: String?): Interaction
A share with an explicit timestamp and/or the purchase it followed. sharingTimestamp is Unix SECONDS; null is stamped at enqueue, so a queued event reports when the share happened rather than when it was delivered.