firebase-analytics/com.google.firebase.analytics/FirebaseAnalytics

FirebaseAnalytics

class FirebaseAnalytics(source)

The entry point of Firebase Analytics, mirroring com.google.firebase.analytics.FirebaseAnalytics; obtained with com.google.firebase.Firebase.analytics.

On Android this class is a header stub for the real one (its bytecode is deleted after compilation); on the other platforms it is real code over the platform SDK. On the JVM it is a no-op, as firebase-java-sdk has no analytics. Constants and enums are shared. The JS SDK has no session timeout, session ID or analytics data reset: those calls do nothing and getSessionId completes with null there.

Types

object Companion

enum ConsentStatus : Enum<FirebaseAnalytics.ConsentStatus>

enum ConsentType : Enum<FirebaseAnalytics.ConsentType>

open class Event

The recommended event names.

open class Param

The recommended parameter names.

open class UserProperty

The recommended user property names.

Properties

val FirebaseAnalytics.ios: FIRAnalytics.Companion

The Firebase iOS SDK class this wraps (its API is static).

val FirebaseAnalytics.js: FirebaseAnalytics

The Firebase JS SDK object this wraps.

val FirebaseAnalytics.js: FirebaseAnalytics

The Firebase JS SDK object this wraps.

Functions

open operator override fun equals(other: Any?): Boolean

getAppInstanceId

fun getAppInstanceId(): Task<String?>

getFirebaseInstanceId

fun ~~getFirebaseInstanceId~~(): String?

The app instance ID when it is known synchronously (Android, Apple), else null.

fun getSessionId(): Task<Long?>

open override fun hashCode(): Int

fun logEvent(name: String, params: Bundle?)

Logs name with params (see Event and Param for the recommended names).

inline fun FirebaseAnalytics.logEvent(name: String, block: ParametersBuilder.() -> Unit)

Logs name with the parameters set in block, e.g. logEvent(FirebaseAnalytics.Event.LOGIN) { param(FirebaseAnalytics.Param.METHOD, "email") }.

resetAnalyticsData

fun resetAnalyticsData()

setAnalyticsCollectionEnabled

fun setAnalyticsCollectionEnabled(enabled: Boolean)

fun setConsent(consentSettings: Map<FirebaseAnalytics.ConsentType, FirebaseAnalytics.ConsentStatus>)

inline fun FirebaseAnalytics.setConsent(block: ConsentBuilder.() -> Unit)

Sets the consent settings assigned in block, e.g. setConsent { adStorage = FirebaseAnalytics.ConsentStatus.GRANTED }.

setDefaultEventParameters

fun setDefaultEventParameters(parameters: Bundle?)

Parameters added to every event; null clears them.

setSessionTimeoutDuration

fun setSessionTimeoutDuration(milliseconds: Long)

The session timeout in milliseconds.

fun setUserId(id: String?)

setUserProperty

fun setUserProperty(name: String, value: String?)

Sets the user property name to value; null removes it.

open override fun toString(): String