Loading...
Searching...
No Matches
AccelByte.Server.ServerSession Class Reference
Inheritance diagram for AccelByte.Server.ServerSession:

Public Member Functions

void GetAllGameSessions (ResultCallback< SessionV2GameSessionPagingResponse > callback, SessionV2DsStatus statusV2=SessionV2DsStatus.None, string sessionId="", string matchPool="", string gameMode="", SessionV2Joinability joinability=SessionV2Joinability.None, string memberId="", string configurationName="", DateTime fromTime=default, DateTime toTime=default, string dsPodName="", bool isSoftDeleted=false, bool isPersistent=false, SessionV2AttributeOrderBy orderBy=SessionV2AttributeOrderBy.createdAt, SessionV2AttributeOrder order=SessionV2AttributeOrder.Desc, int offset=0, int limit=20)
 Get all game session details. Session service has several DSInformation status to track DS request to DSMC.
void GetGameSessionDetails (string sessionId, ResultCallback< SessionV2GameSession > callback)
 Get game session detail by sessionId. Session service has several DSInformation status to track DS request to DSMC.
void DeleteGameSession (string sessionId, ResultCallback callback)
 Delete a game session.
void UpdateGameSession (string sessionId, SessionV2GameSessionUpdateRequest request, ResultCallback< SessionV2GameSession > callback)
 Patch updates a game session, only specified fields from game session data.
void KickUserFromGameSession (string sessionId, string userId, ResultCallback callback)
 Kick a user from the game session.
void SendDSSessionReady (string sessionId, bool isDsSessionReady, ResultCallback callback)
 Inform session service that current DS session is ready to receive client travel. This is needed if the session template used for this game session enabled the dsManualSetReady flag.
void GetMemberActiveSession (string userId, string configurationName, ResultCallback< SessionV2MemberActiveSession > callback)
 Get Member Active Session.
void ReconcileMaxActiveSession (string userId, string configurationName, ResultCallback callback)
 Reconcile Max Active Session.
void GetRecentPlayers (string userId, ResultCallback< SessionV2RecentPlayers > callback)
 Get recent players for a specific user.
void GetRecentPlayers (string userId, GetRecentPlayersOptionalParameters optionalParameters, ResultCallback< SessionV2RecentPlayers > callback)
 Get recent players for a specific user.

Additional Inherited Members

Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator IdValidator [get]

Member Function Documentation

◆ DeleteGameSession()

void AccelByte.Server.ServerSession.DeleteGameSession ( string sessionId,
ResultCallback callback )
inline

Delete a game session.

Parameters
sessionIdTargeted game session's sessionId
callbackReturns a result via callback when completed.

◆ GetAllGameSessions()

void AccelByte.Server.ServerSession.GetAllGameSessions ( ResultCallback< SessionV2GameSessionPagingResponse > callback,
SessionV2DsStatus statusV2 = SessionV2DsStatus::None,
string sessionId = "",
string matchPool = "",
string gameMode = "",
SessionV2Joinability joinability = SessionV2Joinability::None,
string memberId = "",
string configurationName = "",
DateTime fromTime = default,
DateTime toTime = default,
string dsPodName = "",
bool isSoftDeleted = false,
bool isPersistent = false,
SessionV2AttributeOrderBy orderBy = SessionV2AttributeOrderBy::createdAt,
SessionV2AttributeOrder order = SessionV2AttributeOrder::Desc,
int offset = 0,
int limit = 20 )
inline

Get all game session details. Session service has several DSInformation status to track DS request to DSMC.

Parameters
callbackReturns a paging result of SessionV2GameSession via callback when completed.
configurationName(Optional)Filter result by configuration name
dsPodName(Optional) Filter result by DS pod name
fromTime(Optional) Filter result by time when session is created
gameMode(Optional) Filter result by game mode
isPersistent(Optional) Filter result by is persistent flag
isSoftDeleted(Optional) Filter result by is soft deleted flag
joinability(Optional) Filter result by joinability
limit(Optional) Number of results to be returned per page
matchPool(Optional) Filter result by match pool name
memberId(Optional) Filter result by member id
offset(Optional) Number of results to offset from
order(Optional) Order of results by asc or desc
orderBy(Optional) Results ordered by

\

Parameters
sessionId(Optional) Filter result by session id
statusV2(Optional) Filter result by ds status
toTime(Optional) Filter result by time when session is created

◆ GetGameSessionDetails()

void AccelByte.Server.ServerSession.GetGameSessionDetails ( string sessionId,
ResultCallback< SessionV2GameSession > callback )
inline

Get game session detail by sessionId. Session service has several DSInformation status to track DS request to DSMC.

Parameters
sessionIdTargeted game session's sessionId
callbackReturns a result of SessionV2GameSession via callback when completed.

◆ GetMemberActiveSession()

void AccelByte.Server.ServerSession.GetMemberActiveSession ( string userId,
string configurationName,
ResultCallback< SessionV2MemberActiveSession > callback )
inline

Get Member Active Session.

Parameters
userIdTargeted User ID
configurationNameSession configuration name
callbackReturns a result via callback when completed.

◆ GetRecentPlayers() [1/2]

void AccelByte.Server.ServerSession.GetRecentPlayers ( string userId,
GetRecentPlayersOptionalParameters optionalParameters,
ResultCallback< SessionV2RecentPlayers > callback )
inline

Get recent players for a specific user.

Parameters
userIdThe user ID to query recent players for
optionalParametersOptional parameters including limit (default: 20, max: 200)
callbackReturns SessionV2RecentPlayers via callback when completed

◆ GetRecentPlayers() [2/2]

void AccelByte.Server.ServerSession.GetRecentPlayers ( string userId,
ResultCallback< SessionV2RecentPlayers > callback )
inline

Get recent players for a specific user.

Parameters
userIdThe user ID to query recent players for
callbackReturns SessionV2RecentPlayers via callback when completed

◆ KickUserFromGameSession()

void AccelByte.Server.ServerSession.KickUserFromGameSession ( string sessionId,
string userId,
ResultCallback callback )
inline

Kick a user from the game session.

Parameters
sessionIdTargeted game session's sessionId
userIdTargeted user's userId
callbackReturns a result via callback when completed

◆ ReconcileMaxActiveSession()

void AccelByte.Server.ServerSession.ReconcileMaxActiveSession ( string userId,
string configurationName,
ResultCallback callback )
inline

Reconcile Max Active Session.

Parameters
userIdTargeted User ID
configurationNameSession configuration name
callbackReturns a result via callback when completed.

◆ SendDSSessionReady()

void AccelByte.Server.ServerSession.SendDSSessionReady ( string sessionId,
bool isDsSessionReady,
ResultCallback callback )
inline

Inform session service that current DS session is ready to receive client travel. This is needed if the session template used for this game session enabled the dsManualSetReady flag.

Parameters
sessionIdID of the game session that claimed the DS.
isDsSessionReadyBool value indicating if the DS session is ready or not.
callbackReturns a result via callback when completed.

◆ UpdateGameSession()

void AccelByte.Server.ServerSession.UpdateGameSession ( string sessionId,
SessionV2GameSessionUpdateRequest request,
ResultCallback< SessionV2GameSession > callback )
inline

Patch updates a game session, only specified fields from game session data.

Parameters
sessionIdTargeted game session's sessionId
requestCompiled request of updating game session details
callbackReturns a result of updated SessionV2GameSession via callback when completed.