Inheritance diagram for AccelByte.Api.Session:

Public Member Functions
void	GetPartyDetails (string partyId, ResultCallback< SessionV2PartySession > callback)
	Get Party details with partyId.
void	UpdateParty (string partyId, SessionV2PartySessionUpdateRequest request, ResultCallback< SessionV2PartySession > callback)
	Update(Overwrite) all fields of a party. Note: Join type can only be updated by the party's leader.
void	PatchUpdateParty (string partyId, SessionV2PartySessionUpdateRequest request, ResultCallback< SessionV2PartySession > callback)
	Update(Partially) specified field(s) of a party. Note: Join type can only be updated by the party's leader.
void	InviteUserToParty (string partyId, string userId, ResultCallback callback)
	Invite a user to a party.
void	InviteUserToParty (string partyId, string userId, InviteUserToPartyOptionalParameters optionalParameters, ResultCallback callback)
	Invite a user to a party.
void	PromoteUserToPartyLeader (string partyId, string leaderId, ResultCallback< SessionV2PartySession > callback)
	Promotes a party member to be a party leader. Only leader can promote a new leader.
void	JoinParty (string partyId, ResultCallback< SessionV2PartySession > callback)
	Join a party.
void	LeaveParty (string partyId, ResultCallback callback)
	Leave a Party.
void	RejectPartyInvitation (string partyId, ResultCallback callback)
	Reject a party invitation.
void	KickUserFromParty (string partyId, string userId, ResultCallback< SessionV2PartySessionKickResponse > callback)
	Kick a player from a party. Requires invoker to be the party leader.
void	CreateParty (SessionV2PartySessionCreateRequest request, ResultCallback< SessionV2PartySession > callback)
	Create a Party and assign invoker as leader.
void	GetUserParties (ResultCallback< PaginatedResponse< SessionV2PartySession > > callback)
	Get all parties of a user(invoker).
void	JoinPartyByCode (string code, ResultCallback< SessionV2PartySession > callback)
	Join a party using a code.
void	GenerateNewPartyCode (string partyId, ResultCallback< SessionV2PartySession > callback)
	Generate new code for a party.
void	RevokePartyCode (string sessionId, ResultCallback callback)
	Revoke party code.
void	CancelPartyInvitation (string partyId, string userId, ResultCallback callback)
void	CreateGameSession (SessionV2GameSessionCreateRequest request, ResultCallback< SessionV2GameSession > callback)
	Create Game Session.
void	QueryGameSession (Dictionary< string, object > request, ResultCallback< PaginatedResponse< SessionV2GameSession > > callback)
	Query Game Session By default, API will return a list of available game sessions with free form input.
void	QueryGameSession (GameSessionQuery query, ResultCallback< PaginatedResponse< SessionV2GameSession > > callback)
	Query Game Session By default, API will return a list of available game sessions.
void	QueryGameSession (GameSessionQuery query, QueryGameSessionOptionalParameters optionalParameters, ResultCallback< PaginatedResponse< SessionV2GameSession > > callback)
	Query Game Session By default, API will return a list of available game sessions.
void	GetGameSessionDetailsByPodName (string podName, ResultCallback< SessionV2GameSession > callback)
	Get game session detail by podName. Session service has several DSInformation status to track DS request to DSMC.
