Interface Uplynk

The Uplynk API.

Remarks

- Only available with the feature 'uplynk'.

interface Uplynk {
    ads: UplynkAds;
    assets: UplynkAssetList;
    addEventListener<TType extends keyof UplynkEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof UplynkEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<UplynkEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<UplynkEventMap>
- Uplynk

Index

Properties

Methods

addEventListener removeEventListener

Properties

`Readonly`ads

The Uplynk SSAI API.

`Readonly`assets

assets: UplynkAssetList

List of Uplynk assets.

Methods

addEventListener

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

removeEventListener

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