Interface RunWaterfallHooks

Hooks to configure the behaviour of the ad.

Hierarchy

Hooks
- RunWaterfallHooks

Index

Methods

createClickControl? createSkipControl? getMediaFile? transformVastResponse? validateVastResponse?

Methods

`Optional` createClickControl

createClickControl(): HTMLElement
If provided it will be called to generate the click control. Must return a clickable HTMLElement that is detached from the DOM.

Returns HTMLElement
Inherited from Hooks.createClickControl
- Defined in types/vast.ts:539

`Optional` createSkipControl

createSkipControl(): HTMLElement
If provided it will be called to generate the skip control. Must return a clickable HTMLElement that is detached from the DOM.

Returns HTMLElement
Inherited from Hooks.createSkipControl
- Defined in types/vast.ts:535

`Optional` getMediaFile

getMediaFile(mediaFiles, screenRect): MediaFile
If provided it will be called to get a MediaFile by size of the current video element.
Parameters
- mediaFiles: MediaFile[]
- screenRect: DOMRect
Returns MediaFile
Inherited from Hooks.getMediaFile
- Defined in types/vast.ts:543

`Optional` transformVastResponse

transformVastResponse(vastChain): VastChain
If provided it will be called with the current VastChain before building the adUnit allowing the modification of the vastResponse if needed.
Parameters
- vastChain: VastChain
Returns VastChain
- Defined in runner/runWaterfall.ts:199

`Optional` validateVastResponse

validateVastResponse(vastChain): void
If provided it will be called passing the current VastChain for each valid vast response. Must throw if there is a problem with the vast response. If the Error instance has an code number then it will be tracked using the error macros in the Vast response. It will also call ~onError with the thrown error.
Parameters
- vastChain: VastChain
Returns void
- Defined in runner/runWaterfall.ts:195

Generated using TypeDoc