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:61

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

alreadyClaimed​

alreadyClaimed: boolean = false;

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

authenticated​

authenticated: boolean = false;

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

container​

container: HTMLElement;

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

frame​

frame: HTMLIFrameElement;

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

frameOrigin​

protected frameOrigin: string = '';

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

link: URL;

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

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:51

settings​

protected settings: S;

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

wrapper​

wrapper: HTMLDivElement;

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

Accessors​

seen​

Get Signature​

get seen(): boolean;

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

Returns​

boolean

Methods​

_emit()​

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

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

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:95

Parameters​

state​

string

value?​

string | Record<string, string>

Returns​

void

close()​

close(): void;

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

Returns​

void

Deprecated​

  • use #remove() instead

createFrame()​

createFrame(): void;

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

Returns​

void

destroy()​

destroy(): void;

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

Remove all listeners and destroy state Instance will no longer be usable

Returns​

void

embed()​

embed(): void;

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

Returns​

void

onAlreadyClaimed()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onAuthenticated()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onClose()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

onError()​

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

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

Parameters​

callback​

ErrorCallbackFn

once​

boolean = false

Returns​

RegisteredListener

onMessage()​

onMessage(callback: MessageCallbackFn): RegisteredListener;

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

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:187

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:144

Parameters​

target​

EventTarget

type​

string

handler​

EventListenerOrEventListenerObject

options?​

boolean | AddEventListenerOptions

Returns​

RegisteredListener

reload()​

reload(): void;

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

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:320

Remove the experience entirely

Returns​

void

removeEvent()​

removeEvent(listener: RegisteredListener): void;

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

Remove a registered event listener

Parameters​

listener​

RegisteredListener

Returns​

void