urbanairship-core/com.urbanairship.analytics

Package-level declarations

Types

Link copied to clipboard
class AirshipEventData(val id: String, val sessionId: String, var body: JsonValue, val type: EventType, val timeMs: Long)

Airship event data.

Link copied to clipboard
class Analytics @VisibleForTesting @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) 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.

Link copied to clipboard
class AssociatedIdentifiers(val ids: Map<String, String> = emptyMap()) : JsonSerializable

Creates a map of associated identifier. Used to associate identifiers with Analytics.editAssociatedIdentifiers.

Link copied to clipboard
class CustomEvent : Event, JsonSerializable

A class that represents a custom event for the application.

Link copied to clipboard
abstract class Event @JvmOverloads constructor(clock: Clock = Clock.DEFAULT_CLOCK, timeMilliseconds: Long = clock.currentTimeMillis())

This abstract class encapsulates analytics events.

Link copied to clipboard
enum EventType : Enum<EventType>

Event type.

Link copied to clipboard
class InstallReceiver : BroadcastReceiver

Tracks Google Play Store install referrals. The receiver needs to be added to the manifest before the install referrals will be tracked:

Functions

Link copied to clipboard
fun customEvent(name: String, block: CustomEvent.Builder.() -> Unit): CustomEvent

Creates a new CustomEvent.

@JvmOverloads
fun customEvent(type: AccountEventTemplate.Type, properties: AccountEventTemplate.Properties = AccountEventTemplate.Properties(), block: CustomEvent.Builder.() -> Unit): CustomEvent

Creates a new CustomEvent from a AccountEventTemplate.

@JvmOverloads
fun customEvent(type: MediaEventTemplate.Type, properties: MediaEventTemplate.Properties = MediaEventTemplate.Properties(), block: CustomEvent.Builder.() -> Unit): CustomEvent

Creates a new CustomEvent from a MediaEventTemplate.

@JvmOverloads
fun customEvent(type: RetailEventTemplate.Type, properties: RetailEventTemplate.Properties = RetailEventTemplate.Properties(), block: CustomEvent.Builder.() -> Unit): CustomEvent

Creates a new CustomEvent from a RetailEventTemplate.

@JvmOverloads
fun customEvent(type: SearchEventTemplate.Type, properties: SearchEventTemplate.Properties = SearchEventTemplate.Properties(), block: CustomEvent.Builder.() -> Unit): CustomEvent

Creates a new CustomEvent from a SearchEventTemplate.

Generated by Dokka
©2025 Airship