Interface Imagine

The Imagine API.

interface Imagine {
    playing: boolean;
    addEventListener<TType extends keyof ImagineEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<ImagineEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof ImagineEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<ImagineEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<ImagineEventMap>
- Imagine

Index

Properties

Methods

addEventListener removeEventListener

Properties

`Readonly`playing

playing: boolean

Whether an Imagine ad is playing.

Methods

addEventListener

addEventListener<TType extends keyof ImagineEventMap>(
type: TType | readonly TType[],
listener: EventListener<ImagineEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof ImagineEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<ImagineEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

removeEventListener

removeEventListener<TType extends keyof ImagineEventMap>(
type: TType | readonly TType[],
listener: EventListener<ImagineEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof ImagineEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<ImagineEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener