Class AirshipAnalytics

Airship analytics.

Index

Constructors

Methods

addCustomEvent associateIdentifier getSessionId trackScreen

Constructors

constructor

new AirshipAnalytics(module: any): AirshipAnalytics
Parameters
- module: any
Returns AirshipAnalytics
- Defined in src/AirshipAnalytics.ts:7

Methods

addCustomEvent

addCustomEvent(event: CustomEvent): Promise<void>
Adds a custom event.
Parameters
- event: CustomEvent
  The custom event.
Returns Promise<void>
A promise that returns null if resolved, or an Error if the custom event is rejected.
- Defined in src/AirshipAnalytics.ts:35

associateIdentifier

associateIdentifier(key: string, identifier?: string): Promise<void>
Associates an identifier.
Parameters
- key: string
  The key.
- Optionalidentifier: string
  The identifier. null to remove.
Returns Promise<void>
A promise.
- Defined in src/AirshipAnalytics.ts:16

getSessionId

getSessionId(): Promise<string>
Gets the Airship session ID. The session ID is a UUID that updates on foreground and background.

Returns Promise<string>
A promise.
- Defined in src/AirshipAnalytics.ts:43

trackScreen

trackScreen(screen?: string): Promise<void>
Tracks a screen.
Parameters
- Optionalscreen: string
  The screen. null to stop tracking.
Returns Promise<void>
A promise.
- Defined in src/AirshipAnalytics.ts:25