AccelByte::Api::Session Class Reference

Inheritance diagram for AccelByte::Api::Session:

Public Member Functions
	Session (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Session (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	CreateGameSession (FAccelByteModelsV2GameSessionCreateRequest const &CreateRequest, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Create a new game session.
FAccelByteTaskWPtr	GetGameSessionDetails (FString const &GameSessionID, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Get details for a game session by ID.
FAccelByteTaskWPtr	QueryGameSessions (FAccelByteModelsV2GameSessionQuery const &QueryObject, THandler< FAccelByteModelsV2PaginatedGameSessionQueryResult > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=20)
	Query game sessions.
FAccelByteTaskWPtr	UpdateGameSession (FString const &GameSessionID, FAccelByteModelsV2GameSessionUpdateRequest const &UpdateRequest, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Update a game session by ID.
FAccelByteTaskWPtr	DeleteGameSession (FString const &GameSessionID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a game session by ID.
FAccelByteTaskWPtr	SendGameSessionInvite (FString const &GameSessionID, FString const &UserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Send an invite to a game session by ID.
FAccelByteTaskWPtr	SendGameSessionInvitePlatform (FString const &GameSessionID, FString const &UserID, EAccelByteV2SessionPlatform const &Platform, THandler< FAccelByteModelsV2SessionInvitePlatformResponse > const &OnSuccess, FErrorHandler const &OnError)
	Send an invite to a game session by ID.
FAccelByteTaskWPtr	RejectGameSessionInvite (FString const &GameSessionID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Reject an invite to a game session by game session ID.
FAccelByteTaskWPtr	JoinGameSession (FString const &GameSessionID, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Join a game session by ID.
FAccelByteTaskWPtr	JoinGameSessionByCode (FString const &Code, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Join a game session by Code.
FAccelByteTaskWPtr	GenerateNewGameSessionCode (FString const &GameSessionID, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Generate a new game session code.
FAccelByteTaskWPtr	RevokeGameSessionCode (FString const &GameSessionID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Revoke a game session code.
FAccelByteTaskWPtr	LeaveGameSession (FString const &GameSessionID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Leave a game session by ID.
FAccelByteTaskWPtr	GetMyGameSessions (THandler< FAccelByteModelsV2PaginatedGameSessionQueryResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteV2SessionMemberStatus Status=EAccelByteV2SessionMemberStatus::EMPTY)
	Get a list of the logged in user's game sessions.
FAccelByteTaskWPtr	PromoteGameSessionLeader (FString const &GameSessionID, FString const &NewLeaderID, THandler< FAccelByteModelsV2GameSession > const &OnSuccess, FErrorHandler const &OnError)
	Promote a new game session leader by user ID (only applicable for current game session leader).
FAccelByteTaskWPtr	CancelGameSessionInvitation (FString const &GameSessionID, FString const &UserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Cancel outgoing game session invitation.
FAccelByteTaskWPtr	KickUserFromGameSession (FString const &GameSessionID, FString const &UserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Kick user from a game session.
FAccelByteTaskWPtr	CreateParty (FAccelByteModelsV2PartyCreateRequest const &CreateRequest, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Create a new party with the calling user as the sole member.
FAccelByteTaskWPtr	GetPartyDetails (FString const &PartyID, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Retrieve party details for the given party ID.
FAccelByteTaskWPtr	UpdateParty (FString const &PartyID, FAccelByteModelsV2PartyUpdateRequest const &UpdateRequest, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Update a party.
FAccelByteTaskWPtr	PromotePartyLeader (FString const &PartyID, FString const &NewLeaderID, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Promote a new party leader by user ID.
FAccelByteTaskWPtr	CancelPartyInvitation (FString const &PartyID, FString const &UserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Cancel outgoing party invitation.
FAccelByteTaskWPtr	SendPartyInvite (FString const &PartyID, FString const &UserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Send a party invite to the given user.
FAccelByteTaskWPtr	SendPartyInvitePlatform (FString const &PartyID, FString const &UserID, EAccelByteV2SessionPlatform const &Platform, THandler< FAccelByteModelsV2SessionInvitePlatformResponse > const &OnSuccess, FErrorHandler const &OnError)
	Send a party invite to the given user on native platform.
FAccelByteTaskWPtr	RejectPartyInvite (FString const &PartyID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Reject an invite to a party.
FAccelByteTaskWPtr	JoinParty (FString const &PartyID, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Join a party on behalf of the user.
FAccelByteTaskWPtr	LeaveParty (FString const &PartyID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Leave a party on behalf of the user.
FAccelByteTaskWPtr	JoinPartyByCode (FString const &PartyCode, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Join a party using a party code.
FAccelByteTaskWPtr	GenerateNewPartyCode (FString const &PartyID, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Generate a new party code for the party.
FAccelByteTaskWPtr	RevokePartyCode (FString const &PartyID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Revoke a party code associated with a party.
FAccelByteTaskWPtr	KickUserFromParty (FString const &PartyID, FString const &UserID, THandler< FAccelByteModelsV2PartySession > const &OnSuccess, FErrorHandler const &OnError)
	Kick another user from a party.
FAccelByteTaskWPtr	GetMyParties (THandler< FAccelByteModelsV2PaginatedPartyQueryResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteV2SessionMemberStatus Status=EAccelByteV2SessionMemberStatus::EMPTY)
	Get a list of parties matching the given query.
FAccelByteTaskWPtr	GetPlayerAttributes (THandler< FAccelByteModelsV2PlayerAttributes > const &OnSuccess, FErrorHandler const &OnError)
	Get stored attributes for the current player.
FAccelByteTaskWPtr	GetPartySessionStorage (FString const &PartySessionID, THandler< FAccelByteModelsV2PartySessionStorage > const &OnSuccess, FErrorHandler const &OnError)
	Get current user's party session storage.
FAccelByteTaskWPtr	StorePlayerAttributes (FAccelByteModelsV2StorePlayerAttributesRequest const &AttributesRequest, THandler< FAccelByteModelsV2PlayerAttributes > const &OnSuccess, FErrorHandler const &OnError)
	Update stored attributes for the current player.
FAccelByteTaskWPtr	StorePersonalDataToReservedPartySessionStorage (FString const &PartySessionID, FAccelByteModelsV2PartySessionStorageReservedData const &Data, THandler< FAccelByteModelsV2PartySessionStorageReservedData > const &OnSuccess, FErrorHandler const &OnError)
	Store a data by current player to its party reserved personal storage. WARNING: Overwrite operation! This function will be used by AccelByte OSS internally and won't be exposed as a function.
FAccelByteTaskWPtr	DeletePlayerAttributes (FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete stored attributes for the current player.
FAccelByteTaskWPtr	UpdateLeaderStorage (FString const &SessionID, FJsonObjectWrapper const &Data, THandler< FJsonObjectWrapper > const &OnSuccess, FErrorHandler const &OnError)
	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 jsonObject.
FAccelByteTaskWPtr	UpdateMemberStorage (FString const &SessionID, FJsonObjectWrapper const &Data, THandler< FJsonObjectWrapper > const &OnSuccess, FErrorHandler const &OnError)
	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.
FAccelByteTaskWPtr	UpdatePartyStorage (FString const &PartyID, FJsonObjectWrapper const &Data, THandler< FJsonObjectWrapper > const &OnSuccess, FErrorHandler const &OnError)
	Update current user's party session member storage data. This allows users to update or insert their own party storage (non-immutable). This will overwrite this user's party storage data. Can store generic JSON.
FAccelByteTaskWPtr	GetRecentPlayers (THandler< FAccelByteModelsV2SessionRecentPlayers > const &OnSuccess, FErrorHandler const &OnError, const int32 Limit=20)
	Query recently met users in a game session.
FAccelByteTaskWPtr	GetRecentTeamPlayers (THandler< FAccelByteModelsV2SessionRecentPlayers > const &OnSuccess, FErrorHandler const &OnError, const int32 Limit=20)
	Query user's recent player who were on the same team.
FAccelByteTaskWPtr	GetSessionSecret (FString const &SessionID, THandler< FAccelByteModelsV2SessionJoinedSecret > const &OnSuccess, FErrorHandler const &OnError)
	Used by game client to get a session secret that is saved in session service. The secret will only return the secret value when the Enable Secret Validation option is set true (in the Admin Portal).
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Friends
class	GameServerApi::ServerSession

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Member Function Documentation

CancelGameSessionInvitation()

FAccelByteTaskWPtr AccelByte::Api::Session::CancelGameSessionInvitation	(	FString const &	GameSessionID,
		FString const &	UserID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Cancel outgoing game session invitation.

Parameters

GameSessionID	The ID of the game session.
UserID	The user ID of invitee.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CancelPartyInvitation()

FAccelByteTaskWPtr AccelByte::Api::Session::CancelPartyInvitation	(	FString const &	PartyID,
		FString const &	UserID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Cancel outgoing party invitation.

Parameters

PartyID	The ID of the party.
UserID	The user ID of invitee.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::CreateGameSession	(	FAccelByteModelsV2GameSessionCreateRequest const &	CreateRequest,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a new game session.

Parameters

CreateRequest	The game session creation request body.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateParty()

FAccelByteTaskWPtr AccelByte::Api::Session::CreateParty	(	FAccelByteModelsV2PartyCreateRequest const &	CreateRequest,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a new party with the calling user as the sole member.

Parameters

CreateRequest	The party creation request with attributes, join type, and members.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

DeleteGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::DeleteGameSession	(	FString const &	GameSessionID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a game session by ID.

Parameters

GameSessionID	The ID of the session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

DeletePlayerAttributes()

FAccelByteTaskWPtr AccelByte::Api::Session::DeletePlayerAttributes	(	FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete stored attributes for the current player.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateNewGameSessionCode()

FAccelByteTaskWPtr AccelByte::Api::Session::GenerateNewGameSessionCode	(	FString const &	GameSessionID,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Generate a new game session code.

Parameters

GameSessionID	ID of the game session that a new code should be generated for.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateNewPartyCode()

FAccelByteTaskWPtr AccelByte::Api::Session::GenerateNewPartyCode	(	FString const &	PartyID,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Generate a new party code for the party.

Parameters

PartyID	ID of the party that a new code should be generated for.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetGameSessionDetails()

FAccelByteTaskWPtr AccelByte::Api::Session::GetGameSessionDetails	(	FString const &	GameSessionID,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get details for a game session by ID.

Parameters

GameSessionID	The ID of the session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetMyGameSessions()

FAccelByteTaskWPtr AccelByte::Api::Session::GetMyGameSessions	(	THandler< FAccelByteModelsV2PaginatedGameSessionQueryResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteV2SessionMemberStatus	Status = EAccelByteV2SessionMemberStatus::EMPTY )

Get a list of the logged in user's game sessions.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Status	Optional membership status to query for - either active or invited.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetMyParties()

FAccelByteTaskWPtr AccelByte::Api::Session::GetMyParties	(	THandler< FAccelByteModelsV2PaginatedPartyQueryResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteV2SessionMemberStatus	Status = EAccelByteV2SessionMemberStatus::EMPTY )

Get a list of parties matching the given query.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Status	Optional membership status to query for - either active or invited.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetPartyDetails()

FAccelByteTaskWPtr AccelByte::Api::Session::GetPartyDetails	(	FString const &	PartyID,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Retrieve party details for the given party ID.

Parameters

PartyID	The ID of the party session to retrieve.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetPartySessionStorage()

FAccelByteTaskWPtr AccelByte::Api::Session::GetPartySessionStorage	(	FString const &	PartySessionID,
		THandler< FAccelByteModelsV2PartySessionStorage > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get current user's party session storage.

Parameters

PartySessionID	Current player's party ID.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetPlayerAttributes()

FAccelByteTaskWPtr AccelByte::Api::Session::GetPlayerAttributes	(	THandler< FAccelByteModelsV2PlayerAttributes > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get stored attributes for the current player.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetRecentPlayers()

FAccelByteTaskWPtr AccelByte::Api::Session::GetRecentPlayers	(	THandler< FAccelByteModelsV2SessionRecentPlayers > const &	OnSuccess,
		FErrorHandler const &	OnError,
		const int32	Limit = 20 )

Query recently met users in a game session.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Limit	Number of recent players to request, maximum value is 200.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetRecentTeamPlayers()

FAccelByteTaskWPtr AccelByte::Api::Session::GetRecentTeamPlayers	(	THandler< FAccelByteModelsV2SessionRecentPlayers > const &	OnSuccess,
		FErrorHandler const &	OnError,
		const int32	Limit = 20 )

Query user's recent player who were on the same team.

Parameters

OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Limit	Number of recent players to request, maximum value is 200.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetSessionSecret()

FAccelByteTaskWPtr AccelByte::Api::Session::GetSessionSecret	(	FString const &	SessionID,
		THandler< FAccelByteModelsV2SessionJoinedSecret > const &	OnSuccess,
		FErrorHandler const &	OnError )

Used by game client to get a session secret that is saved in session service. The secret will only return the secret value when the Enable Secret Validation option is set true (in the Admin Portal).

Parameters

SessionID	The ID of the game session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

JoinGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::JoinGameSession	(	FString const &	GameSessionID,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join a game session by ID.

Parameters

GameSessionID	The ID of the session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

JoinGameSessionByCode()

FAccelByteTaskWPtr AccelByte::Api::Session::JoinGameSessionByCode	(	FString const &	Code,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join a game session by Code.

Parameters

Code	The session's code.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

JoinParty()

FAccelByteTaskWPtr AccelByte::Api::Session::JoinParty	(	FString const &	PartyID,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join a party on behalf of the user.

Parameters

PartyID	The ID of the party session which will be joined.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

JoinPartyByCode()

FAccelByteTaskWPtr AccelByte::Api::Session::JoinPartyByCode	(	FString const &	PartyCode,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join a party using a party code.

Parameters

PartyCode	Code used to try and join a party.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

KickUserFromGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::KickUserFromGameSession	(	FString const &	GameSessionID,
		FString const &	UserID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Kick user from a game session.

Parameters

GameSessionID	The ID of the game session which the user will be kicked from.
UserID	The ID of the user to kick
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

KickUserFromParty()

FAccelByteTaskWPtr AccelByte::Api::Session::KickUserFromParty	(	FString const &	PartyID,
		FString const &	UserID,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Kick another user from a party.

Parameters

PartyID	The ID of the party session which the user will be kicked from.
UserID	The ID of the user to kick
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

LeaveGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::LeaveGameSession	(	FString const &	GameSessionID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Leave a game session by ID.

Parameters

GameSessionID	The ID of the session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

LeaveParty()

FAccelByteTaskWPtr AccelByte::Api::Session::LeaveParty	(	FString const &	PartyID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Leave a party on behalf of the user.

Parameters

PartyID	The ID of the party session which will be joined.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

PromoteGameSessionLeader()

FAccelByteTaskWPtr AccelByte::Api::Session::PromoteGameSessionLeader	(	FString const &	GameSessionID,
		FString const &	NewLeaderID,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Promote a new game session leader by user ID (only applicable for current game session leader).

Parameters

GameSessionID	The ID of the game session to update.
NewLeaderID	The user ID of the new leader to promote.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

PromotePartyLeader()

FAccelByteTaskWPtr AccelByte::Api::Session::PromotePartyLeader	(	FString const &	PartyID,
		FString const &	NewLeaderID,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Promote a new party leader by user ID.

Parameters

PartyID	The ID of the party session to update.
NewLeaderID	The user ID of the new leader to promote.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

QueryGameSessions()

FAccelByteTaskWPtr AccelByte::Api::Session::QueryGameSessions	(	FAccelByteModelsV2GameSessionQuery const &	QueryObject,
		THandler< FAccelByteModelsV2PaginatedGameSessionQueryResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Offset = 0,
		int32	Limit = 20 )

Query game sessions.

Parameters

QueryObject	Query object containing the parameters to query on.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Offset	Pagination offset.
Limit	Pagination limit.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RejectGameSessionInvite()

FAccelByteTaskWPtr AccelByte::Api::Session::RejectGameSessionInvite	(	FString const &	GameSessionID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Reject an invite to a game session by game session ID.

Parameters

GameSessionID	The ID of the session.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RejectPartyInvite()

FAccelByteTaskWPtr AccelByte::Api::Session::RejectPartyInvite	(	FString const &	PartyID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Reject an invite to a party.

Parameters

PartyID	The ID of the party session containing the invite to reject.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RevokeGameSessionCode()

FAccelByteTaskWPtr AccelByte::Api::Session::RevokeGameSessionCode	(	FString const &	GameSessionID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Revoke a game session code.

Parameters

GameSessionID	ID of the game session that a code should be revoked for.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RevokePartyCode()

FAccelByteTaskWPtr AccelByte::Api::Session::RevokePartyCode	(	FString const &	PartyID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Revoke a party code associated with a party.

Parameters

PartyID	ID of the party that a code should be revoked for.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

SendGameSessionInvite()

FAccelByteTaskWPtr AccelByte::Api::Session::SendGameSessionInvite	(	FString const &	GameSessionID,
		FString const &	UserID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Send an invite to a game session by ID.

Parameters

GameSessionID	The ID of the session.
UserID	The ID of the user to invite.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

SendGameSessionInvitePlatform()

FAccelByteTaskWPtr AccelByte::Api::Session::SendGameSessionInvitePlatform	(	FString const &	GameSessionID,
		FString const &	UserID,
		EAccelByteV2SessionPlatform const &	Platform,
		THandler< FAccelByteModelsV2SessionInvitePlatformResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Send an invite to a game session by ID.

Parameters

GameSessionID	The ID of the session.
UserID	The ID of the user to invite.
Platform	The platform of the user
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

SendPartyInvite()

FAccelByteTaskWPtr AccelByte::Api::Session::SendPartyInvite	(	FString const &	PartyID,
		FString const &	UserID,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Send a party invite to the given user.

Parameters

PartyID	The ID of the party session for which the invite will be created.
UserID	The ID of the user to invite.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

SendPartyInvitePlatform()

FAccelByteTaskWPtr AccelByte::Api::Session::SendPartyInvitePlatform	(	FString const &	PartyID,
		FString const &	UserID,
		EAccelByteV2SessionPlatform const &	Platform,
		THandler< FAccelByteModelsV2SessionInvitePlatformResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Send a party invite to the given user on native platform.

Parameters

PartyID	The ID of the party session for which the invite will be created.
UserID	The ID of the user to invite.
Platform	The platform of the user
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

StorePersonalDataToReservedPartySessionStorage()

FAccelByteTaskWPtr AccelByte::Api::Session::StorePersonalDataToReservedPartySessionStorage	(	FString const &	PartySessionID,
		FAccelByteModelsV2PartySessionStorageReservedData const &	Data,
		THandler< FAccelByteModelsV2PartySessionStorageReservedData > const &	OnSuccess,
		FErrorHandler const &	OnError )

Store a data by current player to its party reserved personal storage. WARNING: Overwrite operation! This function will be used by AccelByte OSS internally and won't be exposed as a function.

Parameters

PartySessionID	Current player's party ID.
Data	Player's data to be stored.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

StorePlayerAttributes()

FAccelByteTaskWPtr AccelByte::Api::Session::StorePlayerAttributes	(	FAccelByteModelsV2StorePlayerAttributesRequest const &	AttributesRequest,
		THandler< FAccelByteModelsV2PlayerAttributes > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update stored attributes for the current player.

Parameters

AttributesRequest	Request model for updating attributes for this player.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateGameSession()

FAccelByteTaskWPtr AccelByte::Api::Session::UpdateGameSession	(	FString const &	GameSessionID,
		FAccelByteModelsV2GameSessionUpdateRequest const &	UpdateRequest,
		THandler< FAccelByteModelsV2GameSession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update a game session by ID.

Parameters

GameSessionID	The ID of the session.
UpdateRequest	The game session update request body.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateLeaderStorage()

FAccelByteTaskWPtr AccelByte::Api::Session::UpdateLeaderStorage	(	FString const &	SessionID,
		FJsonObjectWrapper const &	Data,
		THandler< FJsonObjectWrapper > const &	OnSuccess,
		FErrorHandler const &	OnError )

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

Parameters

Data	Data to update leader storage.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateMemberStorage()

FAccelByteTaskWPtr AccelByte::Api::Session::UpdateMemberStorage	(	FString const &	SessionID,
		FJsonObjectWrapper const &	Data,
		THandler< FJsonObjectWrapper > const &	OnSuccess,
		FErrorHandler const &	OnError )

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

Data	Data to update member storage.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateParty()

FAccelByteTaskWPtr AccelByte::Api::Session::UpdateParty	(	FString const &	PartyID,
		FAccelByteModelsV2PartyUpdateRequest const &	UpdateRequest,
		THandler< FAccelByteModelsV2PartySession > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update a party.

Parameters

PartyID	The ID of the party session to update.
UpdateRequest	The request body to update the party with.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdatePartyStorage()

FAccelByteTaskWPtr AccelByte::Api::Session::UpdatePartyStorage	(	FString const &	PartyID,
		FJsonObjectWrapper const &	Data,
		THandler< FJsonObjectWrapper > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update current user's party session member storage data. This allows users to update or insert their own party storage (non-immutable). This will overwrite this user's party storage data. Can store generic JSON.

Parameters

PartyID	The ID of the party session.
Data	Generic JSON data to update party storage.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.