SessionClient (AWS SDK for Android - Amazon Pinpoint 2.4.2 API)

java.lang.Object
- com.amazonaws.mobileconnectors.pinpoint.analytics.SessionClient

```
public class SessionClient
extends 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. For reference, please refer to MobileHub's sample class AbstractApplicationLifeCycleHelper.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class SessionClient.SessionState
Internal Representation of Application Session's state

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`SessionClient.SessionState` Internal Representation of Application Session's state

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`DEFAULT_RESTART_DELAY`
`protected static long`	`DEFAULT_RESUME_DELAY`
`protected static String`	`NO_SESSION_ID`
`protected com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext`	`pinpointContext`
`protected static String`	`RESTART_DELAY_CONFIG_KEY`
`protected static String`	`RESUME_DELAY_CONFIG_KEY`
`protected Session`	`session`
`static String`	`SESSION_PAUSE_EVENT_TYPE` The eventType recorded for session pause events
`static String`	`SESSION_RESUME_EVENT_TYPE` The eventType recorded for session resume events
`static String`	`SESSION_START_EVENT_TYPE` The eventType recorded for session start events
`static String`	`SESSION_STOP_EVENT_TYPE` The eventType recorded for session stop events
`protected static String`	`SHARED_PREFS_SESSION_KEY`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`executePause()` - Pause the current session object - Fire a Session Pause Event - Persist Session to the file system.
`protected void`	`executeResume()` - Re-Activate the session - Fire Session Resume Event
`protected void`	`executeStart()`
`protected void`	`executeStop()`
`long`	`getRestartDelay()`
`long`	`getResumeDelay()`
`protected Session`	`getSession()` Getters
`protected SessionClient.SessionState`	`getSessionState()` Returns the Application Session's state
`void`	`pauseSession()` Briefly pauses an application session.
`void`	`resumeSession()` Resumes an application session.
`void`	`startSession()` Start a session which records a _session.start 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 and flushes the events in localstorage for submission.
`String`	`toString()` Overridden toString method for testing

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SESSION_START_EVENT_TYPE
```
public static final String SESSION_START_EVENT_TYPE
```
    The eventType recorded for session start events
    
    See Also:
    
    Constant Field Values
  - SESSION_STOP_EVENT_TYPE
```
public static final String SESSION_STOP_EVENT_TYPE
```
    The eventType recorded for session stop events
    
    See Also:
    
    Constant Field Values
  - SESSION_PAUSE_EVENT_TYPE
```
public static final String SESSION_PAUSE_EVENT_TYPE
```
    The eventType recorded for session pause events
    
    See Also:
    
    Constant Field Values
  - SESSION_RESUME_EVENT_TYPE
```
public static final String SESSION_RESUME_EVENT_TYPE
```
    The eventType recorded for session resume events
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RESUME_DELAY
```
protected static final long DEFAULT_RESUME_DELAY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RESTART_DELAY
```
protected static final long DEFAULT_RESTART_DELAY
```
    See Also:
    
    Constant Field Values
  - RESUME_DELAY_CONFIG_KEY
```
protected static final String RESUME_DELAY_CONFIG_KEY
```
    See Also:
    
    Constant Field Values
  - RESTART_DELAY_CONFIG_KEY
```
protected static final String RESTART_DELAY_CONFIG_KEY
```
    See Also:
    
    Constant Field Values
  - NO_SESSION_ID
```
protected static final String NO_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - SHARED_PREFS_SESSION_KEY
```
protected static final String SHARED_PREFS_SESSION_KEY
```
    See Also:
    
    Constant Field Values
  - pinpointContext
```
protected final com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext
```
  - session
```
protected Session session
```
- 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 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. For reference, please refer to MobileHub's sample class AbstractApplicationLifeCycleHelper.
  - stopSession
```
public void stopSession()
```
    Stops a session which records a _session.stop event and flushes the events in localstorage for submission. It is recommended to stop the session when the application goes to the background. For reference, please refer to MobileHub's sample class AbstractApplicationLifeCycleHelper.
  - pauseSession
```
public void pauseSession()
```
    Briefly pauses an application session. Should be called in an activity's onPause() method. This records a _session.pause event.
  - resumeSession
```
public void resumeSession()
```
    Resumes an application session. Should be called in an activity's onResume() method. This records a _session.resume event.
  - toString
```
public String toString()
```
    Overridden toString method for testing
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    diagnostic string
  - executeStart
```
protected void executeStart()
```
  - executeStop
```
protected void executeStop()
```
  - executePause
```
protected void executePause()
```
    - Pause the current session object - Fire a Session Pause Event - Persist Session to the file system. (prepares for quiet death)
  - executeResume
```
protected void executeResume()
```
    - Re-Activate the session - Fire Session Resume Event
  - getSession
```
protected Session getSession()
```
    Getters
  - getRestartDelay
```
public long getRestartDelay()
```
  - getResumeDelay
```
public long getResumeDelay()
```
  - getSessionState
```
protected SessionClient.SessionState getSessionState()
```
    Returns the Application Session's state

Class SessionClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SESSION_START_EVENT_TYPE

SESSION_STOP_EVENT_TYPE

SESSION_PAUSE_EVENT_TYPE

SESSION_RESUME_EVENT_TYPE

DEFAULT_RESUME_DELAY

DEFAULT_RESTART_DELAY

RESUME_DELAY_CONFIG_KEY

RESTART_DELAY_CONFIG_KEY

NO_SESSION_ID

SHARED_PREFS_SESSION_KEY

pinpointContext

session

Constructor Detail

SessionClient

Method Detail

startSession

stopSession

pauseSession

resumeSession

toString

executeStart

executeStop

executePause

executeResume

getSession

getRestartDelay

getResumeDelay

getSessionState