urbanairship-core/com.urbanairship.analytics/Analytics

Analytics

class Analytics @VisibleForTesting constructor(context: Context, dataStore: PreferenceDataStore, runtimeConfig: AirshipRuntimeConfig, privacyManager: PrivacyManager, airshipChannel: AirshipChannel, activityMonitor: ActivityMonitor, localeManager: LocaleManager, executor: Executor, eventManager: EventManager, permissionsManager: PermissionsManager, eventFeed: AirshipEventFeed, clock: Clock = Clock.DEFAULT_CLOCK) : AirshipComponent

This class is the primary interface to the Airship Analytics API.

Constructors

Analytics

@VisibleForTesting

constructor(context: Context, dataStore: PreferenceDataStore, runtimeConfig: AirshipRuntimeConfig, privacyManager: PrivacyManager, airshipChannel: AirshipChannel, activityMonitor: ActivityMonitor, localeManager: LocaleManager, executor: Executor, eventManager: EventManager, permissionsManager: PermissionsManager, eventFeed: AirshipEventFeed, clock: Clock = Clock.DEFAULT_CLOCK)

Types

Companion

object Companion

Properties

associatedIdentifiers

val associatedIdentifiers: AssociatedIdentifiers

conversionSendId

var conversionSendId: String?

Returns the last stored send Id from when a push conversion was detected.

events

val events: SharedFlow<AirshipEventData>

A shared flow of raw event tracked by Airship.

isEnabled

val isEnabled: Boolean

regionState

val regionState: StateFlow<Set<String>>

The current list of region IDs tracked using com.urbanairship.analytics.location.RegionEvent.

screenState

val screenState: StateFlow<String?>

The name of the screen that is currently being tracked by trackScreen

sessionId

var sessionId: String

Gets the current environment Id.

Functions

addEvent

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun addEvent(event: Event): Boolean

editAssociatedIdentifiers

fun editAssociatedIdentifiers(): AssociatedIdentifiers.Editor

Edits the currently stored associated identifiers. All changes made in the editor are batched, and not stored until you call apply(). Calling apply() on the editor will associate the identifiers with the device and add an event that will be sent up with other analytics events. See com.urbanairship.analytics.AssociatedIdentifiers.Editor

recordCustomEvent

fun recordCustomEvent(event: CustomEvent)

Records a region event.

recordRegionEvent

fun recordRegionEvent(event: RegionEvent)

Records a region event.

trackScreen

@MainThread

fun trackScreen(screen: String?)

Initiates screen tracking for a specific app screen, must be called once per tracked screen.

uploadEvents

fun uploadEvents()

Uploads any pending events. Events are batched and uploaded automatically to conserve battery life. Normally apps should not call this method directly.