snowplow-android-tracker/com.snowplowanalytics.core.session/SessionControllerImpl

SessionControllerImpl

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

class SessionControllerImpl(val serviceProvider: ServiceProviderInterface) : Controller, SessionController

Constructors

SessionControllerImpl

fun SessionControllerImpl(serviceProvider: ServiceProviderInterface)

Functions

open override fun pause()

Pause the session tracking. Meanwhile the session is paused it can't expire and can't be updated.

open override fun resume()

Resume the session tracking.

startNewSession

open override fun startNewSession()

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

Properties

backgroundIndex

open override val backgroundIndex: Int

Count the number of background transitions in the current session.

backgroundTimeout

open override var backgroundTimeout: TimeMeasure

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

foregroundIndex

open override val foregroundIndex: Int

Count the number of foreground transitions in the current session.

foregroundTimeout

open override var foregroundTimeout: TimeMeasure

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

val isEnabled: Boolean

open override val isInBackground: Boolean

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

onSessionUpdate

open override var onSessionUpdate: Consumer<SessionState>?

The callback called every time the session is updated.

serviceProvider

val serviceProvider: ServiceProviderInterface

open override val sessionId: String?

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

open override val sessionIndex: Int?

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

open override val userId: String

The session user identifier. It identifies this app installation and it 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.