API to create, update, and get user's profile. More...

#include <AccelByteUserProfileApi.h>

Inheritance diagram for AccelByte::Api::UserProfile:

Public Member Functions
	UserProfile (Credentials const &Credentials, Settings const &Settings, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	UserProfile (Credentials const &Credentials, Settings const &Settings, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetUserProfile (THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user's own profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	GetPublicUserProfileInfo (FString const &UserId, THandler< FAccelByteModelsPublicUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get other user's public profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	BatchGetPublicUserProfileInfos (FString const &UserIds, THandler< TArray< FAccelByteModelsPublicUserProfileInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Batch get multiple user public profile information.
FAccelByteTaskWPtr	BulkGetPublicUserProfileInfos (TArray< FString > const &UserIds, THandler< TArray< FAccelByteModelsPublicUserProfileInfo > > const &OnSuccess, FErrorHandler const &OnError)
	Bulk get multiple user public profile information.
FAccelByteTaskWPtr	BulkGetPublicUserProfileInfosV2 (TArray< FString > const &UserIds, THandler< FAccelByteModelsPublicUserProfileInfoV2 > const &OnSuccess, FErrorHandler const &OnError)
	Bulk get multiple user public profile information.
FAccelByteTaskWPtr	GetCustomAttributes (THandler< FJsonObject > const &OnSuccess, FErrorHandler const &OnError)
	Get user's own custom attribute profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	GetPublicCustomAttributes (FString const &UserId, THandler< FJsonObject > const &OnSuccess, FErrorHandler const &OnError)
	Get user's own custom attribute profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	UpdateUserProfile (FAccelByteModelsUserProfileUpdateRequest const &ProfileUpdateRequest, THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Update user's current profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	UpdateCustomAttributes (FJsonObject const &CustomAttributesUpdateRequest, THandler< FJsonObject > const &OnSuccess, FErrorHandler const &OnError)
	Update user's current custom attributes profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	CreateUserProfile (FAccelByteModelsUserProfileCreateRequest const &ProfileCreateRequest, THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Create complete player profile. If it already exist, that will be an error.
FAccelByteTaskWPtr	GetUserProfilePublicInfoByPublicId (FString const &PublicId, THandler< FAccelByteModelsPublicUserProfileInfo > const &OnSuccess, FCustomErrorHandler const &OnError)
	Get User Profile Public Info By PublicId.
FAccelByteTaskWPtr	CreateUserProfile (FString const &UserId, FAccelByteModelsUserProfileCreateRequest const &ProfileCreateRequest, THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Create complete player profile. If it already exist, that will be an error.
FAccelByteTaskWPtr	UpdateUserProfile (FString const &UserId, FAccelByteModelsUserProfileUpdateRequest const &ProfileUpdateRequest, THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Update user's current profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	GetUserProfile (FString const &UserId, THandler< FAccelByteModelsUserProfileInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user's own profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	GenerateUploadURL (FString const &Folder, EAccelByteFileType FileType, THandler< FAccelByteModelsUserProfileUploadURLResult > const &OnSuccess, FErrorHandler const &OnError)
	Generate an upload URL. It's valid for 10 minutes..
FAccelByteTaskWPtr	GenerateUploadURLForUserContent (FString const &UserId, EAccelByteFileType FileType, THandler< FAccelByteModelsUserProfileUploadURLResult > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUploadCategory Category=EAccelByteUploadCategory::DEFAULT)
	Generate an upload URL for user content. It's valid for 10 minutes. There are 2 kinds of storage limitation per user : maximum file count and maximum file size.
FAccelByteTaskWPtr	GetPrivateCustomAttributes (THandler< FJsonObjectWrapper > const &OnSuccess, FErrorHandler const &OnError)
	Get user's own private custom attribute profile information. If it doesn't exist, that will be an error.
FAccelByteTaskWPtr	UpdatePrivateCustomAttributes (FJsonObject const &PrivateCustomAttributesUpdateRequest, THandler< FJsonObjectWrapper > const &OnSuccess, FErrorHandler const &OnError)
	Update user's own private custom attributes profile information. If it doesn't exist, that will be an error.
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

API to create, update, and get user's profile.

Member Function Documentation

◆ BatchGetPublicUserProfileInfos()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::BatchGetPublicUserProfileInfos	(	FString const &	UserIds,
		THandler< TArray< FAccelByteModelsPublicUserProfileInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Batch get multiple user public profile information.

Parameters

UserIds	Multiple user ids, separated by comma.
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.

◆ BulkGetPublicUserProfileInfos()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::BulkGetPublicUserProfileInfos	(	TArray< FString > const &	UserIds,
		THandler< TArray< FAccelByteModelsPublicUserProfileInfo > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk get multiple user public profile information.

Parameters

UserIds	Multiple user ids.
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.

◆ BulkGetPublicUserProfileInfosV2()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::BulkGetPublicUserProfileInfosV2	(	TArray< FString > const &	UserIds,
		THandler< FAccelByteModelsPublicUserProfileInfoV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk get multiple user public profile information.

Parameters

UserIds	Multiple user ids.
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.

◆ CreateUserProfile() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::CreateUserProfile	(	FAccelByteModelsUserProfileCreateRequest const &	ProfileCreateRequest,
		THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create complete player profile. If it already exist, that will be an error.

Parameters

ProfileCreateRequest	Request object.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateUserProfile() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::CreateUserProfile	(	FString const &	UserId,
		FAccelByteModelsUserProfileCreateRequest const &	ProfileCreateRequest,
		THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create complete player profile. If it already exist, that will be an error.

Parameters

UserId	The id of the user.
ProfileCreateRequest	Request object.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GenerateUploadURL()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GenerateUploadURL	(	FString const &	Folder,
		EAccelByteFileType	FileType,
		THandler< FAccelByteModelsUserProfileUploadURLResult > const &	OnSuccess,
		FErrorHandler const &	OnError )

Generate an upload URL. It's valid for 10 minutes..

Parameters

Folder	The name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace.
FileType	One of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GenerateUploadURLForUserContent()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GenerateUploadURLForUserContent	(	FString const &	UserId,
		EAccelByteFileType	FileType,
		THandler< FAccelByteModelsUserProfileUploadURLResult > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUploadCategory	Category = EAccelByteUploadCategory::DEFAULT )

Generate an upload URL for user content. It's valid for 10 minutes. There are 2 kinds of storage limitation per user : maximum file count and maximum file size.

Parameters

UserId	User's id, should follow UUID version 4 without hyphen.
FileType	One of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.
Category	Upload category. Supported categories: default, reporting. Default value : default.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetCustomAttributes	(	THandler< FJsonObject > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's own custom attribute profile information. If it doesn't exist, that will be an error.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FJsonObject.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetPrivateCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetPrivateCustomAttributes	(	THandler< FJsonObjectWrapper > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's own private custom attribute profile information. If it doesn't exist, that will be an error.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FJsonObject.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetPublicCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetPublicCustomAttributes	(	FString const &	UserId,
		THandler< FJsonObject > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's own custom attribute profile information. If it doesn't exist, that will be an error.

Parameters

UserId	The id of the user.
OnSuccess	This will be called when the operation succeeded. The result is FJsonObject.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetPublicUserProfileInfo()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetPublicUserProfileInfo	(	FString const &	UserId,
		THandler< FAccelByteModelsPublicUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get other user's public profile information. If it doesn't exist, that will be an error.

Parameters

UserId	The id of the user.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsPublicUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserProfile() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetUserProfile	(	FString const &	UserId,
		THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's own profile information. If it doesn't exist, that will be an error.

Parameters

UserId	The id of the user.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserProfile() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetUserProfile	(	THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's own profile information. If it doesn't exist, that will be an error.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserProfilePublicInfoByPublicId()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::GetUserProfilePublicInfoByPublicId	(	FString const &	PublicId,
		THandler< FAccelByteModelsPublicUserProfileInfo > const &	OnSuccess,
		FCustomErrorHandler const &	OnError )

Get User Profile Public Info By PublicId.

Parameters

PublicId	The Public Id of user used to get user profile
OnSuccess	This will be called when the operation succeeded. The result is FUserProfilePublicInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::UpdateCustomAttributes	(	FJsonObject const &	CustomAttributesUpdateRequest,
		THandler< FJsonObject > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update user's current custom attributes profile information. If it doesn't exist, that will be an error.

Parameters

CustomAttributesUpdateRequest	Request object which consists custom attributes profile information.
OnSuccess	This will be called when the operation succeeded. The result is FJsonObject.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdatePrivateCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::UserProfile::UpdatePrivateCustomAttributes	(	FJsonObject const &	PrivateCustomAttributesUpdateRequest,
		THandler< FJsonObjectWrapper > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update user's own private custom attributes profile information. If it doesn't exist, that will be an error.

Parameters

PrivateCustomAttributesUpdateRequest	Request object which consists private custom attributes profile information.
OnSuccess	This will be called when the operation succeeded. The result is FJsonObject.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateUserProfile() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::UpdateUserProfile	(	FAccelByteModelsUserProfileUpdateRequest const &	ProfileUpdateRequest,
		THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update user's current profile information. If it doesn't exist, that will be an error.

Parameters

ProfileUpdateRequest	Request object.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateUserProfile() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UserProfile::UpdateUserProfile	(	FString const &	UserId,
		FAccelByteModelsUserProfileUpdateRequest const &	ProfileUpdateRequest,
		THandler< FAccelByteModelsUserProfileInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update user's current profile information. If it doesn't exist, that will be an error.

Parameters

UserId	The id of the user.
ProfileUpdateRequest	Request object.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserProfileInfo.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BatchGetPublicUserProfileInfos()

◆ BulkGetPublicUserProfileInfos()

◆ BulkGetPublicUserProfileInfosV2()

◆ CreateUserProfile() [1/2]

◆ CreateUserProfile() [2/2]

◆ GenerateUploadURL()

◆ GenerateUploadURLForUserContent()

◆ GetCustomAttributes()

◆ GetPrivateCustomAttributes()

◆ GetPublicCustomAttributes()

◆ GetPublicUserProfileInfo()

◆ GetUserProfile() [1/2]

◆ GetUserProfile() [2/2]

◆ GetUserProfilePublicInfoByPublicId()

◆ UpdateCustomAttributes()

◆ UpdatePrivateCustomAttributes()

◆ UpdateUserProfile() [1/2]

◆ UpdateUserProfile() [2/2]