Class AdClickThroughButton

<theoplayer-ad-clickthrough-button> - A button to open the advertisement's click-through webpage.

Hierarchy

LinkButton<this> & StateReceiverElement<this>
- AdClickThroughButton

Constructors

constructor

new AdClickThroughButton(): AdClickThroughButton
Returns AdClickThroughButton
Overrides StateReceiverMixin(LinkButton, ['player']).constructor
- Defined in components/ads/AdClickThroughButton.ts:27

Properties

`Optional` activeVideoQuality

activeVideoQuality?: VideoQuality

`Optional` deviceType

deviceType?: DeviceType

`Optional` error

error?: THEOplayerError

`Optional` fullscreen

fullscreen?: boolean

`Optional` playbackRate

playbackRate?: number

`Optional` previewTime

previewTime?: number

`Optional` streamType

streamType?: StreamType

`Optional` targetVideoQualities

targetVideoQualities?: VideoQuality[]

`Readonly` theoplayerUiObservedProperties

theoplayerUiObservedProperties: (keyof StateReceiverPropertyMap)[]

The names of the properties this element will receive.

Accessors

clickThrough

get clickThrough(): null | string
Returns null | string
- Defined in components/ads/AdClickThroughButton.ts:42
set clickThrough(clickThrough): void
Parameters
- clickThrough: null | string
Returns void
- Defined in components/ads/AdClickThroughButton.ts:46

disabled

get disabled(): boolean
Whether the button is disabled.

When disabled, the button cannot be clicked.

Returns boolean
Inherited from StateReceiverMixin(LinkButton, ['player']).disabled
- Defined in components/LinkButton.ts:80
set disabled(disabled): void
Parameters
- disabled: boolean
Returns void
Inherited from StateReceiverMixin(LinkButton, ['player']).disabled
- Defined in components/LinkButton.ts:84

player

get player(): undefined | ChromelessPlayer
Returns undefined | ChromelessPlayer
Overrides StateReceiverMixin(LinkButton, ['player']).player
- Defined in components/ads/AdClickThroughButton.ts:54
set player(player): void
Parameters
- player: undefined | ChromelessPlayer
Returns void
Overrides StateReceiverMixin(LinkButton, ['player']).player
- Defined in components/ads/AdClickThroughButton.ts:58

`Static` observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Overrides StateReceiverMixin(LinkButton, ['player']).observedAttributes
- Defined in components/ads/AdClickThroughButton.ts:23

Methods

`Protected` _upgradeProperty

_upgradeProperty(prop): void
Parameters
- prop: keyof AdClickThroughButton
Returns void
Inherited from StateReceiverMixin(LinkButton, ['player'])._upgradeProperty
- Defined in components/LinkButton.ts:41

attributeChangedCallback

attributeChangedCallback(attrName, oldValue, newValue): void
Parameters
- attrName: string
- oldValue: any
- newValue: any
Returns void
Overrides StateReceiverMixin(LinkButton, ['player']).attributeChangedCallback
- Defined in components/ads/AdClickThroughButton.ts:69

connectedCallback

connectedCallback(): void
Returns void
Overrides StateReceiverMixin(LinkButton, ['player']).connectedCallback
- Defined in components/ads/AdClickThroughButton.ts:37

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from StateReceiverMixin(LinkButton, ['player']).disconnectedCallback
- Defined in components/LinkButton.ts:70

`Protected` handleClick

handleClick(): void
Returns void
Overrides StateReceiverMixin(LinkButton, ['player']).handleClick
- Defined in components/ads/AdClickThroughButton.ts:114

`Protected` setLink

setLink(href, target): void
Parameters
- href: string
- target: string
Returns void
Inherited from StateReceiverMixin(LinkButton, ['player']).setLink
- Defined in components/LinkButton.ts:88

Generated using TypeDoc