Skip to main content

SDKBase

@vtagz/web-sdk

Class: abstract SDKBase<S>

Defined in: packages/core/src/SDKBase.ts:41

Extends​

  • EventTarget

Extended by​

Type Parameters​

S​

S extends BaseSettings = BaseSettings

Constructors​

Constructor​

new SDKBase<S>(settings: S, mode: undefined | "popup" | "capture" | "full" | "loyalty"): SDKBase<S>;

Defined in: packages/core/src/SDKBase.ts:65

Parameters​

settings​

S

mode​

undefined | "popup" | "capture" | "full" | "loyalty"

Returns​

SDKBase<S>

Overrides​

EventTarget.constructor

Properties​

_seenThisSession​

protected _seenThisSession: boolean;

Defined in: packages/core/src/SDKBase.ts:48

_sessionId​

protected _sessionId: null | string = null;

Defined in: packages/core/src/SDKBase.ts:52

alreadyClaimed​

alreadyClaimed: boolean = false;

Defined in: packages/core/src/SDKBase.ts:56

authenticated​

authenticated: boolean = false;

Defined in: packages/core/src/SDKBase.ts:59

container​

container: HTMLElement;

Defined in: packages/core/src/SDKBase.ts:62

frame​

frame: HTMLIFrameElement;

Defined in: packages/core/src/SDKBase.ts:61

frameOrigin​

protected frameOrigin: string = '';

Defined in: packages/core/src/SDKBase.ts:47

link: URL;

Defined in: packages/core/src/SDKBase.ts:60

listeners​

protected listeners: RegisteredListener[] = [];

Defined in: packages/core/src/SDKBase.ts:49

mode​

protected mode: "popup" | "capture" | "full" | "loyalty";

Defined in: packages/core/src/SDKBase.ts:50

ready​

ready: boolean = false;

Defined in: packages/core/src/SDKBase.ts:55

settings​

protected settings: S;

Defined in: packages/core/src/SDKBase.ts:46

wrapper​

wrapper: HTMLDivElement;

Defined in: packages/core/src/SDKBase.ts:63

Accessors​

seen​

Get Signature​

get seen(): boolean;

Defined in: packages/core/src/SDKBase.ts:180

Returns​

boolean

Methods​

_emit()​

_emit(event: string, data?: unknown): void;

Defined in: packages/core/src/SDKBase.ts:304

Parameters​

event​

string

data?​

unknown

Returns​

void

_sendMessage()​

protected _sendMessage(state: string, value?: string | Record<string, string>): void;

Defined in: packages/core/src/SDKBase.ts:137

Parameters​

state​

string

value?​

string | Record<string, string>

Returns​

void

close()​

close(): void;

Defined in: packages/core/src/SDKBase.ts:371

Returns​

void

Deprecated​

  • use #remove() instead

createFrame()​

createFrame(): void;

Defined in: packages/core/src/SDKBase.ts:162

Returns​

void

destroy()​

destroy(): void;

Defined in: packages/core/src/SDKBase.ts:350

Remove all listeners and destroy state. Instance will no longer be usable. Clears container contents instead of removing the container element so that React can manage the container's lifecycle without DOM conflicts.

Returns​

void

embed()​

embed(): void;

Defined in: packages/core/src/SDKBase.ts:312

Returns​

void

onAlreadyClaimed()​

onAlreadyClaimed(callback: CallbackFn, once: boolean): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:259

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onAuthenticated()​

onAuthenticated(callback: CallbackFn, once: boolean): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:243

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onClose()​

onClose(callback: CallbackFn, once: boolean): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:275

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onError()​

onError(callback: ErrorCallbackFn, once: boolean): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:289

Parameters​

callback​

ErrorCallbackFn

once​

boolean = false

Returns​

RegisteredListener

onMessage()​

onMessage(callback: MessageCallbackFn): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:213

Helper method for receiving data from VTAGZ

Parameters​

callback​

MessageCallbackFn

Returns​

RegisteredListener

onReady()​

onReady(callback: CallbackFn, once: boolean): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:229

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

registerEvent()​

protected registerEvent(
   target: EventTarget, 
   type: string, 
   handler: EventListenerOrEventListenerObject, 
   options?: boolean | AddEventListenerOptions): RegisteredListener;

Defined in: packages/core/src/SDKBase.ts:186

Parameters​

target​

EventTarget

type​

string

handler​

EventListenerOrEventListenerObject

options?​

boolean | AddEventListenerOptions

Returns​

RegisteredListener

reload()​

reload(): void;

Defined in: packages/core/src/SDKBase.ts:155

Reloads the experience to reset the input state for new subscriptions. Can be disabled by passing the option "disableReload: true"

Returns​

void

remove()​

remove(): void;

Defined in: packages/core/src/SDKBase.ts:364

Remove the experience entirely

Returns​

void

removeEvent()​

removeEvent(listener: RegisteredListener): void;

Defined in: packages/core/src/SDKBase.ts:201

Remove a registered event listener

Parameters​

listener​

RegisteredListener

Returns​

void