void	GetGameSessionDetailsBySessionId (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	PatchGameSession (string sessionId, SessionV2GameSessionUpdateRequest request, ResultCallback< SessionV2GameSession > callback)
	Patch updates a game session, only specified fields from game session data.
void	InviteUserToGameSession (string sessionId, string userId, ResultCallback callback)
	Invite a user to a game session.
void	InviteUserToGameSession (string sessionId, string userId, InviteUserToGameSessionOptionalParameters optionalParameters, ResultCallback callback)
	Invite a user to a game session.
void	KickUserFromGameSession (string sessionId, string userId, ResultCallback callback)
	Kick a user from the game session. Only the leader can kick a member.
void	JoinGameSession (string sessionId, ResultCallback< SessionV2GameSession > callback)
	Join a game session.
void	LeaveGameSession (string sessionId, ResultCallback callback)
	Leave a game session.
void	RejectGameSessionInvitation (string sessionId, ResultCallback callback)
	Reject a game session invitation.
void	GetUserGameSessions (SessionV2StatusFilter? statusFilter, SessionV2AttributeOrderBy? orderBy, bool? sortDesc, ResultCallback< PaginatedResponse< SessionV2GameSession > > callback)
	Query user's game sessions. By default, API will return a list of user's active game sessions (INVITED,JOINED,CONNECTED).
void	JoinGameSessionByCode (string code, ResultCallback< SessionV2GameSession > callback)
	Join a game session using a code.
void	GenerateNewGameSessionCode (string sessionId, ResultCallback< SessionV2GameSession > callback)
	Generate new code for a game session.
void	RevokeGameSessionCode (string sessionId, ResultCallback callback)
	Revoke game session code.
void	PromoteUserToGameSessionLeader (string sessionId, string leaderId, ResultCallback< SessionV2GameSession > callback)
	Promote user to be a game session leader.
void	UpdateLeaderStorage (string sessionId, JObject data, ResultCallback< JObject > callback)
	Update leader's session storage data, can only be updated by current session leader. This will overwrite leader storage data, if updating also provide latest leader storage. To clear current leader storage data update with empty JObject.
void	UpdateMemberStorage (string sessionId, JObject data, ResultCallback< JObject > callback)
	Update current user's session member storage data. This will overwrite this user's storage data, if updating also provide latest user's storage. To clear current user's storage data update with empty jsonObject.
void	GetPlayerAttributes (ResultCallback< PlayerAttributesResponseBody > callback)
	Get player attributes.
void	StorePlayerAttributes (PlayerAttributesRequestBody requestBody, ResultCallback< PlayerAttributesResponseBody > callback)
	Set the behavior of player online session.
void	ResetPlayerAttributes (ResultCallback callback)
	Reset player attributes.
void	GetRecentPlayers (ResultCallback< SessionV2RecentPlayers > callback)
	Get recent players.
void	GetRecentPlayers (GetRecentPlayersOptionalParameters optionalParameters, ResultCallback< SessionV2RecentPlayers > callback)
	Get recent players.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator `[get]`

Member Function Documentation

◆ CreateGameSession()

void AccelByte.Api.Session.CreateGameSession	(	SessionV2GameSessionCreateRequest	request,
		ResultCallback< SessionV2GameSession >	callback )

inline

Create Game Session.

Parameters

request	Details of creating game session.
callback	Returns a Result that contain SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ CreateParty()

void AccelByte.Api.Session.CreateParty	(	SessionV2PartySessionCreateRequest	request,
		ResultCallback< SessionV2PartySession >	callback )

inline

Create a Party and assign invoker as leader.

Parameters

request	Compiled request with details of the creating party session
callback	Returns a Result that contain SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ DeleteGameSession()

void AccelByte.Api.Session.DeleteGameSession	(	string	sessionId,
		ResultCallback	callback )

inline

Delete a game session.

Parameters

sessionId	Targeted game session's sessionId
callback	Returns a result via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GenerateNewGameSessionCode()

void AccelByte.Api.Session.GenerateNewGameSessionCode	(	string	sessionId,
		ResultCallback< SessionV2GameSession >	callback )

inline

Generate new code for a game session.

Parameters

sessionId	Game session ID.
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GenerateNewPartyCode()

void AccelByte.Api.Session.GenerateNewPartyCode	(	string	partyId,
		ResultCallback< SessionV2PartySession >	callback )

inline

Generate new code for a party.

Parameters

partyId	Party ID.
callback	Returns a result of SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GetGameSessionDetailsByPodName()

void AccelByte.Api.Session.GetGameSessionDetailsByPodName	(	string	podName,
		ResultCallback< SessionV2GameSession >	callback )

inline

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

Parameters

podName	Targeted game session's podName
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GetGameSessionDetailsBySessionId()

void AccelByte.Api.Session.GetGameSessionDetailsBySessionId	(	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

sessionId	Targeted game session's sessionId
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GetPartyDetails()

void AccelByte.Api.Session.GetPartyDetails	(	string	partyId,
		ResultCallback< SessionV2PartySession >	callback )

inline

Get Party details with partyId.

Parameters

partyId	Targeted party ID.
callback	Returns a Result that contain SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GetRecentPlayers() [1/2]

void AccelByte.Api.Session.GetRecentPlayers	(	GetRecentPlayersOptionalParameters	optionalParameters,
		ResultCallback< SessionV2RecentPlayers >	callback )

inline

Get recent players.

Parameters

optionalParameters	Optional parameters including limit (default: 20, max: 200)
callback	Returns SessionV2RecentPlayers via callback when completed

◆ GetRecentPlayers() [2/2]

void AccelByte.Api.Session.GetRecentPlayers ( ResultCallback< SessionV2RecentPlayers > callback )

inline

Get recent players.

Parameters

callback Returns SessionV2RecentPlayers via callback when completed

◆ GetUserGameSessions()

void AccelByte.Api.Session.GetUserGameSessions	(	SessionV2StatusFilter?	statusFilter,
		SessionV2AttributeOrderBy?	orderBy,
		bool?	sortDesc,
		ResultCallback< PaginatedResponse< SessionV2GameSession > >	callback )

inline

Query user's game sessions. By default, API will return a list of user's active game sessions (INVITED,JOINED,CONNECTED).

Parameters

statusFilter	Game session status to filter. Supported status: INVITED, JOINED, CONNECTED
orderBy	Order result by specific attribute. Supported: createdAt (default), updatedAt
sortDesc	Is descending order of the result. Default is true. Ascending order if false.
callback	Returns a paginated result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ GetUserParties()

void AccelByte.Api.Session.GetUserParties ( ResultCallback< PaginatedResponse< SessionV2PartySession > > callback )

inline

Get all parties of a user(invoker).

Parameters

callback Returns a paginated result of SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ InviteUserToGameSession() [1/2]

void AccelByte.Api.Session.InviteUserToGameSession	(	string	sessionId,
		string	userId,
		InviteUserToGameSessionOptionalParameters	optionalParameters,
		ResultCallback	callback )

inline

Invite a user to a game session.

Parameters

sessionId	Targeted game session's sessionId
userId	Targeted user's userId
optionalParameters	Optional parameters can be used
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ InviteUserToGameSession() [2/2]

void AccelByte.Api.Session.InviteUserToGameSession	(	string	sessionId,
		string	userId,
		ResultCallback	callback )

inline

Invite a user to a game session.

Parameters

sessionId	Targeted game session's sessionId
userId	Targeted user's userId
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ InviteUserToParty() [1/2]

void AccelByte.Api.Session.InviteUserToParty	(	string	partyId,
		string	userId,
		InviteUserToPartyOptionalParameters	optionalParameters,
		ResultCallback	callback )

inline

Invite a user to a party.

Parameters

partyId	Targeted party ID
userId	Targeted user ID
optionalParameters	Optional parameters to be set
callback	Returns a Result with status code

Implements AccelByte.Api.Interface.IClientSession.

◆ InviteUserToParty() [2/2]

void AccelByte.Api.Session.InviteUserToParty	(	string	partyId,
		string	userId,
		ResultCallback	callback )

inline

Invite a user to a party.

Parameters

partyId	Targeted party ID
userId	Targeted user ID
callback	Returns a Result with status code

Implements AccelByte.Api.Interface.IClientSession.

◆ JoinGameSession()

void AccelByte.Api.Session.JoinGameSession	(	string	sessionId,
		ResultCallback< SessionV2GameSession >	callback )

inline

Join a game session.

Parameters

sessionId	Targeted game session's sessionId
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ JoinGameSessionByCode()

void AccelByte.Api.Session.JoinGameSessionByCode	(	string	code,
		ResultCallback< SessionV2GameSession >	callback )

inline

Join a game session using a code.

Parameters

code	Game session code.
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ JoinParty()

void AccelByte.Api.Session.JoinParty	(	string	partyId,
		ResultCallback< SessionV2PartySession >	callback )

inline

Join a party.

Parameters

partyId	Targeted party ID.
callback	Returns a Result that contain SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ JoinPartyByCode()

void AccelByte.Api.Session.JoinPartyByCode	(	string	code,
		ResultCallback< SessionV2PartySession >	callback )

inline

Join a party using a code.

Parameters

code	Party code.
callback	Returns a result of SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ KickUserFromGameSession()

void AccelByte.Api.Session.KickUserFromGameSession	(	string	sessionId,
		string	userId,
		ResultCallback	callback )

inline

Kick a user from the game session. Only the leader can kick a member.

Parameters

sessionId	Targeted game session's sessionId
userId	Targeted user's userId
callback	Returns a result via callback when completed

Implements AccelByte.Api.Interface.IClientSession.

◆ KickUserFromParty()

void AccelByte.Api.Session.KickUserFromParty	(	string	partyId,
		string	userId,
		ResultCallback< SessionV2PartySessionKickResponse >	callback )

inline

Kick a player from a party. Requires invoker to be the party leader.

Parameters

partyId	Targeted party ID.
userId	Targeted user's ID.
callback	Returns a Result that contain SessionV2PartySessionKickResponse via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ LeaveGameSession()

void AccelByte.Api.Session.LeaveGameSession	(	string	sessionId,
		ResultCallback	callback )

inline

Leave a game session.

Parameters

sessionId	Targeted game session's sessionId
callback	Returns a result via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ LeaveParty()

void AccelByte.Api.Session.LeaveParty	(	string	partyId,
		ResultCallback	callback )

inline

Leave a Party.

Parameters

partyId	Targeted party ID.
callback	Returns a Result with status code

Implements AccelByte.Api.Interface.IClientSession.

◆ PatchGameSession()

void AccelByte.Api.Session.PatchGameSession	(	string	sessionId,
		SessionV2GameSessionUpdateRequest	request,
		ResultCallback< SessionV2GameSession >	callback )

inline

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

Parameters

sessionId	Targeted game session's sessionId
request	Compiled request of updating game session details
callback	Returns a result of updated SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ PatchUpdateParty()

void AccelByte.Api.Session.PatchUpdateParty	(	string	partyId,
		SessionV2PartySessionUpdateRequest	request,
		ResultCallback< SessionV2PartySession >	callback )

inline

Update(Partially) specified field(s) of a party. Note: Join type can only be updated by the party's leader.

Parameters

partyId	Targeted party ID.
request	Compiled request with the updating details of the party session
callback	Returns a Result that contain SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ PromoteUserToGameSessionLeader()

void AccelByte.Api.Session.PromoteUserToGameSessionLeader	(	string	sessionId,
		string	leaderId,
		ResultCallback< SessionV2GameSession >	callback )

inline

Promote user to be a game session leader.

Parameters

sessionId	Game session ID.
leaderId	Targeted user ID of new leader
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ PromoteUserToPartyLeader()

void AccelByte.Api.Session.PromoteUserToPartyLeader	(	string	partyId,
		string	leaderId,
		ResultCallback< SessionV2PartySession >	callback )

inline

Promotes a party member to be a party leader. Only leader can promote a new leader.

Parameters

partyId	Targeted party ID
leaderId	Targeted user ID of new leader
callback	Returns a Result that contain SessionV2PartySession via callback when completed

Implements AccelByte.Api.Interface.IClientSession.

◆ QueryGameSession() [1/3]

void AccelByte.Api.Session.QueryGameSession	(	Dictionary< string, object >	request,
		ResultCallback< PaginatedResponse< SessionV2GameSession > >	callback )

inline

Query Game Session By default, API will return a list of available game sessions with free form input.

Parameters

request	List of attributes to filter from available sessions
callback	Returns a paginated result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ QueryGameSession() [2/3]

void AccelByte.Api.Session.QueryGameSession	(	GameSessionQuery	query,
		QueryGameSessionOptionalParameters	optionalParameters,
		ResultCallback< PaginatedResponse< SessionV2GameSession > >	callback )

inline

Query Game Session By default, API will return a list of available game sessions.

Parameters

query	Query Object
optionalParameters	Contains query optional parameter
callback	Returns a paginated result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ QueryGameSession() [3/3]

void AccelByte.Api.Session.QueryGameSession	(	GameSessionQuery	query,
		ResultCallback< PaginatedResponse< SessionV2GameSession > >	callback )

inline

Query Game Session By default, API will return a list of available game sessions.

Parameters

query	Query Object
callback	Returns a paginated result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ RejectGameSessionInvitation()

void AccelByte.Api.Session.RejectGameSessionInvitation	(	string	sessionId,
		ResultCallback	callback )

inline

Reject a game session invitation.

Parameters

sessionId	Targeted game session's sessionId
callback	Returns a result via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ RejectPartyInvitation()

void AccelByte.Api.Session.RejectPartyInvitation	(	string	partyId,
		ResultCallback	callback )

inline

Reject a party invitation.

Parameters

partyId	Targeted party ID.
callback	Returns a Result with status code

Implements AccelByte.Api.Interface.IClientSession.

◆ RevokeGameSessionCode()

void AccelByte.Api.Session.RevokeGameSessionCode	(	string	sessionId,
		ResultCallback	callback )

inline

Revoke game session code.

Parameters

sessionId	Game session ID.
callback	Returns a result of SessionV2GameSession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ RevokePartyCode()

void AccelByte.Api.Session.RevokePartyCode	(	string	sessionId,
		ResultCallback	callback )

inline

Revoke party code.

Parameters

sessionId	Party ID.
callback	Returns a result of SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ UpdateLeaderStorage()

void AccelByte.Api.Session.UpdateLeaderStorage	(	string	sessionId,
		JObject	data,
		ResultCallback< JObject >	callback )

inline

Update leader's session storage data, can only be updated by current session leader. This will overwrite leader storage data, if updating also provide latest leader storage. To clear current leader storage data update with empty JObject.

Parameters

sessionId	The game or party session id.
data	Data to update leader storage.
callback	Callback will be called when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ UpdateMemberStorage()

void AccelByte.Api.Session.UpdateMemberStorage	(	string	sessionId,
		JObject	data,
		ResultCallback< JObject >	callback )

inline

Update current user's session member storage data. This will overwrite this user's storage data, if updating also provide latest user's storage. To clear current user's storage data update with empty jsonObject.

Parameters

sessionId	The game or party session id.
data	Data to update leader storage.
callback	Callback will be called when completed.

Implements AccelByte.Api.Interface.IClientSession.

◆ UpdateParty()

void AccelByte.Api.Session.UpdateParty	(	string	partyId,
		SessionV2PartySessionUpdateRequest	request,
		ResultCallback< SessionV2PartySession >	callback )

inline

Update(Overwrite) all fields of a party. Note: Join type can only be updated by the party's leader.

Parameters

partyId	Targeted party ID.
request	Compiled request with the updating details of the party session
callback	Returns a Result that contain SessionV2PartySession via callback when completed.

Implements AccelByte.Api.Interface.IClientSession.

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ CreateGameSession()

◆ CreateParty()

◆ DeleteGameSession()

◆ GenerateNewGameSessionCode()

◆ GenerateNewPartyCode()

◆ GetGameSessionDetailsByPodName()

◆ GetGameSessionDetailsBySessionId()

◆ GetPartyDetails()

◆ GetRecentPlayers() [1/2]

◆ GetRecentPlayers() [2/2]

◆ GetUserGameSessions()

◆ GetUserParties()

◆ InviteUserToGameSession() [1/2]

◆ InviteUserToGameSession() [2/2]

◆ InviteUserToParty() [1/2]

◆ InviteUserToParty() [2/2]

◆ JoinGameSession()

◆ JoinGameSessionByCode()

◆ JoinParty()

◆ JoinPartyByCode()

◆ KickUserFromGameSession()

◆ KickUserFromParty()

◆ LeaveGameSession()

◆ LeaveParty()

◆ PatchGameSession()

◆ PatchUpdateParty()

◆ PromoteUserToGameSessionLeader()

◆ PromoteUserToPartyLeader()

◆ QueryGameSession() [1/3]

◆ QueryGameSession() [2/3]

◆ QueryGameSession() [3/3]

◆ RejectGameSessionInvitation()

◆ RejectPartyInvitation()

◆ RevokeGameSessionCode()

◆ RevokePartyCode()

◆ UpdateLeaderStorage()

◆ UpdateMemberStorage()

◆ UpdateParty()