AccelByte::Api::GameProfile Class Reference

GameProfile API to manage user's in-game profiles (character). More...

#include <AccelByteGameProfileApi.h>

Inheritance diagram for AccelByte::Api::GameProfile:

Public Member Functions
	GameProfile (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	GameProfile (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	BatchGetPublicGameProfiles (TArray< FString > const &UserIds, THandler< TArray< FAccelByteModelsPublicGameProfile > > const &OnSuccess, FErrorHandler const &OnError)
	Get public game profiles from the specified user id(s).
FAccelByteTaskWPtr	GetAllGameProfiles (THandler< TArray< FAccelByteModelsGameProfile > > const &OnSuccess, FErrorHandler const &OnError)
	Get all user's game profiles.
FAccelByteTaskWPtr	CreateGameProfile (FAccelByteModelsGameProfileRequest const &GameProfileRequest, THandler< FAccelByteModelsGameProfile > const &OnSuccess, FErrorHandler const &OnError)
	Create a game profile.
FAccelByteTaskWPtr	GetGameProfile (FString const &ProfileId, THandler< FAccelByteModelsGameProfile > const &OnSuccess, FErrorHandler const &OnError)
	Get a specific game profile.
FAccelByteTaskWPtr	UpdateGameProfile (FString const &ProfileId, FAccelByteModelsGameProfileRequest const &GameProfileRequest, THandler< FAccelByteModelsGameProfile > const &OnSuccess, FErrorHandler const &OnError)
	Update a specific game profile.
FAccelByteTaskWPtr	DeleteGameProfile (FString const &ProfileId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a specific game profile.
FAccelByteTaskWPtr	GetGameProfileAttribute (FString const &ProfileId, FString const &AttributeName, THandler< FAccelByteModelsGameProfileAttribute > const &OnSuccess, FErrorHandler const &OnError)
	Get an attribute value from a game profile.
FAccelByteTaskWPtr	UpdateGameProfileAttribute (FString const &ProfileId, FAccelByteModelsGameProfileAttribute const &Attribute, THandler< FAccelByteModelsGameProfile > const &OnSuccess, FErrorHandler const &OnError)
	Update an attribute from a game profile.
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)

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

Detailed Description

GameProfile API to manage user's in-game profiles (character).

Member Function Documentation

BatchGetPublicGameProfiles()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::BatchGetPublicGameProfiles	(	TArray< FString > const &	UserIds,
		THandler< TArray< FAccelByteModelsPublicGameProfile > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get public game profiles from the specified user id(s).

Parameters

UserIds	Specify user id(s) those will be requested. One UserId is required.
OnSuccess	This will be called when the operation succeeded. The result is an array of FAccelByteModelsPublicGameProfile.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateGameProfile()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::CreateGameProfile	(	FAccelByteModelsGameProfileRequest const &	GameProfileRequest,
		THandler< FAccelByteModelsGameProfile > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a game profile.

Parameters

GameProfileRequest	Game profile that will be created.
OnSuccess	This will be called when the operation succeeded. The result is a FAccelByteModelsGameProfile that created.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

DeleteGameProfile()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::DeleteGameProfile	(	FString const &	ProfileId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a specific game profile.

Parameters

ProfileId	Specified game profile ID.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetAllGameProfiles()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::GetAllGameProfiles	(	THandler< TArray< FAccelByteModelsGameProfile > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get all user's game profiles.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is an array FAccelByteModelsGameProfile.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetGameProfile()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::GetGameProfile	(	FString const &	ProfileId,
		THandler< FAccelByteModelsGameProfile > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a specific game profile.

Parameters

ProfileId	Specified game profile ID.
OnSuccess	This will be called when the operation succeeded. The result is a FAccelByteModelsGameProfile that requested.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetGameProfileAttribute()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::GetGameProfileAttribute	(	FString const &	ProfileId,
		FString const &	AttributeName,
		THandler< FAccelByteModelsGameProfileAttribute > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get an attribute value from a game profile.

Parameters

ProfileId	Specified game profile ID.
AttributeName	Specified attribute name.
OnSuccess	This will be called when the operation succeeded. The result is an attribute name and value as string.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateGameProfile()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::UpdateGameProfile	(	FString const &	ProfileId,
		FAccelByteModelsGameProfileRequest const &	GameProfileRequest,
		THandler< FAccelByteModelsGameProfile > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update a specific game profile.

Parameters

ProfileId	Specified game profile ID.
GameProfileRequest	Game profile that will be updated.
OnSuccess	This will be called when the operation succeeded. The result is a FAccelByteModelsGameProfile that updated.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

UpdateGameProfileAttribute()

FAccelByteTaskWPtr AccelByte::Api::GameProfile::UpdateGameProfileAttribute	(	FString const &	ProfileId,
		FAccelByteModelsGameProfileAttribute const &	Attribute,
		THandler< FAccelByteModelsGameProfile > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update an attribute from a game profile.

Parameters

ProfileId	Specified game profile ID.
Attribute	Consist of attribute name and value that will be updated.
OnSuccess	This will be called when the operation succeeded. The result is a FAccelByteModelsGameProfile with an updated attribute.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.