snowplow-android-tracker/com.snowplowanalytics.snowplow.controller/SessionController

SessionController

interface SessionController : SessionConfigurationInterface

Controller for managing Sessions.

Functions

abstract fun pause()

Pause the session tracking. While the session is paused it can't expire or be updated.

abstract fun resume()

Resume the session tracking.

startNewSession

abstract fun startNewSession()

Expire the current session even if the timeout is not triggered.

Properties

backgroundIndex

abstract val backgroundIndex: Int

Count the number of background transitions in the current session.

backgroundTimeout

abstract var backgroundTimeout: TimeMeasure

The amount of time that can elapse before the session id is updated while the app is in the background.

foregroundIndex

abstract val foregroundIndex: Int

Count the number of foreground transitions in the current session.

foregroundTimeout

abstract var foregroundTimeout: TimeMeasure

The amount of time that can elapse before the session id is updated while the app is in the foreground.

abstract val isInBackground: Boolean

Whether the app is currently in background state or in foreground state.

onSessionUpdate

abstract var onSessionUpdate: Consumer<SessionState>?

The callback called every time the session is updated.

abstract val sessionId: String?

The session identifier. A unique identifier which is used to identify the session.

abstract val sessionIndex: Int?

The session index. A increasing number which helps to order the sequence of sessions.

abstract val userId: String

The session user identifier. It identifies this app installation and doesn't change for the life of the app. It will change only when the app is uninstalled and installed again. An app update doesn't change the value.