Class AnalyticsApi

Provides the means to control the analytics collected by a Player. Use the Player.analytics property to access a Player's AnalyticsApi.

Index

Constructors

Properties

Methods

getUserId sendCustomDataEvent

Constructors

constructor

new AnalyticsApi(playerId: string): AnalyticsApi
Parameters
- playerId: string
Returns AnalyticsApi
- Defined in analytics/player.ts:14

Properties

playerId

playerId: string

The native player id that this analytics api is attached to.

Methods

getUserId

getUserId(): Promise<null | string>
Gets the current user id used by the bundled analytics instance.

Returns Promise<null | string>
The current user id.
- Defined in analytics/player.ts:31

sendCustomDataEvent

sendCustomDataEvent(customData: CustomDataConfig): Promise<void>
Sends a sample with the provided custom data. Does not change the configured custom data of the collector or source.
Parameters
- customData: CustomDataConfig
Returns Promise<void>
- Defined in analytics/player.ts:22