Skip to main content

Popup

@vtagz/web-sdk

Class: Popup

Defined in: packages/core/src/Popup.ts:7

Extends​

Constructors​

Constructor​

new Popup(settings: PopupSettings): Popup;

Defined in: packages/core/src/Popup.ts:8

Parameters​

settings​

PopupSettings

Returns​

Popup

Overrides​

SDKBase.constructor

Properties​

_seenThisSession​

protected _seenThisSession: boolean;

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

Inherited from​

SDKBase._seenThisSession

_sessionId​

protected _sessionId: null | string = null;

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

Inherited from​

SDKBase._sessionId

alreadyClaimed​

alreadyClaimed: boolean = false;

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

Inherited from​

SDKBase.alreadyClaimed

authenticated​

authenticated: boolean = false;

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

Inherited from​

SDKBase.authenticated

container​

container: HTMLElement;

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

Inherited from​

SDKBase.container

frame​

frame: HTMLIFrameElement;

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

Inherited from​

SDKBase.frame

frameOrigin​

protected frameOrigin: string = '';

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

Inherited from​

SDKBase.frameOrigin

link: URL;

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

Inherited from​

SDKBase.link

listeners​

protected listeners: RegisteredListener[] = [];

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

Inherited from​

SDKBase.listeners

mode​

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

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

Inherited from​

SDKBase.mode

ready​

ready: boolean = false;

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

Inherited from​

SDKBase.ready

settings​

protected settings: PopupSettings;

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

Inherited from​

SDKBase.settings

wrapper​

wrapper: HTMLDivElement;

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

Inherited from​

SDKBase.wrapper

Accessors​

seen​

Get Signature​

get seen(): boolean;

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

Returns​

boolean

Inherited from​

SDKBase.seen

Methods​

_emit()​

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

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

Parameters​

event​

string

data?​

unknown

Returns​

void

Inherited from​

SDKBase._emit

_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

Inherited from​

SDKBase._sendMessage

close()​

close(): void;

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

Returns​

void

Deprecated​

  • use #remove() instead

Inherited from​

SDKBase.close

createFrame()​

createFrame(): void;

Defined in: packages/core/src/Popup.ts:13

Returns​

void

Overrides​

SDKBase.createFrame

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

Inherited from​

SDKBase.destroy

embed()​

embed(): void;

Defined in: packages/core/src/Popup.ts:18

Returns​

void

Overrides​

SDKBase.embed

onAlreadyClaimed()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

Inherited from​

SDKBase.onAlreadyClaimed

onAuthenticated()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

Inherited from​

SDKBase.onAuthenticated

onClose()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

Inherited from​

SDKBase.onClose

onError()​

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

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

Parameters​

callback​

ErrorCallbackFn

once​

boolean = false

Returns​

RegisteredListener

Inherited from​

SDKBase.onError

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

Inherited from​

SDKBase.onMessage

onReady()​

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

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

Parameters​

callback​

CallbackFn

once​

boolean = false

Returns​

RegisteredListener

Inherited from​

SDKBase.onReady

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

Inherited from​

SDKBase.registerEvent

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

Inherited from​

SDKBase.reload

remove()​

remove(): void;

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

Remove the experience entirely

Returns​

void

Inherited from​

SDKBase.remove

removeEvent()​

removeEvent(listener: RegisteredListener): void;

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

Remove a registered event listener

Parameters​

listener​

RegisteredListener

Returns​

void

Inherited from​

SDKBase.removeEvent