UXsollaLoginSubsystem

Inherits from UGameInstanceSubsystem

Public Functions

Protected Functions

Protected Attributes

Friends

Public Functions Documentation

function UXsollaLoginSubsystem

1UXsollaLoginSubsystem()

function Initialize

1virtual void Initialize(
2    FSubsystemCollectionBase & Collection
3) override

function Deinitialize

1virtual void Deinitialize() override

function Initialize

1void Initialize(
2    const FString & InProjectId,
3    const FString & InLoginId,
4    const FString & InClientId
5)

Initializes controller with provided Project ID and Login ID (use to override project settings).

Parameters:

• InProjectId New Project ID value from Publisher Account. It can be found in Publisher Account next to the name of your project.
• InLoginId New Login ID value from Publisher Account. To get it, open Publisher Account, go to the Login > Dashboard section, and click Copy ID beside the name of the Login project.
• InClientId New Client ID value from Publisher Account. It can be found in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.

function RegisterUser

 1void RegisterUser(
 2    const FString & Username,
 3    const FString & Password,
 4    const FString & Email,
 5    const FString & State,
 6    const FString & Locale,
 7    const bool PersonalDataProcessingConsent,
 8    const bool ReceiveNewsConsent,
 9    const TMap< FString, FString > & AdditionalFields,
10    const FOnAuthUpdate & SuccessCallback,
11    const FOnAuthError & ErrorCallback
12)

Creates a new user account in the application and sends a sign-up confirmation email to the specified email address.

Parameters:

• Username Username.
• Password Password.
• Email Email address.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• Locale Defines localization of the email the user receives.

