com.amazonaws.mobileconnectors.pinpoint.analytics

Class SessionClient

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.SessionClient

public class SessionClient
extends java.lang.Object

Client for managing starting and stopping sessions which records session events automatically as the session is stopped or started. It is recommended to start the session when the application comes to the foreground and stop the session when it goes to the background.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SESSION_PAUSE_EVENT_TYPE The eventType recorded for session pause events
static java.lang.String	SESSION_RESUME_EVENT_TYPE The eventType recorded for session resume events
static java.lang.String	SESSION_START_EVENT_TYPE The eventType recorded for session start events
static java.lang.String	SESSION_STOP_EVENT_TYPE The eventType recorded for session stop events

Constructor Summary

Constructors

Constructor and Description
SessionClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
void	pauseSession() Briefly pauses an application session.
void	resumeSession() Resumes an application session.
void	startSession() Start a session which records a SESSION_START_EVENT_TYPE event and saves that sessionId to the AnalyticsClient to be used for recording future events.
void	stopSession() Stops a session which records a SESSION_STOP_EVENT_TYPE event and flushes the events in localstorage for submission.
java.lang.String	toString() Overridden toString method for testing

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SESSION_START_EVENT_TYPE

public static final java.lang.String SESSION_START_EVENT_TYPE

The eventType recorded for session start events

See Also:

Constant Field Values

SESSION_STOP_EVENT_TYPE

public static final java.lang.String SESSION_STOP_EVENT_TYPE

The eventType recorded for session stop events

See Also:

Constant Field Values

SESSION_PAUSE_EVENT_TYPE

public static final java.lang.String SESSION_PAUSE_EVENT_TYPE

The eventType recorded for session pause events

See Also:

Constant Field Values

SESSION_RESUME_EVENT_TYPE

public static final java.lang.String SESSION_RESUME_EVENT_TYPE

The eventType recorded for session resume events

See Also:

Constant Field Values

Constructor Detail

SessionClient

public SessionClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)

CONSTRUCTOR

Parameters:

pinpointContext - The PinpointContext

Method Detail

startSession

public void startSession()

Start a session which records a SESSION_START_EVENT_TYPE event and saves that sessionId to the AnalyticsClient to be used for recording future events. This triggers an update of the endpointProfile. It is recommended to start the session when the application comes to the foreground.

stopSession

public void stopSession()

Stops a session which records a SESSION_STOP_EVENT_TYPE event and flushes the events in localstorage for submission. It is recommended to stop the session when the application goes to the background.

pauseSession

public void pauseSession()

Briefly pauses an application session. This records a SESSION_PAUSE_EVENT_TYPE event. It is recommended to call in an activity's onPause() method.

resumeSession

public void resumeSession()

Resumes an application session. This records a SESSION_RESUME_EVENT_TYPE event. It is recommended to call in an activity's onResume() method.

toString

public java.lang.String toString()

Overridden toString method for testing

Overrides:

toString in class java.lang.Object

Returns:

diagnostic string