Class AnalyticsUtility

Helper class for sending analytics events.

Index

Constructors

Accessors

Methods

ready sendCustomEvent setMetaData

Constructors

constructor

new AnalyticsUtility(visual): AnalyticsUtility
Parameters
- visual: Visual
Returns AnalyticsUtility
- Defined in util/analyticsUtility.ts:203

Accessors

sessionId

get sessionId(): string
Returns the session ID that is utilized for each event that is sent.

Returns string
The session ID for the Analytics library.

Deprecated
Use the 'sessionID' accessor on an instance of the Visual class instead.
- Defined in util/analyticsUtility.ts:296

Methods

ready

ready(): Promise<void>
Returns a resolved Promise when the Analytics Utility has finished initializing.

Returns Promise<void>
A Promise that resolves when the Analytics Utility is finished initializing.
- Defined in util/analyticsUtility.ts:287

sendCustomEvent

sendCustomEvent(eventName, properties?): void
Sends a custom event to the analytics service.
Parameters
- eventName: string
  The name of the custom event to send.
- Optional properties: object
  Event-specific information to include.
Returns void
- Defined in util/analyticsUtility.ts:305

setMetaData

setMetaData(metaData?): void
Sets event-agnostic properties to send with each event.
Parameters
- Optional metaData: AnalyticsMetaData
  The additional properties to include.
Returns void
- Defined in util/analyticsUtility.ts:320

Generated using TypeDoc