Nakama .NET 3.1.1
.NET client for Nakama server written in C
Nakama.ISession Interface Reference

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

Inheritance diagram for Nakama.ISession:
Nakama.Session

Public Member Functions

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

Properties

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

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
offsetThe 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
offsetThe 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.

◆ Created

bool Nakama.ISession.Created
get

If the user account for this session was just created.

◆ CreateTime

long Nakama.ISession.CreateTime
get

The UNIX timestamp when this session was created.

◆ ExpireTime

long Nakama.ISession.ExpireTime
get

The UNIX timestamp when this session will expire.

◆ IsExpired

bool Nakama.ISession.IsExpired
get

If the session has expired.

◆ IsRefreshExpired

bool Nakama.ISession.IsRefreshExpired
get

If the refresh token has expired.

◆ RefreshExpireTime

long Nakama.ISession.RefreshExpireTime
get

The UNIX timestamp when the refresh token will expire.

◆ RefreshToken

string Nakama.ISession.RefreshToken
get

Refresh token that can be used for session token renewal.

◆ UserId

string Nakama.ISession.UserId
get

The ID of the user who owns this session.

◆ Username

string Nakama.ISession.Username
get

The username of the user who owns this session.

◆ Vars

IDictionary<string, string> Nakama.ISession.Vars
get

Any custom properties associated with this session.


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