Skip to content

@get-advantage/advantage / types / AdvantageFormatIntegration

Interface: AdvantageFormatIntegration

types.AdvantageFormatIntegration

Properties

close

Optional close: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => void

Type declaration

▸ (wrapper, adIframe?): void

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

void

Defined in

src/types/index.ts:141


format

format: string

Defined in

src/types/index.ts:131


onClose

Optional onClose: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => void

Deprecated

use close

Type declaration

▸ (wrapper, adIframe?): void

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

void

Defined in

src/types/index.ts:150


onReset

Optional onReset: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => void

Deprecated

use reset

Type declaration

▸ (wrapper, adIframe?): void

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

void

Defined in

src/types/index.ts:155


options

Optional options: AdvantageFormatOptions

Defined in

src/types/index.ts:132


reset

Optional reset: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => void

Type declaration

▸ (wrapper, adIframe?): void

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

void

Defined in

src/types/index.ts:145


setup

setup: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => Promise<void>

Type declaration

▸ (wrapper, adIframe?): Promise<void>

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

Promise<void>

Defined in

src/types/index.ts:133


teardown

Optional teardown: (wrapper: IAdvantageWrapper, adIframe?: HTMLIFrameElement | HTMLElement) => void

Type declaration

▸ (wrapper, adIframe?): void

Parameters
NameType
wrapperIAdvantageWrapper
adIframe?HTMLIFrameElement | HTMLElement
Returns

void

Defined in

src/types/index.ts:137