The following languages are supported: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Italian (it_IT), Japanese (ja_JP), Korean (ko_KR), Polish (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Enlish (en_XX, default).

• PersonalDataProcessingConsent Whether the user gave consent to processing of their personal data.
• ReceiveNewsConsent Whether the user gave consent to receive the newsletters.
• AdditionalFields Parameters used for extended registration forms.
• SuccessCallback Called after successful user registration. Account confirmation message will be sent to the specified email address.
• ErrorCallback Called after the request resulted with an error.

To complete registration, the user must follow the link from the email. More about the use cases .

function ResendAccountConfirmationEmail

1void ResendAccountConfirmationEmail(
2    const FString & Username,
3    const FString & State,
4    const FString & Locale,
5    const FOnRequestSuccess & SuccessCallback,
6    const FOnAuthError & ErrorCallback
7)

Resends a sign-up confirmation email to the specified email address.

Parameters:

• Username Username.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• Locale Defines localization of the email the user receives.

The following languages are supported: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Italian (it_IT), Japanese (ja_JP), Korean (ko_KR), Polish (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Enlish (en_XX, default).

• SuccessCallback Called after successful sending of the request.
• ErrorCallback Called after the request resulted with an error.

To complete registration, the user must follow the link from the email. More about the use cases .

function AuthenticateUser

1void AuthenticateUser(
2    const FString & Username,
3    const FString & Password,
4    const FOnAuthUpdate & SuccessCallback,
5    const FOnAuthError & ErrorCallback,
6    const bool bRememberMe =false
7)

Authenticates the user by the username/email and password specified via the authentication interface.

Parameters:

• Username Username or email.
• Password Password.
• SuccessCallback Called after successful user authentication. Authentication data including the JWT will be received.
• ErrorCallback Called after the request resulted with an error.
• bRememberMe Whether the user agrees to save the authentication data. Default is false.

More about the use cases .

function AuthWithXsollaWidget

 1void AuthWithXsollaWidget(
 2    UObject * WorldContextObject,
 3    UXsollaLoginBrowserWrapper *& BrowserWidget,
 4    const FOnAuthUpdate & SuccessCallback,
 5    const FOnAuthCancel & CancelCallback,
 6    const FOnAuthError & ErrorCallback,
 7    const bool bRememberMe =false,
 8    const FString & Locale =TEXT(""),
 9    const FString & State =TEXT("xsollatest")
10)

Authenticates the user with Xsolla Login widget.

Parameters:

• WorldContextObject The world context.
• BrowserWidget Widget that shows the social network authentication form. Can be set in the project settings.
• SuccessCallback Called after successful user authentication. Authentication data including the JWT will be received.
• CancelCallback Called after user authentication was canceled.
• ErrorCallback Called after user authentication resulted with an error.
• bRememberMe Whether the user agrees to save the authentication data. false by default.
• Locale (optional) Login widget UI language. Supported languages: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), Filipino (fil-PH), English (en_XX), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Indonesian (id-ID), Italian (it_IT), Japanese (ja_JP), Khmer (km-KH), Korean (ko_KR), Lao language ( lo-LA), Myanmar (my-MM), NepaliPolish (ne-NP), (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW). By default, the locale is determined by the user’s IP
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.

function ResetUserPassword

1void ResetUserPassword(
2    const FString & User,
3    const FString & Locale,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnAuthError & ErrorCallback
6)

Resets the user’s current password and sends an email to change the password to the email address specified during sign-up.

Parameters:

• User User identifier (name or email address depending on user data storage type).
• Locale Defines localization of the email the user receives.

The following languages are supported: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Italian (it_IT), Japanese (ja_JP), Korean (ko_KR), Polish (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Enlish (en_XX, default).

• SuccessCallback Called after successful user password reset.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function ValidateToken

1void ValidateToken(
2    const FOnAuthUpdate & SuccessCallback,
3    const FOnAuthError & ErrorCallback
4)

Internal request for token validation (called with each auth update automatically)

Parameters:

• SuccessCallback Called after successful token validation.
• ErrorCallback Called after the request resulted with an error.

function GetSocialAuthenticationUrl

1void GetSocialAuthenticationUrl(
2    const FString & ProviderName,
3    const FString & State,
4    const FOnSocialUrlReceived & SuccessCallback,
5    const FOnAuthError & ErrorCallback
6)

Returns URL for authentication via the specified social network in a browser.

Parameters:

• ProviderName Name of a social network. Provider must be connected to Login in Publisher Account.

Can be amazon, apple, baidu, battlenet, discord, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, or xbox.

• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after URL for social authentication was successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function LaunchSocialAuthentication

1void LaunchSocialAuthentication(
2    UObject * WorldContextObject,
3    UUserWidget *& BrowserWidget,
4    const bool bRememberMe =false
5)

Opens social authentication URL in the browser.

Parameters:

• WorldContextObject The world context.
• BrowserWidget Widget to show the social network authentication form. Can be set in the project settings.
• bRememberMe Whether the user agrees to save the authentication data. false by default.

More about the use cases .

function LaunchNativeSocialAuthentication

1void LaunchNativeSocialAuthentication(
2    const FString & ProviderName,
3    const FOnAuthUpdate & SuccessCallback,
4    const FOnAuthCancel & CancelCallback,
5    const FOnAuthError & ErrorCallback,
6    const bool bRememberMe =false,
7    const FString & State =TEXT("xsollatest")
8)

Opens the specified social network mobile app (if available) in order to authenticate the user.

Parameters:

• ProviderName Name of the social network connected to Login in Publisher Account. Can be amazon, apple, baidu, battlenet, discord,facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, or xbox.
• SuccessCallback Called after successful user authentication. Authentication data including the JWT will be received.
• CancelCallback Called after user authentication was canceled.
• ErrorCallback Called after user authentication resulted with an error.
• bRememberMe Whether the user agrees to save the authentication data. Default is false.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.

function AuthenticateViaSocialNetwork

1void AuthenticateViaSocialNetwork(
2    const FString & ProviderName,
3    const FOnAuthUpdate & SuccessCallback,
4    const FOnAuthCancel & CancelCallback,
5    const FOnAuthError & ErrorCallback,
6    const bool bRememberMe =false,
7    const FString & State =TEXT("xsollatest")
8)

Authenticates user via social networks.

Parameters:

• ProviderName Name of the social network connected to Login in Publisher Account. Can be amazon, apple, baidu, battlenet, discord,facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, or xbox.
• SuccessCallback Called after successful user authentication. Authentication data including the JWT will be received.
• CancelCallback Called after user authentication was canceled.
• ErrorCallback Called after user authentication resulted with an error.
• bRememberMe Whether the user agrees to save the authentication data. Default is false.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.

Method incapsulates web-based and native authentication methods.

function SetToken

1void SetToken(
2    const FString & Token
3)

Sets a new value of a token (used when the token is obtained via social network authentication, etc.).

Parameters:

• Token User authorization token.

function RefreshToken

1void RefreshToken(
2    const FString & RefreshToken,
3    const FOnAuthUpdate & SuccessCallback,
4    const FOnAuthError & ErrorCallback
5)

Refreshes the token in case it is expired.

Parameters:

• RefreshToken Token used to refresh the expired access token. Received when authorizing the user with username/password for the first time.
• SuccessCallback Called after successful token refreshing. Refresh data including the JWT will be received.
• ErrorCallback Called after request resulted with an error.

Works only when OAuth 2.0 is enabled.

function ExchangeAuthenticationCodeToToken

1void ExchangeAuthenticationCodeToToken(
2    const FString & AuthenticationCode,
3    const FOnAuthUpdate & SuccessCallback,
4    const FOnAuthError & ErrorCallback
5)

Exchanges the user authentication code to a valid JWT.

Parameters:

• AuthenticationCode Access code received from several other OAuth 2.0 requests (example: code from social network authentication).
• SuccessCallback Called after successful exchanging. Contains exchanged token.
• ErrorCallback Called after request resulted with an error.

More about the use cases .

function AuthenticateWithSessionTicket

 1void AuthenticateWithSessionTicket(
 2    const FString & ProviderName,
 3    const FString & SessionTicket,
 4    const FString & Code,
 5    const FString & AppId,
 6    const FString & State,
 7    const FOnAuthUpdate & SuccessCallback,
 8    const FOnAuthError & ErrorCallback,
 9    const FString & Scope =TEXT("")
10)

Authenticates a user by exchanging the session ticket from Steam, Xbox, or Epic Games to the JWT.

Parameters:

• ProviderName Platform on which the session ticket was obtained. Can be steam, xbox, or epicgames.
• SessionTicket Session ticket received from the platform.
• Code Code received from the platform.
• AppId Platform application identifier.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after successful user authentication with a platform session ticket. Authentication data including a JWT will be received.
• ErrorCallback Called after the request resulted with an error.
• Scope Request scope (e.g. “basic_profile”,“offline”, etc., empty by default).

More about the use cases .

function GetUserAttributes

1void GetUserAttributes(
2    const FString & AuthToken,
3    const FString & UserId,
4    const TArray< FString > & AttributeKeys,
5    const FOnUserAttributesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Returns a list of particular user’s attributes with their values and descriptions.

Parameters:

• AuthToken User authorization token.
• UserId Identifier of a user whose public attributes should be requested. If not specified, the method returns attrubutes for the current user.
• AttributeKeys List of attributes’ keys which you want to get. If not specified, the method returns all user’s attributes.
• SuccessCallback Called after user attributes were successfully received.
• ErrorCallback Called after the request resulted with an error.

Returns only user-editable attributes. More about the use cases .

function GetUserReadOnlyAttributes

1void GetUserReadOnlyAttributes(
2    const FString & AuthToken,
3    const FString & UserId,
4    const TArray< FString > & AttributeKeys,
5    const FOnUserAttributesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Returns list of user read-only attributes.

Parameters:

• AuthToken User authorization token.
• UserId Identifier of a user whose attributes should be updated.
• AttributeKeys List of attributes’ keys which you want to get. If not specified, the method returns all user’s attributes.
• SuccessCallback Called after user attributes were successfully received.
• ErrorCallback Called after the request resulted with an error.

function ModifyUserAttributes

1void ModifyUserAttributes(
2    const FString & AuthToken,
3    const TArray< FXsollaUserAttribute > & AttributesToModify,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Updates the values of user attributes with the specified IDs.

Parameters:

• AuthToken User authorization token.
• AttributesToModify List of attributes of the specified game.

To add attribute which doesn’t exist, set this attribute to the key parameter.

To update value of the attribute, specify its key parameter and set the new value. You can change several attributes at a time.

• SuccessCallback Called after successful user attributes modification on the server side.
• ErrorCallback Called after the request resulted with an error.

The method can be used to create attributes. Changes are made on the user data storage side (server side). More about the use cases .

function RemoveUserAttributes

1void RemoveUserAttributes(
2    const FString & AuthToken,
3    const TArray< FString > & AttributesToRemove,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Removes user attributes with the specified IDs.

Parameters:

• AuthToken User authorization token.
• AttributesToRemove List of attribute keys for removal.
• SuccessCallback Called after successful user attributes removal on the server side.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side (server side). More about the use cases .

function CreateAccountLinkingCode

1void CreateAccountLinkingCode(
2    const FString & AuthToken,
3    const FOnCodeReceived & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Creates the code for linking the platform account to the existing main account when the user logs in to the game via a gaming console.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Сalled after successful account linking code creation. The new linking code will be received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function CheckUserAge

1void CheckUserAge(
2    const FString & DateOfBirth,
3    const FOnCheckUserAgeSuccess & SuccessCallback,
4    const FOnAuthError & ErrorCallback
5)

Checks user age for a particular region.

Parameters:

• DateOfBirth User’s birth date in the YYYY-MM-DD format.
• SuccessCallback Called after successful check of the user age.
• ErrorCallback Called after the request resulted with an error.

The age requirements depend on the region. Service determines the user location by the IP address. More about the use cases .

function LinkEmailAndPassword

1void LinkEmailAndPassword(
2    const FString & AuthToken,
3    const FString & Email,
4    const FString & Password,
5    const bool ReceiveNewsConsent,
6    const FString & Username,
7    const FOnLinkEmailAndPasswordSuccess & SuccessCallback,
8    const FOnError & ErrorCallback
9)

Adds a username, email address, and password, that can be used for authentication, to the current account.

Parameters:

• AuthToken User authorization token.
• Email User email.
• Password User password.
• ReceiveNewsConsent Whether the user gave consent to receive the newsletters.
• Username User’s username.
• SuccessCallback Called after successful email and password linking.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function LinkDeviceToAccount

1void LinkDeviceToAccount(
2    const FString & AuthToken,
3    const FString & PlatformName,
4    const FString & DeviceName,
5    const FString & DeviceId,
6    const FOnRequestSuccess & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Links the specified device to the current user account.

Parameters:

• AuthToken User authorization token.
• PlatformName Name of the mobile platform. Can be android or ios.
• DeviceName Manufacturer and model name of the device.
• DeviceId Platform specific unique device ID.

For Android, it is an ANDROID_ID constant.

For iOS, it is an identifierForVendor property.

• SuccessCallback Called after successful linking of the device.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function UnlinkDeviceFromAccount

1void UnlinkDeviceFromAccount(
2    const FString & AuthToken,
3    const int64 DeviceId,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Unlinks the specified device from the current user account.

Parameters:

• AuthToken User authorization token.
• DeviceId Platform specific unique device ID.

For Android, it is an ANDROID_ID constant.

For iOS, it is an identifierForVendor property.

• SuccessCallback Called after successful unlinking of the device.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function AuthenticateViaDeviceId

1void AuthenticateViaDeviceId(
2    const FString & DeviceName,
3    const FString & DeviceId,
4    const FString & State,
5    const FOnAuthUpdate & SuccessCallback,
6    const FOnAuthError & ErrorCallback
7)

Authenticates the user via a particular device ID.

Parameters:

• DeviceName Manufacturer and model name of the device.
• DeviceId Platform specific unique device ID.

For Android, it is an ANDROID_ID constant.

For iOS, it is an identifierForVendor property.

• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after successful user authentication via the device ID.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function AuthViaAccessTokenOfSocialNetwork

1void AuthViaAccessTokenOfSocialNetwork(
2    const FString & AuthToken,
3    const FString & AuthTokenSecret,
4    const FString & OpenId,
5    const FString & ProviderName,
6    const FString & State,
7    const FOnAuthUpdate & SuccessCallback,
8    const FOnAuthError & ErrorCallback
9)

Authenticates the user with the access token using social network credentials.

Parameters:

• AuthToken Access token received from a social network.
• AuthTokenSecret Parameter oauth_token_secret received from the authorization request. Required for Twitter only.
• OpenId Parameter openid received from the social network. Required for WeChat only.
• ProviderName Name of the social network connected to Login in Publisher Account. Can be facebook, google, linkedin, twitter, discord, naver, baidu, wechat, or qq_mobile.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after successful user authentication on the specified platform.
• ErrorCallback Called after the request resulted with an error.

function StartAuthByPhoneNumber

1void StartAuthByPhoneNumber(
2    const FString & PhoneNumber,
3    const FString & State,
4    const FOnStartAuthSuccess & SuccessCallback,
5    const FOnAuthError & ErrorCallback
6)

Starts user authentication and sends an SMS with a one-time code and a link to the specified phone number (if login via magic link is configured for the Login project).

Parameters:

• PhoneNumber User phone number.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after successful phone number authentication start.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function CompleteAuthByPhoneNumber

1void CompleteAuthByPhoneNumber(
2    const FString & Code,
3    const FString & OperationId,
4    const FString & PhoneNumber,
5    const FOnAuthUpdate & SuccessCallback,
6    const FOnAuthError & ErrorCallback
7)

Completes authentication after the user enters a one-time code or follows a link received by SMS.

Parameters:

• Code Confirmation code.
• OperationId Identifier of the confirmation code.
• PhoneNumber User phone number.
• SuccessCallback Called after successful phone number authentication.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function StartAuthByEmail

1void StartAuthByEmail(
2    const FString & Email,
3    const FString & State,
4    const FOnStartAuthSuccess & SuccessCallback,
5    const FOnAuthError & ErrorCallback
6)

Starts user authentication and sends an email with a one-time code and a link to the specified email address (if login via magic link is configured for the Login project).

Parameters:

• Email User email address.
• State Value used for additional user verification on backend. Must be at least 8 symbols long. xsollatest by default. Required for OAuth 2.0.
• SuccessCallback Called after successful email authentication start.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function CompleteAuthByEmail

1void CompleteAuthByEmail(
2    const FString & Code,
3    const FString & OperationId,
4    const FString & Email,
5    const FOnAuthUpdate & SuccessCallback,
6    const FOnAuthError & ErrorCallback
7)

Completes authentication after the user enters a one-time code or follows a link received in an email.

Parameters:

• Code Confirmation code.
• OperationId Identifier of the confirmation code.
• Email User email address.
• SuccessCallback Called after successful email authentication.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetAuthConfirmationCode

1void GetAuthConfirmationCode(
2    const FString & UserId,
3    const FString & OperationId,
4    const FOnAuthCodeSuccess & SuccessCallback,
5    const FOnAuthCodeTimeout & TimeoutCallback,
6    const FOnAuthError & ErrorCallback
7)

Returns confirmation code for completing authentication via email or phone number.

Parameters:

• UserId Identifier of the user (can be either email or phone number).
• OperationId Identifier of the confirmation code.
• SuccessCallback Called after receiving the confirmation code.
• TimeoutCallback Called after request timeout.
• ErrorCallback Called after the request resulted with an error.

User must follow the link provided via email/SMS to receive the code.

function GetUserDetails

1void GetUserDetails(
2    const FString & AuthToken,
3    const FOnUserDetailsUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns user details.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after successful user details were successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function ModifyUserDetails

 1void ModifyUserDetails(
 2    const FString & AuthToken,
 3    const FString & Birthday,
 4    const FString & FirstName,
 5    const FString & LastName,
 6    const FString & Gender,
 7    const FString & Nickname,
 8    const FOnUserDetailsUpdate & SuccessCallback,
 9    const FOnError & ErrorCallback
10)

Updates the specified user’s information.

Parameters:

• AuthToken User authorization token.
• Birthday User birth date in format YYYY-MM-DD. Can be changed only once.
• FirstName User first name. Pass empty string to remove the current first name.
• LastName User last name. Pass empty string to remove the current last name.
• Gender User gender (f - for female, m - for male).
• Nickname User nickname. Pass empty string to remove the current nickname.
• SuccessCallback Called after successful user details modification.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side. More about the use cases .

function GetUserEmail

1void GetUserEmail(
2    const FString & AuthToken,
3    const FOnUserDetailsParamUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns the user’s email.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after user email was successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetUserPhoneNumber

1void GetUserPhoneNumber(
2    const FString & AuthToken,
3    const FOnUserDetailsParamUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns user phone number that is used for two-factor authentication.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after user phone number was successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function ModifyUserPhoneNumber

1void ModifyUserPhoneNumber(
2    const FString & AuthToken,
3    const FString & PhoneNumber,
4    const FOnUserDetailsParamUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Changes the user’s phone number that is used for two-factor authentication.

Parameters:

• AuthToken User authorization token.
• PhoneNumber New user phone number.
• SuccessCallback Called after user phone number was successfully modified.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side (server-side). More about the use cases .

function RemoveUserPhoneNumber

1void RemoveUserPhoneNumber(
2    const FString & AuthToken,
3    const FString & PhoneNumber,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Deletes the user’s phone number that is used for two-factor authentication.

Parameters:

• AuthToken User authorization token.
• PhoneNumber User phone number for removal.
• SuccessCallback Called after the user phone number was successfully removed.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side (server side). More about the use cases .

function ModifyUserProfilePicture

1void ModifyUserProfilePicture(
2    const FString & AuthToken,
3    UTexture2D *const Picture,
4    const FOnUserDetailsParamUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Changes the user’s avatar.

Parameters:

• AuthToken User authorization token.
• Picture New user profile picture.
• SuccessCallback Called after the user profile picture was successfully modified.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side (server side). More about the use cases .

function RemoveProfilePicture

1void RemoveProfilePicture(
2    const FString & AuthToken,
3    const FOnRequestSuccess & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Deletes the user’s avatar.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after user profile picture was successfully removed.
• ErrorCallback Called after the request resulted with an error.

Changes are made on the user data storage side (server side). More about the use cases .

function GetFriends

 1void GetFriends(
 2    const FString & AuthToken,
 3    const EXsollaFriendsType Type,
 4    const EXsollaUsersSortCriteria SortBy,
 5    const EXsollaUsersSortOrder SortOrder,
 6    const FOnUserFriendsUpdate & SuccessCallback,
 7    const FOnError & ErrorCallback,
 8    const FString & After,
 9    const int Limit =20
10)

Returns user friends data.

Parameters:

• AuthToken User authorization token.
• Type Friends type.
• SortBy Condition for sorting users (by name/by update).
• SortOrder Condition for sorting users (ascending/descending).
• SuccessCallback Called after user friends data was successfully received.
• ErrorCallback Called after the request resulted with an error.
• After Parameter that is used for API pagination.
• Limit Maximum number of friends that can be received at a time.

function ModifyFriends

1void ModifyFriends(
2    const FString & AuthToken,
3    const EXsollaFriendAction Action,
4    const FString & UserID,
5    const FOnRequestSuccess & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Modifies relationships with the specified user.

Parameters:

• AuthToken User authorization token.
• Action Type of action to be applied to a specified friend.
• UserID Identifier of a user to change relationships with.
• SuccessCallback Called after successful user friends data modification.
• ErrorCallback Called after the request resulted with an error.

function GetSocialAuthLinks

1void GetSocialAuthLinks(
2    const FString & AuthToken,
3    const FString & Locale,
4    const FOnSocialAuthLinksUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Returns list of links for social authentication enabled in Publisher Account.

Parameters:

• AuthToken User authorization token.

• Locale Region in the <language code>_<country code> format, where:

• language code — language code in the ISO 639-1 format;

• country code — country/region code in the ISO 3166-1 alpha-2 format.

The list of the links will be sorted from most to least used social networks, according to the variable value.

• SuccessCallback Called after list of links for social authentication was successfully received.
• ErrorCallback Called after the request resulted with an error.

function GetSocialFriends

1void GetSocialFriends(
2    const FString & AuthToken,
3    const FString & Platform,
4    const FOnUserSocialFriendsUpdate & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const int Offset =0,
7    const int Limit =500,
8    const bool FromThisGame =false
9)

Returns user friends data from a social provider.

Parameters:

• AuthToken User authorization token.
• Platform Name of social provider. If empty, friends from all available social providers will be fetched.
• SuccessCallback Called after user friends data was successfully received.
• ErrorCallback Called after the request resulted with an error.
• Offset Number of the element from which the list is generated.
• Limit Maximum number of friends that can be received at a time.
• FromThisGame Flag indicating whether social friends are from this game.

function GetUsersFriends

1void GetUsersFriends(
2    const FString & AuthToken,
3    const FString & Platform,
4    const FOnCodeReceived & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Returns friends on the server.

Parameters:

• AuthToken User authorization token.
• Platform Name of the chosen social provider. If not specified, the method gets friends from all social providers.
• SuccessCallback Called after user friends were successfully received.
• ErrorCallback Called after the request resulted with an error.

function GetUserProfile

1void GetUserProfile(
2    const FString & AuthToken,
3    const FString & UserID,
4    const FOnUserProfileReceived & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Returns specified user public profile information.

Parameters:

• AuthToken User authorization token.
• UserID User identifier of public profile information to be received.
• SuccessCallback Called after user profile data was successfully received.
• ErrorCallback Called after the request resulted with an error.

function GetUsersDevices

1void GetUsersDevices(
2    const FString & AuthToken,
3    const FOnUserDevicesUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns a list of devices linked to the current user account.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after users devices data was successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function SearchUsersByNickname

1void SearchUsersByNickname(
2    const FString & AuthToken,
3    const FString & Nickname,
4    const FOnUserSearchUpdate & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const int Offset =0,
7    const int Limit =100
8)

Searches for users with the specified nickname.

Parameters:

• AuthToken User authorization token.
• Nickname User nickname used as search criteria.
• SuccessCallback Called after user search is successfully completed.
• ErrorCallback Called after the request resulted with an error.
• Offset Number of elements from which the list is generated.
• Limit Maximum number of users that can be received at a time.

function GetUrlToLinkSocialNetworkToUserAccount

1void GetUrlToLinkSocialNetworkToUserAccount(
2    const FString & AuthToken,
3    const FString & ProviderName,
4    const FOnSocialAccountLinkingHtmlReceived & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Links a social network that can be used for authentication to the current account.

Parameters:

• AuthToken User authorization token.
• ProviderName Name of a social network. Provider must be connected to Login in Publisher Account.

Can be amazon, apple, baidu, battlenet, discord, facebook, github, google, instagram, kakao, linkedin, mailru, microsoft, msn, naver, ok, paradox, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, xbox, playstation.

• SuccessCallback Called after the URL for social authentication was successfully received.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function LinkSocialProvider

1void LinkSocialProvider(
2    UObject * WorldContextObject,
3    const FString & AuthToken,
4    const FString & ProviderName,
5    const FOnSocialLinkingSuccess & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Links a social network that can be used for authentication to the current account.

Parameters:

• WorldContextObject The world context.
• AuthToken User authorization token.
• ProviderName Name of a social network. Provider must be connected to Login in Publisher Account.

Can be amazon, apple, baidu, battlenet, discord, facebook, github, google, instagram, kakao, linkedin, mailru, microsoft, msn, naver, ok, paradox, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, xbox, playstation.

• SuccessCallback Called after social provider was successfully linked.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function UnlinkSocialProvider

1void UnlinkSocialProvider(
2    const FString & AuthToken,
3    const FString & ProviderName,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Unlinks a social network from the user account.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• ProviderName Name of a social network. Provider must be connected to Login in Publisher Account.

Can be amazon, apple, baidu, battlenet, discord, facebook, github, google, instagram, kakao, linkedin, mailru, microsoft, msn, naver, ok, paradox, paypal, psn, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, yahoo, yandex, youtube, xbox, playstation.

• SuccessCallback Called after a social network account was successfully unlinked.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetLinkedSocialNetworks

1void GetLinkedSocialNetworks(
2    const FString & AuthToken,
3    const FOnLinkedSocialNetworksUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns the list of linked social networks.

Parameters:

• AuthToken User authorization token.
• SuccessCallback Called after the list of linked social networks was successfully received.
• ErrorCallback Called after the request resulted with an error.

function LogoutUser

1void LogoutUser(
2    const FString & AuthToken,
3    const EXsollaSessionType Sessions,
4    const FOnRequestSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Logs the user out and deletes the user session according to the value of the sessions parameter (OAuth 2.0 only).

Parameters:

• AuthToken User authorization token.
• Sessions Shows how the user is logged out and how the user session is deleted. Available strings: sso and all. Leave empty to use the default value (all).
• SuccessCallback Called after successful user logout.
• ErrorCallback Called after the request resulted with an error.

function GetLoginData

1FXsollaLoginData GetLoginData() const

Returns user login state data.

function SetLoginData

1void SetLoginData(
2    const FXsollaLoginData & Data,
3    const bool ClearCache =true
4)

Sets user login state data.

function UpdateAuthTokenData

1void UpdateAuthTokenData(
2    const FString & AccessToken,
3    int ExpiresIn,
4    const FString & RefreshToken,
5    bool bRememberMe =true
6)

Updates user auth token data.

function DropLoginData

1void DropLoginData(
2    const bool ClearCache =true
3)

Drops cache and cleans login data.

function LoadSavedData

1void LoadSavedData()

Loads save game and extract data.

function SaveData

1void SaveData()

Saves cached data or resets it if RememberMe is false.

function HandleRequestError

1void HandleRequestError(
2    const XsollaHttpRequestError & ErrorData,
3    FErrorHandlersWrapper ErrorHandlersWrapper
4)

Protected Functions Documentation

function Default_HttpRequestComplete

1void Default_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnRequestSuccess SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function DefaultWithHandlerWrapper_HttpRequestComplete

1void DefaultWithHandlerWrapper_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnRequestSuccess SuccessCallback,
6    FErrorHandlersWrapper ErrorHandlersWrapper
7)

function UserLogin_HttpRequestComplete

1void UserLogin_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function TokenVerify_HttpRequestComplete

1void TokenVerify_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function SocialAuthUrl_HttpRequestComplete

1void SocialAuthUrl_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnSocialUrlReceived SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function GetUserAttributes_HttpRequestComplete

1void GetUserAttributes_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnUserAttributesUpdate SuccessCallback,
6    FErrorHandlersWrapper ErrorHandlersWrapper
7)

function GetReadOnlyUserAttributes_HttpRequestComplete

1void GetReadOnlyUserAttributes_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnUserAttributesUpdate SuccessCallback,
6    FErrorHandlersWrapper ErrorHandlersWrapper
7)

function AccountLinkingCode_HttpRequestComplete

1void AccountLinkingCode_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnCodeReceived SuccessCallback,
6    FErrorHandlersWrapper ErrorHandlersWrapper
7)

function CheckUserAge_HttpRequestComplete

1void CheckUserAge_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnCheckUserAgeSuccess SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function DeviceId_HttpRequestComplete

1void DeviceId_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function RefreshToken_HttpRequestComplete

1void RefreshToken_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function InnerRefreshToken_HttpRequestComplete

1void InnerRefreshToken_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnLoginDataUpdate SuccessCallback,
6    FOnLoginDataError ErrorCallback
7)

function SessionTicket_HttpRequestComplete

1void SessionTicket_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function AuthViaAccessTokenOfSocialNetwork_HttpRequestComplete

1void AuthViaAccessTokenOfSocialNetwork_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function StartAuth_HttpRequestComplete

1void StartAuth_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnStartAuthSuccess SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function CompleteAuthByPhoneNumber_HttpRequestComplete

1void CompleteAuthByPhoneNumber_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function CompleteAuthByEmail_HttpRequestComplete

1void CompleteAuthByEmail_HttpRequestComplete(
2    FHttpRequestPtr HttpRequest,
3    FHttpResponsePtr HttpResponse,
4    const bool bSucceeded,
5    FOnAuthUpdate SuccessCallback,
6    FOnAuthError ErrorCallback
7)

function GetAuthConfirmationCode_HttpRequestComplete