Nakama.ISession Interface Reference

A session authenticated for a user with Nakama server. More...

Inheritance diagram for Nakama.ISession:

Public Member Functions
bool	HasExpired (DateTime offset)
	Check the session has expired against the offset time.
bool	HasRefreshExpired (DateTime offset)
	Check if the refresh token has expired against the offset time.

Properties
string	AuthToken [get]
	The authorization token used to construct this session.
bool	Created [get]
	If the user account for this session was just created.
long	CreateTime [get]
	The UNIX timestamp when this session was created.
long	ExpireTime [get]
	The UNIX timestamp when this session will expire.
bool	IsExpired [get]
	If the session has expired.
bool	IsRefreshExpired [get]
	If the refresh token has expired.
long	RefreshExpireTime [get]
	The UNIX timestamp when the refresh token will expire.
string	RefreshToken [get]
	Refresh token that can be used for session token renewal.
IDictionary< string, string >	Vars [get]
	Any custom properties associated with this session.
string	Username [get]
	The username of the user who owns this session.
string	UserId [get]
	The ID of the user who owns this session.

Detailed Description

A session authenticated for a user with Nakama server.

Member Function Documentation

HasExpired()

bool Nakama.ISession.HasExpired

(

DateTime

offset

)

Check the session has expired against the offset time.

Parameters

offset

The datetime to compare against this session.

Returns

If the session has expired.

Implemented in Nakama.Session.

HasRefreshExpired()

bool Nakama.ISession.HasRefreshExpired

(

DateTime

offset

)

Check if the refresh token has expired against the offset time.

Parameters

offset

The datetime to compare against this refresh token.

Returns

If refresh token has expired.

Implemented in Nakama.Session.

Property Documentation

AuthToken

string Nakama.ISession.AuthToken

get

The authorization token used to construct this session.

Implemented in Nakama.Session.

Created

bool Nakama.ISession.Created

get

If the user account for this session was just created.

Implemented in Nakama.Session.

CreateTime

long Nakama.ISession.CreateTime

get

The UNIX timestamp when this session was created.

Implemented in Nakama.Session.

ExpireTime

long Nakama.ISession.ExpireTime

get

The UNIX timestamp when this session will expire.

Implemented in Nakama.Session.

IsExpired

bool Nakama.ISession.IsExpired

get

If the session has expired.

Implemented in Nakama.Session.

IsRefreshExpired

bool Nakama.ISession.IsRefreshExpired

get

If the refresh token has expired.

Implemented in Nakama.Session.

RefreshExpireTime

long Nakama.ISession.RefreshExpireTime

get

The UNIX timestamp when the refresh token will expire.

Implemented in Nakama.Session.

RefreshToken

string Nakama.ISession.RefreshToken

get

Refresh token that can be used for session token renewal.

Implemented in Nakama.Session.

UserId

string Nakama.ISession.UserId

get

The ID of the user who owns this session.

Implemented in Nakama.Session.

Username

string Nakama.ISession.Username

get

The username of the user who owns this session.

Implemented in Nakama.Session.

Vars

IDictionary<string, string> Nakama.ISession.Vars

get

Any custom properties associated with this session.

Implemented in Nakama.Session.

---

The documentation for this interface was generated from the following file:

• Nakama/ISession.cs