com.snowplowanalytics.snowplow.configuration

Class SessionConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.SessionConfiguration

All Implemented Interfaces:

Configuration, com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface, Serializable

public class SessionConfiguration
extends Object
implements com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface, Configuration

This class represents the configuration of the applications session. The SessionConfiguration can be used to setup the behaviour of sessions. A session is a context which is appended to each event sent. The values it brings can change based on: - the timeout set for the inactivity of app when in foreground; - the timeout set for the inactivity of app when in background. Session data is maintained for the life of the application being installed on a device. A new session will be created if the session information is not accessed within a configurable timeout.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
TimeMeasure	backgroundTimeout The amount of time that can elapse before the session id is updated while the app is in the background.
TimeMeasure	foregroundTimeout The amount of time that can elapse before the session id is updated while the app is in the foreground.
androidx.core.util.Consumer<SessionState>	onSessionUpdate The callback called everytime the session is updated.

Constructor Summary

Constructors

Constructor and Description
SessionConfiguration(JSONObject jsonObject)
SessionConfiguration(TimeMeasure foregroundTimeout, TimeMeasure backgroundTimeout) This will setup the session behaviour of the tracker.

Method Summary

Modifier and Type	Method and Description
Configuration	copy()
TimeMeasure	getBackgroundTimeout()
TimeMeasure	getForegroundTimeout()
androidx.core.util.Consumer<SessionState>	getOnSessionUpdate()
SessionConfiguration	onSessionUpdate(androidx.core.util.Consumer<SessionState> onSessionUpdate)
void	setBackgroundTimeout(TimeMeasure backgroundTimeout)
void	setForegroundTimeout(TimeMeasure foregroundTimeout)
void	setOnSessionUpdate(androidx.core.util.Consumer<SessionState> onSessionUpdate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

foregroundTimeout

@NonNull
public TimeMeasure foregroundTimeout

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

backgroundTimeout

@NonNull
public TimeMeasure backgroundTimeout

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

onSessionUpdate

@Nullable
public androidx.core.util.Consumer<SessionState> onSessionUpdate

The callback called everytime the session is updated.

Constructor Detail

SessionConfiguration

public SessionConfiguration(@NonNull
                            TimeMeasure foregroundTimeout,
                            @NonNull
                            TimeMeasure backgroundTimeout)

This will setup the session behaviour of the tracker.

Parameters:

foregroundTimeout - The timeout set for the inactivity of app when in foreground.

backgroundTimeout - The timeout set for the inactivity of app when in background.

SessionConfiguration

public SessionConfiguration(@NonNull
                            JSONObject jsonObject)

Method Detail

getForegroundTimeout

@NonNull
public TimeMeasure getForegroundTimeout()

Specified by:

getForegroundTimeout in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

foregroundTimeout

setForegroundTimeout

public void setForegroundTimeout(@NonNull
                                 TimeMeasure foregroundTimeout)

Specified by:

setForegroundTimeout in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

foregroundTimeout

getBackgroundTimeout

@NonNull
public TimeMeasure getBackgroundTimeout()

Specified by:

getBackgroundTimeout in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

backgroundTimeout

setBackgroundTimeout

public void setBackgroundTimeout(@NonNull
                                 TimeMeasure backgroundTimeout)

Specified by:

setBackgroundTimeout in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

backgroundTimeout

getOnSessionUpdate

@Nullable
public androidx.core.util.Consumer<SessionState> getOnSessionUpdate()

Specified by:

getOnSessionUpdate in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

onSessionUpdate

setOnSessionUpdate

public void setOnSessionUpdate(@Nullable
                               androidx.core.util.Consumer<SessionState> onSessionUpdate)

Specified by:

setOnSessionUpdate in interface com.snowplowanalytics.snowplow.internal.session.SessionConfigurationInterface

See Also:

onSessionUpdate

onSessionUpdate

@NonNull
public SessionConfiguration onSessionUpdate(@Nullable
                                                     androidx.core.util.Consumer<SessionState> onSessionUpdate)

See Also:

onSessionUpdate

copy

@NonNull
public Configuration copy()

Specified by:

copy in interface Configuration