Interface: PlandalfSDK

Defined in: packages/sdk/src/core/types.ts:415

Properties

harnesses

harnesses: object

Defined in: packages/sdk/src/core/types.ts:450

get()

get(id): HarnessDefinition

Parameters

id

string

Returns

HarnessDefinition

register()

register(harness): void

Parameters

harness

HarnessDefinition

Returns

void

Methods

addGate()

addGate(name, flow, check?): void

Defined in: packages/sdk/src/core/types.ts:426

Parameters

name

string

flow

string

check?

GateCheck<any>

Returns

void

from()

from(el): PromoHandle | FlowHandle<unknown> | null

Defined in: packages/sdk/src/core/types.ts:440

Parameters

el

Element

Returns

PromoHandle | FlowHandle<unknown> | null

gate()

gate(name, sync?, options?): Promise<GateResult>

Defined in: packages/sdk/src/core/types.ts:427

Parameters

name

string

sync?

GateSyncCallback

options?

Partial<FlowOpenOptions>

Returns

Promise<GateResult>

getAnonId()

getAnonId(): string

Defined in: packages/sdk/src/core/types.ts:419

Returns

string

identify()

identify(token): void

Defined in: packages/sdk/src/core/types.ts:417

Parameters

token

string

Returns

void

mount()

mount(target, slug, opts?): FlowHandle<Flow>

Defined in: packages/sdk/src/core/types.ts:433

Parameters

target

string | HTMLElement

slug

string

opts?

MountOptions

Returns

FlowHandle<Flow>

present()

present(slug, options?): FlowHandle<FlowResult>

Defined in: packages/sdk/src/core/types.ts:432

Parameters

slug

string

options?

Partial<FlowOpenOptions>

Returns

FlowHandle<FlowResult>

promo()

promo(slug, options?): unknown

Defined in: packages/sdk/src/core/types.ts:447

Parameters

slug

string

options?

interval?

number

redirect?

boolean

Returns

unknown

reset()

reset(): void

Defined in: packages/sdk/src/core/types.ts:418

Returns

void