Class MtsEventsImpl

Dispatches MTS business events.

Hierarchy (View Summary)

EventHostImpl<MtsEventMap>
- MtsEventsImpl

Implements

MtsEvents

Index

Constructors

Properties

Accessors

[toStringTag] options

Methods

dispatch dispose hasAnyListeners hasListeners initializePersistence on

Constructors

constructor

new MtsEventsImpl(deps: MtsEventsImplDeps): MtsEventsImpl
Parameters
- deps: MtsEventsImplDeps
Returns MtsEventsImpl
Overrides EventHostImpl.constructor
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:265

Properties

`Readonly`logPrefix

logPrefix: string

A string prefix for all log statements made by this target.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:253

options

get options(): MtsEventsImplOptions
Returns MtsEventsImplOptions
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:270

Methods

dispatch

dispatch<K extends keyof MtsEventMap>(type: K, event: MtsEventMap[K]): void
Dispatches an event.
Type Parameters
- K extends keyof MtsEventMap
Parameters
- type: K
  The key of the event within EventMap
- event: MtsEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:65

dispose

dispose(): void
Returns void
Overrides EventHostImpl.dispose
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:744

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of MtsEvents.hasAnyListeners
Inherited from EventHostImpl.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:62

hasListeners

hasListeners(type: keyof MtsEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof MtsEventMap
Returns boolean
Implementation of MtsEvents.hasListeners
Inherited from EventHostImpl.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:63

initializePersistence

initializePersistence(__namedParameters: MtsEventsPersistenceOptions): void
Stores pending events to persistence. If the app is closed before the player unloads a track, these events will be recovered and emitted (asynchronously) when this function is called. Events will be saved to persistence
Parameters
- __namedParameters: MtsEventsPersistenceOptions
Returns void
Implementation of MtsEvents.initializePersistence
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:274

on

on<K extends keyof MtsEventMap>(
    type: K,
    handler: EventHandler<MtsEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof MtsEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<MtsEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Implementation of MtsEvents.on
Inherited from EventHostImpl.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:64