Documentation / @frak-labs/react-sdk / useReferralInteraction

useReferralInteraction(args?): Error | "idle" | "processing" | "success" | "no-referrer" | "self-referral"

Defined in: react/src/hook/helper/useReferralInteraction.ts:26

Helper hook to automatically submit a referral interaction when detected

Runs once when the Frak client becomes available.

Parameters

args?

options?

ProcessReferralOptions

Some options for the referral interaction

Returns

Error | "idle" | "processing" | "success" | "no-referrer" | "self-referral"

The resulting referral state, or a potential error

See

`referralInteraction()` for more details on the automatic referral handling process