Loading...
Searching...
No Matches
AccelByte.Api.UserProfiles Class Reference
Inheritance diagram for AccelByte.Api.UserProfiles:

Public Member Functions

void GetUserProfile (ResultCallback< UserProfile > callback)
 Get (my) user profile / current logged in user.
void GetUserProfile (string userId, ResultCallback< UserProfile > callback)
 Get an user profile.
void CreateUserProfile (CreateUserProfileRequest createRequest, ResultCallback< UserProfile > callback)
 Create (my) user profile / current logged in user.
void CreateUserProfile (string userId, string language, Dictionary< string, object > customAttributes, string timezone, ResultCallback< UserProfile > callback)
 Create an user profile.
void UpdateUserProfile (UpdateUserProfileRequest updateRequest, ResultCallback< UserProfile > callback)
 Update some fields of (my) user profile / current logged in user.
void UpdateUserProfile (string userId, string language, string timezone, Dictionary< string, object > customAttributes, string zipCode, ResultCallback< UserProfile > callback)
 Update some fields of an user profile.
void GetCustomAttributes (ResultCallback< Dictionary< string, object > > callback)
 Get user's own custom attribute profile information. If it doesn't exist, that will be an error.
void UpdateCustomAttributes (Dictionary< string, object > updates, ResultCallback< Dictionary< string, object > > callback)
 Update user's own custom attribute profile information. If it doesn't exist, that will be an error.
void GetPublicUserProfile (string userId, ResultCallback< PublicUserProfile > callback)
 Get the PublicUserProfile for a specified user.
void GetUserAvatar (string userID, ResultCallback< Texture2D > callback)
 Request the Avatar of the given UserProfile.
void GetUserProfilePublicInfoByPublicId (string publicId, ResultCallback< PublicUserProfile > callback)
 Get user public profile info by public id/code.
void GenerateUploadURL (string folder, FileType fileType, ResultCallback< GenerateUploadURLResult > callback)
 Generate an upload URL. It's valid for 10 minutes.
void GenerateUploadURLForUserContent (string userId, FileType fileType, ResultCallback< GenerateUploadURLResult > callback, UploadCategory category=UploadCategory.DEFAULT)
 Generate an upload URL for user content. It's valid for 10 minutes.
void GetPrivateCustomAttributes (ResultCallback< Dictionary< string, object > > callback)
 Get user's own custom private attribute profile information. If it doesn't exist, that will be an error.
void UpdatePrivateCustomAttributes (Dictionary< string, object > updates, ResultCallback< Dictionary< string, object > > callback)
 Update user's own private custom attribute profile information. If it doesn't exist, that will be an error.

Additional Inherited Members

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

Member Function Documentation

◆ CreateUserProfile() [1/2]

void AccelByte.Api.UserProfiles.CreateUserProfile ( CreateUserProfileRequest createRequest,
ResultCallback< UserProfile > callback )
inline

Create (my) user profile / current logged in user.

Parameters
createRequestUser profile details to create user profile.
callbackReturns a Result that contains UserProfile via callback when completed

◆ CreateUserProfile() [2/2]

void AccelByte.Api.UserProfiles.CreateUserProfile ( string userId,
string language,
Dictionary< string, object > customAttributes,
string timezone,
ResultCallback< UserProfile > callback )
inline

Create an user profile.

Parameters
userIdUser Id value to create user profile.
languageLanguage allowed format: en, en-US.
customAttributesCustom attribues value to be included.
timezoneTimezone follows : IANA time zone, e.g. Asia/Shanghai.
callbackReturns a Result that contains UserProfile via callback when completed

◆ GenerateUploadURL()

void AccelByte.Api.UserProfiles.GenerateUploadURL ( string folder,
FileType fileType,
ResultCallback< GenerateUploadURLResult > callback )
inline

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

Parameters
folderThe name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace
fileTypeOne of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
callbackReturns a Result that contains PublicUserProfile via callback when completed.

◆ GenerateUploadURLForUserContent()

