@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

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

void

Defined in

src/types/index.ts:122

---

format

• format: string

Defined in

src/types/index.ts:112

---

onClose

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

Deprecated

use close

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

void

Defined in

src/types/index.ts:131

---

onReset

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

Deprecated

use reset

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

void

Defined in

src/types/index.ts:136

---

options

• Optional options: AdvantageFormatOptions

Defined in

src/types/index.ts:113

---

reset

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

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

void

Defined in

src/types/index.ts:126

---

setup

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

Type declaration

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

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

Promise<void>

Defined in

src/types/index.ts:114

---

teardown

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

Type declaration

▸ (wrapper, adIframe?): void

Parameters

Name	Type
wrapper	IAdvantageWrapper
adIframe?	HTMLIFrameElement | HTMLElement

Returns

void

Defined in

src/types/index.ts:118