com.snowplowanalytics.snowplow.controller

Interface SessionController

All Superinterfaces:

com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

public interface SessionController
extends com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

Method Summary

Modifier and Type	Method and Description
int	getBackgroundIndex() Count the number of background transitions in the current session.
int	getForegroundIndex() Count the number of foreground transitions in the current session.
String	getSessionId() The session identifier.
int	getSessionIndex() The session index.
String	getUserId() The session user identifier.
boolean	isInBackground() Whether the app is currently in background state or in foreground state.
void	pause() Pause the session tracking.
void	resume() Resume the session tracking.
void	startNewSession() Expire the current session also if the timeout is not triggered.

Methods inherited from interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

getBackgroundTimeout, getForegroundTimeout, getOnSessionUpdate, setBackgroundTimeout, setForegroundTimeout, setOnSessionUpdate

Method Detail

getSessionIndex

int getSessionIndex()

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

getSessionId

@NonNull
String getSessionId()

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

getUserId

@NonNull
String getUserId()

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.

isInBackground

boolean isInBackground()

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

getBackgroundIndex

int getBackgroundIndex()

Count the number of background transitions in the current session.

getForegroundIndex

int getForegroundIndex()

Count the number of foreground transitions in the current session.

pause

void pause()

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

resume

void resume()

Resume the session tracking.

startNewSession

void startNewSession()

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