com.heroiclabs.nakama

Interface Session

All Known Implementing Classes:

DefaultSession

public interface Session

A session used with requests sent to Nakama server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthToken()
long	getCreateTime()
long	getExpireTime()
long	getRefreshExpireTime() The UNIX timestamp when the refresh token will expire.
java.lang.String	getRefreshToken()
java.lang.String	getUserId()
java.lang.String	getUsername()
java.util.Map<java.lang.String,java.lang.String>	getVars()
boolean	isCreated()
boolean	IsExpired()
boolean	isExpired(java.util.Date dateTime) Check if the session has expired against the input time.
boolean	isRefreshExpired() If the refresh token has expired.
boolean	isRefreshExpired(java.util.Date dateTime) If the refresh token has expired.
void	update(java.lang.String token, java.lang.String refreshToken) In-place update a session with new token/refresh-token.

Method Detail

getAuthToken

java.lang.String getAuthToken()

Returns:

The authentication token used to construct this session.

getRefreshToken

java.lang.String getRefreshToken()

Returns:

The refresh token used to construct this session.

isCreated

boolean isCreated()

Returns:

True if the user account for this session was just created.

getCreateTime

long getCreateTime()

Returns:

The timestamp in seconds when this session object was created.

getExpireTime

long getExpireTime()

Returns:

The timestamp in seconds when this session will expire.

IsExpired

boolean IsExpired()

Returns:

True if the session has expired against the current time.

isRefreshExpired

boolean isRefreshExpired()

If the refresh token has expired.

isRefreshExpired

boolean isRefreshExpired(java.util.Date dateTime)

If the refresh token has expired.

Parameters:

dateTime - The time to compare against the refresh token against.

Returns:

true if the refresh token has expired.

getRefreshExpireTime

long getRefreshExpireTime()

The UNIX timestamp when the refresh token will expire.

getUsername

java.lang.String getUsername()

Returns:

The username of the user who owns this session.

getUserId

java.lang.String getUserId()

Returns:

The ID of the user who owns this session.

isExpired

boolean isExpired(java.util.Date dateTime)

Check if the session has expired against the input time.

Parameters:

dateTime - The time to compare against the session.

Returns:

true if the session has expired.

getVars

java.util.Map<java.lang.String,java.lang.String> getVars()

Returns:

Get session vars.

update

void update(java.lang.String token,
            java.lang.String refreshToken)

In-place update a session with new token/refresh-token.

Parameters:

token - Authentication token.

refreshToken - Refresh token.