void AccelByte.Api.UserProfiles.GenerateUploadURLForUserContent ( string userId,
FileType fileType,
ResultCallback< GenerateUploadURLResult > callback,
UploadCategory category = UploadCategory::DEFAULT )
inline

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

Parameters
userIdUserID for the requested
fileTypeOne of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
callbackReturns a Result that contains PublicUserProfile via callback when completed.
categorySupported categories: default, reporting. Default value : default

◆ GetCustomAttributes()

void AccelByte.Api.UserProfiles.GetCustomAttributes ( ResultCallback< Dictionary< string, object > > callback)
inline

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

Parameters
callbackReturns a Result Json Object via callback when completed.

◆ GetPrivateCustomAttributes()

void AccelByte.Api.UserProfiles.GetPrivateCustomAttributes ( ResultCallback< Dictionary< string, object > > callback)
inline

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

Parameters
callbackReturns a Result Json Object via callback when completed.

◆ GetPublicUserProfile()

void AccelByte.Api.UserProfiles.GetPublicUserProfile ( string userId,
ResultCallback< PublicUserProfile > callback )
inline

Get the PublicUserProfile for a specified user.

Parameters
userIdUserID for the profile requested
callbackReturns a Result that contains PublicUserProfile via callback when completed.

◆ GetUserAvatar()

void AccelByte.Api.UserProfiles.GetUserAvatar ( string userID,
ResultCallback< Texture2D > callback )
inline

Request the Avatar of the given UserProfile.

Parameters
userIDThe UserID of a public Profile
callbackReturns a result that contains a Texture2D

◆ GetUserProfile() [1/2]

void AccelByte.Api.UserProfiles.GetUserProfile ( ResultCallback< UserProfile > callback)
inline

Get (my) user profile / current logged in user.

Parameters
callbackReturns a Result that contains UserProfile via callback when completed.

◆ GetUserProfile() [2/2]

void AccelByte.Api.UserProfiles.GetUserProfile ( string userId,
ResultCallback< UserProfile > callback )
inline

Get an user profile.

Parameters
userIdUser Id value to create user profile.
callbackReturns a Result that contains UserProfile via callback when completed

◆ GetUserProfilePublicInfoByPublicId()

void AccelByte.Api.UserProfiles.GetUserProfilePublicInfoByPublicId ( string publicId,
ResultCallback< PublicUserProfile > callback )
inline

Get user public profile info by public id/code.

Parameters
publicIdThe publicId/public code of a user
callbackReturns a Result that contains UserProfile via callback when completed.

◆ UpdateCustomAttributes()

void AccelByte.Api.UserProfiles.UpdateCustomAttributes ( Dictionary< string, object > updates,
ResultCallback< Dictionary< string, object > > callback )
inline

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

Parameters
updatesProfileUpdateRequest Request object.
callbackReturns a Result Json Object via callback when completed.

◆ UpdatePrivateCustomAttributes()

void AccelByte.Api.UserProfiles.UpdatePrivateCustomAttributes ( Dictionary< string, object > updates,
ResultCallback< Dictionary< string, object > > callback )
inline

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

Parameters
updatesadditional properties or Custom Attributes
callbackReturns a Result Json Object via callback when completed.

◆ UpdateUserProfile() [1/2]

void AccelByte.Api.UserProfiles.UpdateUserProfile ( string userId,
string language,
string timezone,
Dictionary< string, object > customAttributes,
string zipCode,
ResultCallback< UserProfile > callback )
inline

Update some fields of an user profile.

Parameters
userIdUser Id value to create user profile.
languageLanguage allowed format: en, en-US.
customAttributesCustom attribues value to be included.
timezoneTimezone follows : IANA time zone, e.g. Asia/Shanghai.
callbackReturns a Result that contains UserProfile via callback when completed

◆ UpdateUserProfile() [2/2]

void AccelByte.Api.UserProfiles.UpdateUserProfile ( UpdateUserProfileRequest updateRequest,
ResultCallback< UserProfile > callback )
inline

Update some fields of (my) user profile / current logged in user.

Parameters
updateRequestUser profile details to update user profile
callbackReturns a Result that contains UserProfile via callback when completed