CustomForm

@mammothmedia/web-sdk

---

Class: CustomForm

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

Extends

• SDKBase<CustomFormSettings>

Constructors

Constructor

new CustomForm(settings: CustomFormSettings): CustomForm;

Defined in: packages/core/src/CustomForm.ts:79

Parameters

settings

CustomFormSettings

Returns

CustomForm

Overrides

SDKBase.constructor

Properties

_seenThisSession

protected _seenThisSession: boolean;

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

Inherited from

SDKBase._seenThisSession

---

_sessionId

protected _sessionId: null | string = null;

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

Inherited from

SDKBase._sessionId

---

alreadyClaimed

alreadyClaimed: boolean = false;

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

Inherited from

SDKBase.alreadyClaimed

---

authenticated

authenticated: boolean = false;

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

Inherited from

SDKBase.authenticated

---

container

container: HTMLElement;

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

Inherited from

SDKBase.container

---

email

email: InputInterface;

Defined in: packages/core/src/CustomForm.ts:77

---

errorMessages

errorMessages: object;

Defined in: packages/core/src/CustomForm.ts:73

CampaignConflict

CampaignConflict: string = 'This number is already enrolled in a program';

InvalidEmail

InvalidEmail: string = 'A valid email is required';

InvalidNumber

InvalidNumber: string = 'A valid US number is required';

---

frame

frame: HTMLIFrameElement;

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

Inherited from

SDKBase.frame

---

frameOrigin

protected frameOrigin: string = '';

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

Inherited from

SDKBase.frameOrigin

---

input

input: InputInterface;

Defined in: packages/core/src/CustomForm.ts:76

---

inputState

inputState: InputState;

Defined in: packages/core/src/CustomForm.ts:75

---

link

link: URL;

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

Inherited from

SDKBase.link

---

listeners

protected listeners: RegisteredListener[] = [];

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

Inherited from

SDKBase.listeners

---

mode

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

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

Inherited from

SDKBase.mode

---

ready

ready: boolean = false;

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

Inherited from

SDKBase.ready

---

settings

protected settings: CustomFormSettings;

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

Inherited from

SDKBase.settings

---

shadowRoot

shadowRoot: ShadowRoot;

Defined in: packages/core/src/CustomForm.ts:74

---

wrapper

wrapper: HTMLDivElement;

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

Inherited from

SDKBase.wrapper

Accessors

seen

Get Signature

get seen(): boolean;

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

Returns

boolean

Inherited from

SDKBase.seen

Methods

_emit()

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

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

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

Parameters

state

string

value?

string | Record<string, string>

Returns

void

Inherited from

SDKBase._sendMessage

---

close()

close(): void;

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

Returns

void

Deprecated

• use #remove() instead

Inherited from

SDKBase.close

---

connectInput()

connectInput(): void;

Defined in: packages/core/src/CustomForm.ts:169

Returns

void

---

createFrame()

createFrame(): void;

Defined in: packages/core/src/CustomForm.ts:92

Returns

void

Overrides

SDKBase.createFrame

---

destroy()

destroy(): void;

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

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/CustomForm.ts:97

Returns

void

Overrides

SDKBase.embed

---

onAlreadyClaimed()

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

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

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

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

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

Parameters

callback

ErrorCallbackFn

once

boolean = false

Returns

RegisteredListener

Inherited from

SDKBase.onError

---

onInputChange()

onInputChange(callback: InputChangeCallbackFn): RegisteredListener;

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

Helper method for listening to input change events

Parameters

callback

InputChangeCallbackFn

Returns

RegisteredListener

---

onMessage()

onMessage(callback: MessageCallbackFn): RegisteredListener;

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

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

Parameters

callback

CallbackFn

once

boolean = false

Returns

RegisteredListener

Inherited from

SDKBase.onReady

---

onSuccess()

onSuccess(callback: SuccessCallbackFn, once: boolean): RegisteredListener;

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

Helper method for listening to successful submissions. The callback receives the data the iframe sent with the submission (e.g. { claimId }), forwarded from the "submitted" frame event.

Parameters

callback

SuccessCallbackFn

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

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

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

Remove the experience entirely

Returns

void

Inherited from

SDKBase.remove

---

removeEvent()

removeEvent(listener: RegisteredListener): void;

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

Remove a registered event listener

Parameters

listener

RegisteredListener

Returns

void

Inherited from

SDKBase.removeEvent

---

submit()

submit(callback?: (success: boolean) => boolean): void;

Defined in: packages/core/src/CustomForm.ts:151

Parameters

callback?

(success: boolean) => boolean

Returns

void