Documentation / @frak-labs/core-sdk / actions / referralInteraction

referralInteraction(client, args?): Promise<"idle" | "processing" | "success" | "no-referrer" | "self-referral" | undefined>

Defined in: actions/referral/referralInteraction.ts:21

Function used to handle referral interactions

Parameters

client

FrakClient

The current Frak Client

args?

options?

ProcessReferralOptions

Some options for the referral interaction

Returns

Promise<"idle" | "processing" | "success" | "no-referrer" | "self-referral" | undefined>

A promise with the resulting referral state, or undefined in case of an error

See

processReferral for more details on the automatic referral handling process