SessionApi 7.5.0 API


public interface SessionApi

The public API that is used to interact with sessions.

Method Summary

Modifier and Type	Method	Description
`abstract Boolean`	`addSessionProperty(String key, String value, Boolean permanent)`	Adds a property to the current session, overwriting any previous property set with the given key.
`abstract Boolean`	`removeSessionProperty(String key)`	Removes a property from the current session.
`abstract Unit`	`endSession()`	Ends the current session and starts a new one.
`abstract Unit`	`endSession(Boolean clearUserInfo)`	Ends the current session and starts a new one.

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

- Method Detail
  - addSessionProperty
```
 abstract Boolean addSessionProperty(String key, String value, Boolean permanent)
```
    Adds a property to the current session, overwriting any previous property set with the given key. If a permanent property already exists with the given name and a non-permanent one is to be added, the permanent one will be removed (and vice versa).
    
    Parameters:
    
    key - The case-sensitive key to be used for this property.
    
    value - The value associated with the given key.
    
    permanent - True if this property should be added to subsequent sessions going forward, persisting through app launches.
  - removeSessionProperty
```
 abstract Boolean removeSessionProperty(String key)
```
    Removes a property from the current session.
  - endSession
```
 abstract Unit endSession()
```
    Ends the current session and starts a new one.
  - endSession
```
 abstract Unit endSession(Boolean clearUserInfo)
```
    Ends the current session and starts a new one.
    
    Parameters:
    
    clearUserInfo - Pass in true to clear all user info set on this device.