Interface: ReferralOptions

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:78

Init-time overrides (referral in plandalf('init', …) / configure, or data-config-referral-* on the script tag). Each wins over the program config returned by the server.

Properties

optional consent?: boolean | "required"

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:95

Default capture behaviour is immediate. Set to 'required' to wait until plandalf('consent', true) before reading URL params or storage.

optional cookie?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:84

Mirror the token into this cookie name as well as pf_rt.

cookieDomain?

optional cookieDomain?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:86

Explicit root domain for referral cookies, e.g. example.co.uk.

decorate?

optional decorate?: string | string[]

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:90

Hostnames whose outbound links get pf_rt appended on click.

global?

optional global?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:82

window[global] = token — compatibility with an old tool's global.

metadataKey?

optional metadataKey?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:88

Key used by handle.metadata(). Default: program config (plandalf_referral).

params?

optional params?: string | string[]

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:80

Link params that carry a partner code. Default: program config (via).