User management API for creating user, verifying user, and resetting password. More...
#include <AccelByteUserApi.h>
Public Member Functions | |
| User (Credentials &Credentials, Settings &Settings, FHttpRetrySchedulerBase &InHttpRef, const EntitlementWPtr InEntitlementWeak, const ItemWPtr InItemWeak, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr) | |
| User (Credentials &Credentials, Settings &Settings, FHttpRetrySchedulerBase &InHttpRef, const EntitlementWPtr InEntitlementWeak, const ItemWPtr InItemWeak, FAccelBytePlatformPtr const &InAccelBytePlatform, FString const &InDeviceId=TEXT(""), FString const &InMacAddress=TEXT("")) | |
| DECLARE_DELEGATE (FUpgradeNotif) | |
| delegate for handling upgrade headless account notification. | |
| void | FinalPreLoginEvents () |
| These events happen before every login event, such as clearing CredentialRef post-auth info. | |
| FAccelByteTaskWPtr | LoginWithUsername (FString const &Username, FString const &Password, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Log in with email/username account. | |
| FAccelByteTaskWPtr | LoginWithUsername (FString const &Username, FString const &Password, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Log in with email/username account with 2FA enable. | |
| FAccelByteTaskWPtr | LoginWithUsernameV3 (FString const &Username, FString const &Password, FVoidHandler const &OnSuccess, FErrorHandler const &, bool bRememberMe=false) |
| Log in with email/username account using v3 endpoint. | |
| FAccelByteTaskWPtr | LoginWithUsernameV3 (FString const &Username, FString const &Password, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberMe=false) |
| Log in with email/username account using v3 endpoint with 2FA enable. | |
| FAccelByteTaskWPtr | LoginWithUsernameV4 (FString const &Username, FString const &Password, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberMe=false) |
| Log in with email/username account using v4 endpoint with 2FA enable. | |
| FAccelByteTaskWPtr | LoginWithDeviceId (FVoidHandler const &OnSuccess, FErrorHandler const &, bool bCreateHeadless=true) |
| Log in with device ID (anonymous log in). | |
| FAccelByteTaskWPtr | LoginWithDeviceId (FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true) |
| Log in with device ID (anonymous log in). | |
| FAccelByteTaskWPtr | LoginWithDeviceIdV4 (THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true) |
| Log in with device ID (anonymous log in). | |
| FAccelByteTaskWPtr | LoginWithOtherPlatform (EAccelBytePlatformType PlatformType, FString const &PlatformToken, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc. | |
| FAccelByteTaskWPtr | LoginWithOtherPlatform (EAccelBytePlatformType PlatformType, FString const &PlatformToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}) |
| Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc. with 2FA enable. | |
| FAccelByteTaskWPtr | LoginWithOtherPlatformId (FString const &PlatformId, FString const &PlatformToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}) |
| Log in with another platform Id account e.g. Steam, Google, Twitch, etc especially to support OIDC (with 2FA enable). | |
| FAccelByteTaskWPtr | LoginWithOtherPlatformV4 (EAccelBytePlatformType PlatformType, FString const &PlatformToken, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}) |
| Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc. with 2FA enable. | |
| FAccelByteTaskWPtr | LoginWithOtherPlatformIdV4 (FString const &PlatformId, FString const &PlatformToken, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}) |
| Log in with another platform Id account e.g. Steam, Google, Twitch, etc especially to support OIDC (with 2FA enable). | |
| FAccelByteTaskWPtr | LoginWithSimultaneousPlatform (EAccelBytePlatformType NativePlatform, FString const &NativePlatformToken, EAccelBytePlatformType SecondaryPlatform, FString const &SecondaryPlatformToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Login with native platform and secondary platform. Currently support Windows only. | |
| FAccelByteTaskWPtr | LoginWithSimultaneousPlatform (FString const &NativePlatform, FString const &NativePlatformToken, FString const &SecondaryPlatform, FString const &SecondaryPlatformToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Login with native platform and secondary platform. Currently support Windows only. | |
| FAccelByteTaskWPtr | LoginWithSimultaneousPlatformV4 (EAccelBytePlatformType NativePlatform, FString const &NativePlatformToken, EAccelBytePlatformType SecondaryPlatform, FString const &SecondaryPlatformToken, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Login with native platform and secondary platform. Currently support Windows only. | |
| FAccelByteTaskWPtr | LoginWithSimultaneousPlatformV4 (FString const &NativePlatform, FString const &NativePlatformToken, FString const &SecondaryPlatform, FString const &SecondaryPlatformToken, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Login with native platform and secondary platform. Currently support Windows only. | |
| FAccelByteTaskWPtr | VerifyLoginWithNewDevice2FAEnabled (FString const &MfaToken, EAccelByteLoginAuthFactorType AuthFactorType, FString const &Code, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberDevice=false) |
| Verify log in with new device when user enabled 2FA. | |
| FAccelByteTaskWPtr | VerifyLoginWithNewDevice2FAEnabledV4 (FString const &MfaToken, EAccelByteLoginAuthFactorType AuthFactorType, FString const &Code, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberDevice=false) |
| Verify log in with new device when user enabled 2FA. | |
| FAccelByteTaskWPtr | LoginWithLauncher (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Log in from AccelByte Launcher. | |
| FAccelByteTaskWPtr | LoginWithLauncher (FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Log in from AccelByte Launcher. | |
| FAccelByteTaskWPtr | LoginWithLauncherV4 (THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Log in from AccelByte Launcher. | |
| FAccelByteTaskWPtr | LoginWithRefreshToken (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| login with refresh token | |
| FAccelByteTaskWPtr | LoginWithRefreshToken (FString const &RefreshToken, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| login with refresh token | |
| FAccelByteTaskWPtr | LoginWithRefreshToken (FString const &RefreshToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &PlatformUserId=TEXT("")) |
| login with refresh token | |
| FAccelByteTaskWPtr | LoginWithRefreshTokenV4 (THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &RefreshToken=TEXT(""), FString const &PlatformUserId=TEXT("")) |
| login with refresh token | |
| FAccelByteTaskWPtr | RefreshPlatformToken (EAccelBytePlatformType NativePlatform, FString const &NativePlatformToken, THandler< FPlatformTokenRefreshResponse > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token. | |
| FAccelByteTaskWPtr | RefreshPlatformToken (FString const &NativePlatform, FString const &NativePlatformToken, THandler< FPlatformTokenRefreshResponse > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token. | |
| FAccelByteTaskWPtr | TryRelogin (FString const &PlatformUserID, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Relogin using the previously logged-in platform account. WINDOWS ONLY. | |
| FAccelByteTaskWPtr | TryRelogin (FString const &PlatformUserID, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Relogin using the previously logged-in platform account. WINDOWS ONLY. | |
| FAccelByteTaskWPtr | TryReloginV4 (FString const &PlatformUserID, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Relogin using the previously logged-in platform account. WINDOWS ONLY. | |
| FAccelByteTaskWPtr | CreateHeadlessAccountAndLogin (FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Create Headless Account And Login. | |
| FAccelByteTaskWPtr | CreateHeadlessAccountAndLogin (FString const &LinkingToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Create Headless Account And Login. | |
| FAccelByteTaskWPtr | CreateHeadlessAccountAndLoginV4 (THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &LinkingToken=TEXT("")) |
| Create Headless Account And Login. | |
| FAccelByteTaskWPtr | AuthenticationWithPlatformLinkAndLogin (FString const &Username, FString const &Password, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Authentication With Platform Link And Login. | |
| FAccelByteTaskWPtr | AuthenticationWithPlatformLinkAndLogin (FString const &Username, FString const &Password, FString const &LinkingToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Authentication With Platform Link And Login. | |
| FAccelByteTaskWPtr | AuthenticationWithPlatformLinkAndLoginV4 (FString const &Username, FString const &Password, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &LinkingToken=TEXT("")) |
| Authentication With Platform Link And Login. | |
| FAccelByteTaskWPtr | ClaimAccessToken (FString const &LoginTicket, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| Claim Access Token using Login Ticket. | |
| FAccelByteTaskWPtr | Logout (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| [DEPRECATED] Log out current user session. Access tokens, user ID, and other credentials from memory will be removed. | |
| FAccelByteTaskWPtr | LogoutV3 (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Log out current user session. Access tokens, user ID, and other credentials from memory will be removed. | |
| void | ForgetAllCredentials () |
| Remove access tokens, user ID, and other credentials from memory. | |
| FAccelByteTaskWPtr | Register (FString const &Username, FString const &Password, FString const &DisplayName, FString const &Country, FString const &DateOfBirth, THandler< FRegisterResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &UniqueDisplayName=TEXT(""), FString const &Code=TEXT("")) |
| This function will register a new user with email-based account. | |
| FAccelByteTaskWPtr | Registerv2 (FString const &EmailAddress, FString const &Username, FString const &Password, FString const &DisplayName, FString const &Country, FString const &DateOfBirth, THandler< FRegisterResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &UniqueDisplayName=TEXT(""), FString const &Code=TEXT("")) |
| This function will register a new user with email-based account. | |
| FAccelByteTaskWPtr | Registerv3 (FRegisterRequestv3 const &RegisterRequest, THandler< FRegisterResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function will register a new user with email-based account and complete agreement. | |
| FAccelByteTaskWPtr | GetData (THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError, bool bIncludeAllPlatforms=false) |
| This function will get data of currently logged in user. | |
| FAccelByteTaskWPtr | GetUserBanHistory (THandler< FGetUserBansResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get the current user's ban history in detail. | |
| FAccelByteTaskWPtr | GetUserBanHistory (FGetUserBanHistoryOptionalParams const &OptionalParameter, THandler< FGetUserBansResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get the current user's ban history in detail. | |
| FAccelByteTaskWPtr | Upgrade (FString const &Username, FString const &Password, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError, bool bNeedVerificationCode=false) |
| This function will upgrade user's headless account. You may call SendUserAccountVerificationCode afterwards. Headless account is an account that doesn't have an email and password. If user logs in with a device/platform and they cannot login with email-and-password, their account is considered as a headless account. Therefore, the function requests user’s Username and Password for parameters. | |
| FAccelByteTaskWPtr | Upgradev2 (FString const &EmailAddress, FString const &Username, FString const &Password, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError) |
| This function will upgrade user's headless account. You may call SendUserAccountVerificationCode afterwards. Headless account is an account that doesn't have an email and password. If user logs in with a device/platform and they cannot login with email-and-password, their account is considered as a headless account. Therefore, the function requests user’s Username and Password for parameters. | |
| FAccelByteTaskWPtr | SendVerificationCode (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Verify user's email. User should login with email and password first to get access token. | |
| FAccelByteTaskWPtr | Verify (FString const &VerificationCode, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function will verify the registered email after user receives verification code sent with ::SendUserAccountVerificationCode() to their email. | |
| FAccelByteTaskWPtr | SendResetPasswordCode (FString const &EmailAddress, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Send a request to reset user's password. For some reason the endpoint uses HTTP basic authentication instead of bearer, because you know... our IAM is very inconsistent. | |
| FAccelByteTaskWPtr | ResetPassword (FString const &VerificationCode, FString const &EmailAddress, FString const &NewPassword, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Reset user's password with sent verification code. | |
| FAccelByteTaskWPtr | SendUpgradeVerificationCode (FString const &EmailAddress, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function should be done before user upgrade their headless account. After this function successfully called, obtain the verification code from the submitted email. Then call UpgradeHeadlessAccountWithVerificationCode function afterwards. | |
| FAccelByteTaskWPtr | SendUpdateEmailVerificationCode (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Send request verification code with Change email context. User should login with email and password first to get access token. | |
| FAccelByteTaskWPtr | UpgradeAndVerify (FString const &Username, FString const &Password, FString const &VerificationCode, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError, FString const &UniqueDisplayName=TEXT("")) |
| This function should be called after you call SendUserUpgradeVerificationCode and obtain verification code. | |
| FAccelByteTaskWPtr | UpgradeAndVerify2 (FUpgradeAndVerifyRequest const &UpgradeAndVerifyRequest, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError) |
| This function should be called after you call SendUpgradeVerificationCode and obtain verification code. | |
| FAccelByteTaskWPtr | GetPlatformLinks (THandler< FPagedPlatformLinks > const &OnSuccess, FErrorHandler const &OnError) |
| This function gets user's platform accounts linked to user’s account. | |
| FAccelByteTaskWPtr | LinkOtherPlatform (EAccelBytePlatformType PlatformType, FString const &Ticket, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| This function links user's current account to their other account in other platform. Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL (e.g. Facebook, Google, Twitch platform). The browser will redirect the URL to a site with a code in form of parameter URL. | |
| FAccelByteTaskWPtr | LinkOtherPlatform (EAccelBytePlatformType PlatformType, FString const &Ticket, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function links user's current account to their other account in other platform. Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL (e.g. Facebook, Google, Twitch platform). The browser will redirect the URL to a site with a code in form of parameter URL. | |
| FAccelByteTaskWPtr | LinkOtherPlatformId (FString const &PlatformId, FString const &Ticket, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function links user's current account to their other account in other platform, especially to support OIDC Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL The browser will redirect the URL to a site with a code in form of parameter URL. | |
| FAccelByteTaskWPtr | ForcedLinkOtherPlatform (EAccelBytePlatformType PlatformType, FString const &PlatformUserId, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| This function forced links user's current account to their other account in other platform. Use this only if the general LinkOtherPlatform get conflicted and getting confirmation from user. | |
| FAccelByteTaskWPtr | ForcedLinkOtherPlatform (EAccelBytePlatformType PlatformType, FString const &PlatformUserId, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function forced links user's current account to their other account in other platform. Use this only if the general LinkOtherPlatform get conflicted and getting confirmation from user. | |
| FAccelByteTaskWPtr | UnlinkOtherPlatform (EAccelBytePlatformType PlatformType, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function unlinks user's current account from their other account in other platform. | |
| FAccelByteTaskWPtr | UnlinkOtherPlatform (EAccelBytePlatformType PlatformType, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function unlinks user's current account from their other account in other platform. | |
| FAccelByteTaskWPtr | UnlinkOtherPlatformId (FString const &PlatformId, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function unlinks user's current account from their other account in other platform, especially to support OIDC. | |
| FAccelByteTaskWPtr | UnlinkAllOtherPlatform (EAccelBytePlatformType PlatformType, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function unlinks all the user's current account from their other accounts in other platforms. | |
| FAccelByteTaskWPtr | UnlinkAllOtherPlatformId (FString const &PlatformId, FVoidHandler const &OnSuccess, FCustomErrorHandler const &OnError) |
| This function unlinks all the user's current account from their other accounts in other platforms, especially to support OIDC. | |
| FAccelByteTaskWPtr | SearchUsers (FString const &Query, THandler< FPagedPublicUsersInfo > const &OnSuccess, FErrorHandler const &OnError) |
| This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name. | |
| FAccelByteTaskWPtr | SearchUsers (FString const &Query, int32 Offset, int32 Limit, THandler< FPagedPublicUsersInfo > const &OnSuccess, FErrorHandler const &OnError) |
| This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name. | |
| FAccelByteTaskWPtr | SearchUsers (FString const &Query, EAccelBytePlatformType PlatformType, EAccelByteSearchPlatformType PlatformBy, THandler< FPagedPublicUsersInfo > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=100) |
| This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name. | |
| FAccelByteTaskWPtr | SearchUsers (FString const &Query, FString const &PlatformId, EAccelByteSearchPlatformType PlatformBy, THandler< FPagedPublicUsersInfo > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=100) |
| Searches for users on third-party platforms using their Username or Display Name. This function specifically targets users on platforms and utilizes the platform's DisplayName for the search. | |
| FAccelByteTaskWPtr | SearchUsers (FString const &Query, EAccelByteSearchType By, THandler< FPagedPublicUsersInfo > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=100, FString const &PlatformId=TEXT(""), EAccelByteSearchPlatformType PlatformBy=EAccelByteSearchPlatformType::NONE) |
| Searches for users on third-party platforms using their Username or Display Name. This function specifically targets users on platforms and utilizes the platform's DisplayName for the search. | |
| FAccelByteTaskWPtr | GetUserByUserId (FString const &UserId, THandler< FSimpleUserData > const &OnSuccess, FErrorHandler const &OnError) |
| DEPRECATED: This function is no longer supported and will be removed in future releases. This function will search user by UserId and the endpoint version is V3. | |
| FAccelByteTaskWPtr | GetUserPublicInfoByOtherPlatformUserId (EAccelBytePlatformType PlatformType, FString const &OtherPlatformUserId, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get user by other platform user id it linked to. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1. | |
| FAccelByteTaskWPtr | UpdateUser (FUserUpdateRequest const &UpdateRequest, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError) |
| This function for update user account info within the game. | |
| FAccelByteTaskWPtr | UpdateEmail (FUpdateEmailRequest const &UpdateEmailRequest, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function for update user account info within the game. | |
| FAccelByteTaskWPtr | BulkGetUserByOtherPlatformUserIds (EAccelBytePlatformType PlatformType, TArray< FString > const &OtherPlatformUserId, THandler< FBulkPlatformUserIdResponse > const &OnSuccess, FErrorHandler const &OnError, bool bRawPuid=false) |
| This function will get user(s) by other platform user id(s) it linked to. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1. | |
| FAccelByteTaskWPtr | BulkGetUserByOtherPlatformUserIdsV4 (EAccelBytePlatformType PlatformType, TArray< FString > const &OtherPlatformUserId, THandler< FBulkPlatformUserIdResponse > const &OnSuccess, FErrorHandler const &OnError, bool bRawPuid=false, const EAccelBytePidType &PidType=EAccelBytePidType::NONE) |
| This function will get user(s) by other platform user id(s) it linked to. maximum users to be queried is 100 userIds if more than 100 userIds is queried, only first 100 will be returned. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1. | |
| FAccelByteTaskWPtr | GetCountryFromIP (THandler< FCountryInfo > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get country information from user's IP. | |
| FAccelByteTaskWPtr | GetUserEligibleToPlay (THandler< bool > const &OnSuccess, FErrorHandler const &OnError) |
| This function will check whether user can play the game by having it purchased or subscribed. | |
| FAccelByteTaskWPtr | GetInputValidations (FString const &LanguageCode, THandler< FInputValidation > const &OnSuccess, FErrorHandler const &OnError, bool bDefaultOnEmpty=true) |
| This function will get user input validation. | |
| FAccelByteTaskWPtr | ValidateUserInput (FUserInputValidationRequest const &UserInputValidationRequest, THandler< FUserInputValidationResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function will validate user's input This endpoint will check the input validation with profanity filter service Call this endpoint GetInputValidations To check the profanity filter enablement. | |
| FAccelByteTaskWPtr | Enable2FaBackupCode (THandler< FUser2FaBackupCode > const &OnSuccess, FErrorHandler const &OnError) |
| This function will enable 2FA with backupCode. | |
| FAccelByteTaskWPtr | Disable2FaBackupCode (FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FDisableMfaBackupCodeRequest const &Request={}) |
| This function will disable 2FA with backupCode. | |
| FAccelByteTaskWPtr | GenerateBackupCode (THandler< FUser2FaBackupCode > const &OnSuccess, FErrorHandler const &OnError) |
| This function will generate backupCode. | |
| FAccelByteTaskWPtr | GetBackupCode (THandler< FUser2FaBackupCode > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get backupCode. | |
| FAccelByteTaskWPtr | Enable2FaAuthenticator (FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FString const &Code=TEXT("")) |
| This function will enable 3rd party authenticator. | |
| FAccelByteTaskWPtr | Disable2FaAuthenticator (FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FDisableMfaAuthenticatorRequest const &Request={}) |
| This function will disable 3rd party authenticator. | |
| FAccelByteTaskWPtr | GenerateSecretKeyFor2FaAuthenticator (THandler< FUser2FaSecretKey > const &OnSuccess, FErrorHandler const &OnError) |
| This function will generate secret key for linking AB 2fa with 3rd party authenticator apps. | |
| FAccelByteTaskWPtr | GetEnabled2FaFactors (THandler< FUser2FaMethod > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get user 2FA factor enabled. | |
| FAccelByteTaskWPtr | MakeDefault2FaFactors (EAccelByteLoginAuthFactorType AuthFactorType, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function will make default factor for 2FA. | |
| FAccelByteTaskWPtr | UpdateUserV3 (FUserUpdateRequest const &UpdateRequest, THandler< FAccountUserData > const &OnSuccess, FErrorHandler const &OnError) |
| DEPRECATED: This function is no longer supported and will be removed in future releases. This function for update user account info within the game. | |
| FAccelByteTaskWPtr | GetPublisherUser (FString const &UserId, THandler< FGetPublisherUserResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function for getting publisher user. | |
| FAccelByteTaskWPtr | VerifyToken (FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function for OAuth2 token verification API. | |
| FAccelByteTaskWPtr | GetUserInformation (FString const &UserId, THandler< FGetUserInformationResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function for getting user information . | |
| FAccelByteTaskWPtr | GenerateOneTimeCode (EAccelBytePlatformType PlatformType, THandler< FGeneratedOneTimeCode > const &OnSuccess, FErrorHandler const &OnError) |
| This function for generating one time code. | |
| FAccelByteTaskWPtr | GenerateGameToken (FString const &Code, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError) |
| This function for generate publisher user's game token. required a code from request game token. | |
| FAccelByteTaskWPtr | GenerateGameTokenV4 (FString const &Code, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| This function for generate publisher user's game token. required a code from request game token. | |
| FAccelByteTaskWPtr | GenerateCodeForPublisherTokenExchange (FString const &PublisherClientID, THandler< FCodeForTokenExchangeResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function generate a code that can be exchanged into publisher namespace token (i.e. by web portal). | |
| FAccelByteTaskWPtr | LinkHeadlessAccountToCurrentFullAccount (FLinkHeadlessAccountRequest const &Request, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| This function for link headless account to current full account. | |
| FAccelByteTaskWPtr | GetConflictResultWhenLinkHeadlessAccountToFullAccount (FString const &OneTimeLinkCode, THandler< FConflictLinkHeadlessAccountResult > const &OnSuccess, FErrorHandler const &OnError) |
| This function to get conflict result when link headless account to current account by one time code. | |
| FAccelByteTaskWPtr | CheckUserAccountAvailability (FString const &DisplayName, FVoidHandler const &OnSuccess, FErrorHandler const &OnError, bool bIsCheckUniqueDisplayName=false) |
| Check users's account availability, available only using displayName field If the result is success or no error, it means the account already exists. If a new account is added with the defined display name, the service will be unable to perform the action. | |
| FAccelByteTaskWPtr | RetrieveUserThirdPartyPlatformToken (EAccelBytePlatformType PlatformType, THandler< FThirdPartyPlatformTokenData > const &OnSuccess, FOAuthErrorHandler const &OnError) |
| This function is used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members. Note: The third party platform and platform group covered for this is: (psn) ps4web, (psn) ps4, (psn) ps5, epicgames, twitch, awscognito. | |
| FAccelByteTaskWPtr | GetUserOtherPlatformBasicPublicInfo (FPlatformAccountInfoRequest const &Request, THandler< FAccountUserPlatformInfosResponse > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get user basic and public info of 3rd party account. | |
| FAccelByteTaskWPtr | GetUserPublicInfoByUserId (FString const &UserID, THandler< FUserPublicInfoResponseV4 > const &OnSuccess, FErrorHandler const &OnError) |
| This function will get user public information the specified UserID. This endpoint version is V4. | |
| FAccelByteTaskWPtr | GetAccountConfigurationValue (EAccountConfiguration AccountConfiguration, THandler< bool > const &OnSuccess, FErrorHandler const &OnError) |
| A request to retrieve such of information related to the current account configuration value. | |
| FAccelByteTaskWPtr | GetPublicSystemConfigValue (THandler< FIAMPublicSystemConfigResponse > const &OnSuccess, FErrorHandler const &OnError) |
| A request to public system configuration values. | |
| FAccelByteTaskWPtr | UpdatePassword (FUpdatePasswordRequest const &Request, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Update current user password. | |
| FAccelByteTaskWPtr | EnableMfaEmail (FString const &Code, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Enable multi-factor authentication with email. | |
| FAccelByteTaskWPtr | DisableMfaEmail (FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FDisableMfaEmailRequest const &Request={}) |
| Disable multi-factor authentication with email. | |
| FAccelByteTaskWPtr | SendMfaCodeToEmail (const EAccelByteSendMfaEmailAction Action, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Send multi-factor authentication code to email. | |
| FAccelByteTaskWPtr | GetMfaStatus (THandler< FMfaStatusResponse > const &OnSuccess, FErrorHandler const &OnError) |
| Get multi-factor authentication status for current user. | |
| FAccelByteTaskWPtr | VerifyMfaCode (EAccelByteLoginAuthFactorType const &Factor, FString const &Code, THandler< FVerifyMfaResponse > const &OnSuccess, FErrorHandler const &OnError) |
| Verify code from MFA to retrieve MFA Token. | |
| FAccelByteTaskWPtr | SendVerificationCodeToNewUser (FSendVerificationCodeToNewUserRequest const &Request, FVoidHandler const &OnSuccess, FErrorHandler const &OnError) |
| Send verification code to new unregistered account's email address. | |
| bool | IsTokenExpired (FRefreshInfo RefreshInfo) |
| 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 |
User management API for creating user, verifying user, and resetting password.
| FAccelByteTaskWPtr AccelByte::Api::User::AuthenticationWithPlatformLinkAndLogin | ( | FString const & | Username, |
| FString const & | Password, | ||
| FString const & | LinkingToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Authentication With Platform Link And Login.
| Username | Username/user's email that will be validated. |
| Password | This is password's account exist |
| LinkingToken | Specified Linking token |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::AuthenticationWithPlatformLinkAndLogin | ( | FString const & | Username, |
| FString const & | Password, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Authentication With Platform Link And Login.
| Username | Username/user's email that will be validated. |
| Password | This is password's account exist |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::AuthenticationWithPlatformLinkAndLoginV4 | ( | FString const & | Username, |
| FString const & | Password, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| FString const & | LinkingToken = TEXT("") ) |
Authentication With Platform Link And Login.
| Username | Username/user's email that will be validated. |
| Password | This is password's account exist |
| LinkingToken | Specified Linking token |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::BulkGetUserByOtherPlatformUserIds | ( | EAccelBytePlatformType | PlatformType, |
| TArray< FString > const & | OtherPlatformUserId, | ||
| THandler< FBulkPlatformUserIdResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bRawPuid = false ) |
This function will get user(s) by other platform user id(s) it linked to. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1.
| PlatformType | Other platform type. |
| OtherPlatformUserId | Targeted user's ID(s). |
| OnSuccess | This will be called when the operation succeeded. The result is FBulkPlatformUserIdResponse. |
| OnError | This will be called when the operation failed. |
| bRawPuid | Show unencrypted platform user id in result (disabled by default). |
| FAccelByteTaskWPtr AccelByte::Api::User::BulkGetUserByOtherPlatformUserIdsV4 | ( | EAccelBytePlatformType | PlatformType, |
| TArray< FString > const & | OtherPlatformUserId, | ||
| THandler< FBulkPlatformUserIdResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bRawPuid = false, | ||
| const EAccelBytePidType & | PidType = EAccelBytePidType::NONE ) |
This function will get user(s) by other platform user id(s) it linked to. maximum users to be queried is 100 userIds if more than 100 userIds is queried, only first 100 will be returned. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1.
| PlatformType | Other platform type. |
| OtherPlatformUserId | Targeted user's ID(s). |
| OnSuccess | This will be called when the operation succeeded. The result is FBulkPlatformUserIdResponse. |
| OnError | This will be called when the operation failed. |
| bRawPuid | Show unencrypted platform user id in result (disabled by default). |
| PidType | The type of platform user id (some platforms have different user id type for a given user, such as org scoped id or app scoped id). |
| FAccelByteTaskWPtr AccelByte::Api::User::CheckUserAccountAvailability | ( | FString const & | DisplayName, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bIsCheckUniqueDisplayName = false ) |
Check users's account availability, available only using displayName field If the result is success or no error, it means the account already exists. If a new account is added with the defined display name, the service will be unable to perform the action.
| DisplayName | User's display name value to be checked. |
| OnSuccess | This will be called when the operation succeeded. The result is FVoidHandler |
| OnError | This will be called when the operation failed. |
| bIsCheckUniqueDisplayName | Check user availability by unique display name. Default as false. |
| FAccelByteTaskWPtr AccelByte::Api::User::ClaimAccessToken | ( | FString const & | LoginTicket, |
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Claim Access Token using Login Ticket.
| LoginTicket | Login Ticket to claim the access token |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::CreateHeadlessAccountAndLogin | ( | FString const & | LinkingToken, |
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Create Headless Account And Login.
| LinkingToken | LinkingToken |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::CreateHeadlessAccountAndLogin | ( | FVoidHandler const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError ) |
Create Headless Account And Login.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::CreateHeadlessAccountAndLoginV4 | ( | THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError, | ||
| FString const & | LinkingToken = TEXT("") ) |
Create Headless Account And Login.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| LinkingToken | LinkingToken |
| FAccelByteTaskWPtr AccelByte::Api::User::Disable2FaAuthenticator | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| FDisableMfaAuthenticatorRequest const & | Request = {} ) |
This function will disable 3rd party authenticator.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| Request | [Optional] Token retrieved from multi-factor authentication challenge. Only needed if multi-factor authentication is enabled. |
| FAccelByteTaskWPtr AccelByte::Api::User::Disable2FaBackupCode | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| FDisableMfaBackupCodeRequest const & | Request = {} ) |
This function will disable 2FA with backupCode.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| Request | [Optional] Token retrieved from multi-factor authentication challenge. Only needed if multi-factor authentication is enabled. |
| FAccelByteTaskWPtr AccelByte::Api::User::DisableMfaEmail | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| FDisableMfaEmailRequest const & | Request = {} ) |
Disable multi-factor authentication with email.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| Request | [Optional] Token retrieved from multi-factor authentication challenge. Only needed if multi-factor authentication is enabled. |
| FAccelByteTaskWPtr AccelByte::Api::User::Enable2FaAuthenticator | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| FString const & | Code = TEXT("") ) |
This function will enable 3rd party authenticator.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| Code | The code generated by authenticator app. |
| FAccelByteTaskWPtr AccelByte::Api::User::Enable2FaBackupCode | ( | THandler< FUser2FaBackupCode > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will enable 2FA with backupCode.
| OnSuccess | This will be called when the operation succeeded. The result is FUser2FaBackupCode. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::EnableMfaEmail | ( | FString const & | Code, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Enable multi-factor authentication with email.
| Code | Verification code received from user email. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| void AccelByte::Api::User::FinalPreLoginEvents | ( | ) |
These events happen before every login event, such as clearing CredentialRef post-auth info.
| FAccelByteTaskWPtr AccelByte::Api::User::ForcedLinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | PlatformUserId, | ||
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function forced links user's current account to their other account in other platform. Use this only if the general LinkOtherPlatform get conflicted and getting confirmation from user.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| PlatformUserId | The UserId from the other platfrom you want to link. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::ForcedLinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | PlatformUserId, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
This function forced links user's current account to their other account in other platform. Use this only if the general LinkOtherPlatform get conflicted and getting confirmation from user.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| PlatformUserId | The UserId from the other platfrom you want to link. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateBackupCode | ( | THandler< FUser2FaBackupCode > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will generate backupCode.
| OnSuccess | This will be called when the operation succeeded. The result is FUser2FaBackupCode. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateCodeForPublisherTokenExchange | ( | FString const & | PublisherClientID, |
| THandler< FCodeForTokenExchangeResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function generate a code that can be exchanged into publisher namespace token (i.e. by web portal).
| PublisherClientID | The targeted game's publisher ClientID. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateGameToken | ( | FString const & | Code, |
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
This function for generate publisher user's game token. required a code from request game token.
| Code | code from request game token.. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateGameTokenV4 | ( | FString const & | Code, |
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
This function for generate publisher user's game token. required a code from request game token.
| Code | code from request game token.. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateOneTimeCode | ( | EAccelBytePlatformType | PlatformType, |
| THandler< FGeneratedOneTimeCode > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for generating one time code.
| PlatformType | Specify platform type that chosen by user to log in. |
| OnSuccess | This will be called when the operation succeeded. The result is FGeneratedOneTimeCode. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GenerateSecretKeyFor2FaAuthenticator | ( | THandler< FUser2FaSecretKey > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will generate secret key for linking AB 2fa with 3rd party authenticator apps.
| OnSuccess | This will be called when the operation succeeded. The result is FUser2FaSecretKey. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetAccountConfigurationValue | ( | EAccountConfiguration | AccountConfiguration, |
| THandler< bool > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
A request to retrieve such of information related to the current account configuration value.
| AccountConfiguration | Target account configuration key to retrieve the information. |
| OnSuccess | This will be called when the operation succeeded. The result is bool. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetBackupCode | ( | THandler< FUser2FaBackupCode > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will get backupCode.
| OnSuccess | This will be called when the operation succeeded. The result is FUser2FaBackupCode. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetConflictResultWhenLinkHeadlessAccountToFullAccount | ( | FString const & | OneTimeLinkCode, |
| THandler< FConflictLinkHeadlessAccountResult > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function to get conflict result when link headless account to current account by one time code.
| OneTimeLinkCode | One time link code value. |
| OnSuccess | This will be called when the operation succeeded. The result is THandler<FConflictLinkHeadlessAccountResult>& |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetCountryFromIP | ( | THandler< FCountryInfo > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will get country information from user's IP.
| OnSuccess | This will be called when the operation succeeded. The result is FCountryInfo. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetData | ( | THandler< FAccountUserData > const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| bool | bIncludeAllPlatforms = false ) |
This function will get data of currently logged in user.
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| bIncludeAllPlatforms | This will return all 3rd party platform accounts linked to account. Default is False |
| FAccelByteTaskWPtr AccelByte::Api::User::GetEnabled2FaFactors | ( | THandler< FUser2FaMethod > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will get user 2FA factor enabled.
| OnSuccess | This will be called when the operation succeeded. The result is FUser2FaMethod. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetInputValidations | ( | FString const & | LanguageCode, |
| THandler< FInputValidation > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bDefaultOnEmpty = true ) |
This function will get user input validation.
| LanguageCode | Targeted Language Code, using ISO-639 |
| OnSuccess | This will be called when the operation succeeded. The result is FInputUserValidation. |
| OnError | This will be called when the operation failed. |
| bDefaultOnEmpty | Targeted DefaultOnEmpty. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetMfaStatus | ( | THandler< FMfaStatusResponse > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
Get multi-factor authentication status for current user.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetPlatformLinks | ( | THandler< FPagedPlatformLinks > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function gets user's platform accounts linked to user’s account.
| OnSuccess | This will be called when the operation succeeded. The res |
| FAccelByteTaskWPtr AccelByte::Api::User::GetPublicSystemConfigValue | ( | THandler< FIAMPublicSystemConfigResponse > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
A request to public system configuration values.
| OnSuccess | This will be called when the operation succeeded. The result is FIAMPublicSystemConfigResponse. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetPublisherUser | ( | FString const & | UserId, |
| THandler< FGetPublisherUserResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for getting publisher user.
| UserId | Targeted User ID. |
| OnSuccess | This will be called when the operation succeeded. The result is FGetPublisherUserResponse. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserBanHistory | ( | FGetUserBanHistoryOptionalParams const & | OptionalParameter, |
| THandler< FGetUserBansResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will get the current user's ban history in detail.
| OptionalParameter | Optional parameters that can be set. |
| OnSuccess | This will be called when the operation succeeded. The result is FGetUserBansResponse |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserBanHistory | ( | THandler< FGetUserBansResponse > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will get the current user's ban history in detail.
| OnSuccess | This will be called when the operation succeeded. The result is FGetUserBansResponse |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserByUserId | ( | FString const & | UserId, |
| THandler< FSimpleUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
DEPRECATED: This function is no longer supported and will be removed in future releases. This function will search user by UserId and the endpoint version is V3.
| UserId | Targeted user's ID. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserEligibleToPlay | ( | THandler< bool > const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function will check whether user can play the game by having it purchased or subscribed.
| OnSuccess | This will be called when the operation succeeded. The result is boolean. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserInformation | ( | FString const & | UserId, |
| THandler< FGetUserInformationResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for getting user information .
| UserId | Targeted User ID. |
| OnSuccess | This will be called when the operation succeeded. The result is FGetUserInformationResponse. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserOtherPlatformBasicPublicInfo | ( | FPlatformAccountInfoRequest const & | Request, |
| THandler< FAccountUserPlatformInfosResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will get user basic and public info of 3rd party account.
| Request | Request struct containing chosen platformId and userIds. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserPlatformInfos. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserPublicInfoByOtherPlatformUserId | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | OtherPlatformUserId, | ||
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will get user by other platform user id it linked to. Note : For Nintendo Login you have to add Environment ID Suffix behind platform id with PlatformID:EnvironmentID as format e.g csg123jskansdk:dd1.
| PlatformType | Other platform type . |
| OtherPlatformUserId | Targeted user's ID. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::GetUserPublicInfoByUserId | ( | FString const & | UserID, |
| THandler< FUserPublicInfoResponseV4 > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will get user public information the specified UserID. This endpoint version is V4.
| UserID | Targeted user |
| OnSuccess | This will be called when the operation succeeded. The result is FUserPublicInfoResponseV4. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LinkHeadlessAccountToCurrentFullAccount | ( | FLinkHeadlessAccountRequest const & | Request, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for link headless account to current full account.
| Request | Request struct Containing chosen namespace and one time link code. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | Ticket, | ||
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function links user's current account to their other account in other platform. Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL (e.g. Facebook, Google, Twitch platform). The browser will redirect the URL to a site with a code in form of parameter URL.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| Ticket | The Ticket. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | Ticket, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
This function links user's current account to their other account in other platform. Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL (e.g. Facebook, Google, Twitch platform). The browser will redirect the URL to a site with a code in form of parameter URL.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| Ticket | The Ticket. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LinkOtherPlatformId | ( | FString const & | PlatformId, |
| FString const & | Ticket, | ||
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function links user's current account to their other account in other platform, especially to support OIDC Ticket for each platform (PlatformToken) can be obtained from browser with platform linking URL The browser will redirect the URL to a site with a code in form of parameter URL.
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC) |
| Ticket | The Ticket. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithDeviceId | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true ) |
Log in with device ID (anonymous log in).
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithDeviceId | ( | FVoidHandler const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true ) |
Log in with device ID (anonymous log in).
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithDeviceIdV4 | ( | THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true ) |
Log in with device ID (anonymous log in).
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithLauncher | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
Log in from AccelByte Launcher.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithLauncher | ( | FVoidHandler const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError ) |
Log in from AccelByte Launcher.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithLauncherV4 | ( | THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError ) |
Log in from AccelByte Launcher.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | PlatformToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc.
| PlatformType | Specify platform type that chosen by user to log in. |
| PlatformToken | Authentication code that provided by another platform. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | PlatformToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true, | ||
| FAccelByteLoginWithOtherPlatformOptionalParameters | OptionalParams = {} ) |
Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc. with 2FA enable.
| PlatformType | Specify platform type that chosen by user to log in. |
| PlatformToken | Authentication code that provided by another platform. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bCreateHeadless | If directly create new account when not linked yet, default value is true |
| OptionalParams | Will be passed to the backend. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithOtherPlatformId | ( | FString const & | PlatformId, |
| FString const & | PlatformToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true, | ||
| FAccelByteLoginWithOtherPlatformOptionalParameters | OptionalParams = {} ) |
Log in with another platform Id account e.g. Steam, Google, Twitch, etc especially to support OIDC (with 2FA enable).
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC) |
| PlatformToken | Authentication code that provided by another platform. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bCreateHeadless | If directly create new account when not linked yet, default value is true |
| OptionalParams | Will be passed to the backend. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithOtherPlatformIdV4 | ( | FString const & | PlatformId, |
| FString const & | PlatformToken, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true, | ||
| FAccelByteLoginWithOtherPlatformOptionalParameters | OptionalParams = {} ) |
Log in with another platform Id account e.g. Steam, Google, Twitch, etc especially to support OIDC (with 2FA enable).
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC) |
| PlatformToken | Authentication code that provided by another platform. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bCreateHeadless | If directly create new account when not linked yet, default value is true |
| OptionalParams | Will be passed to the backend. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithOtherPlatformV4 | ( | EAccelBytePlatformType | PlatformType, |
| FString const & | PlatformToken, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bCreateHeadless = true, | ||
| FAccelByteLoginWithOtherPlatformOptionalParameters | OptionalParams = {} ) |
Log in with another platform account e.g. Steam, Google, Facebook, Twitch, etc. with 2FA enable.
| PlatformType | Specify platform type that chosen by user to log in. |
| PlatformToken | Authentication code that provided by another platform. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bCreateHeadless | If directly create new account when not linked yet, default value is true |
| OptionalParams | Will be passed to the backend. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithRefreshToken | ( | FString const & | RefreshToken, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
login with refresh token
| RefreshToken | the refresh token for login. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithRefreshToken | ( | FString const & | RefreshToken, |
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| FString const & | PlatformUserId = TEXT("") ) |
login with refresh token
| RefreshToken | the refresh token for login. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| PlatformUserId | Target platform user id to cache. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithRefreshToken | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
login with refresh token
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithRefreshTokenV4 | ( | THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, |
| FOAuthErrorHandler const & | OnError, | ||
| FString const & | RefreshToken = TEXT(""), | ||
| FString const & | PlatformUserId = TEXT("") ) |
login with refresh token
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| RefreshToken | the refresh token for login. |
| PlatformUserId | Target platform user id to cache. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithSimultaneousPlatform | ( | EAccelBytePlatformType | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| EAccelBytePlatformType | SecondaryPlatform, | ||
| FString const & | SecondaryPlatformToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Login with native platform and secondary platform. Currently support Windows only.
| NativePlatform | From the native subsystem |
| NativePlatformToken | The auth ticket from native identity interface |
| SecondaryPlatform | From the secondary platform subsystem |
| SecondaryPlatformToken | The auth ticket from secondary platform interface |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithSimultaneousPlatform | ( | FString const & | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| FString const & | SecondaryPlatform, | ||
| FString const & | SecondaryPlatformToken, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Login with native platform and secondary platform. Currently support Windows only.
| NativePlatform | From the native subsystem |
| NativePlatformToken | The auth ticket from native identity interface |
| SecondaryPlatform | From the secondary platform subsystem |
| SecondaryPlatformToken | The auth ticket from secondary platform interface |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithSimultaneousPlatformV4 | ( | EAccelBytePlatformType | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| EAccelBytePlatformType | SecondaryPlatform, | ||
| FString const & | SecondaryPlatformToken, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Login with native platform and secondary platform. Currently support Windows only.
| NativePlatform | From the native subsystem |
| NativePlatformToken | The auth ticket from native identity interface |
| SecondaryPlatform | From the secondary platform subsystem |
| SecondaryPlatformToken | The auth ticket from secondary platform interface |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithSimultaneousPlatformV4 | ( | FString const & | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| FString const & | SecondaryPlatform, | ||
| FString const & | SecondaryPlatformToken, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Login with native platform and secondary platform. Currently support Windows only.
| NativePlatform | From the native subsystem |
| NativePlatformToken | The auth ticket from native identity interface |
| SecondaryPlatform | From the secondary platform subsystem |
| SecondaryPlatformToken | The auth ticket from secondary platform interface |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithUsername | ( | FString const & | Username, |
| FString const & | Password, | ||
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Log in with email/username account.
| Username | User email address or username. |
| Password | Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithUsername | ( | FString const & | Username, |
| FString const & | Password, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Log in with email/username account with 2FA enable.
| Username | User email address or username. |
| Password | Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithUsernameV3 | ( | FString const & | Username, |
| FString const & | Password, | ||
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bRememberMe = false ) |
Log in with email/username account using v3 endpoint.
| Username | User email address or username. |
| Password | Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bRememberMe | This will use for refresh token expiration extension, default value is false. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithUsernameV3 | ( | FString const & | Username, |
| FString const & | Password, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bRememberMe = false ) |
Log in with email/username account using v3 endpoint with 2FA enable.
| Username | User email address or username. |
| Password | Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bRememberMe | This will use for refresh token expiration extension, default value is false. |
| FAccelByteTaskWPtr AccelByte::Api::User::LoginWithUsernameV4 | ( | FString const & | Username, |
| FString const & | Password, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bRememberMe = false ) |
Log in with email/username account using v4 endpoint with 2FA enable.
| Username | User email address or username. |
| Password | Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bRememberMe | This will use for refresh token expiration extension, default value is false. |
| FAccelByteTaskWPtr AccelByte::Api::User::Logout | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
[DEPRECATED] Log out current user session. Access tokens, user ID, and other credentials from memory will be removed.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::LogoutV3 | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
Log out current user session. Access tokens, user ID, and other credentials from memory will be removed.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::MakeDefault2FaFactors | ( | EAccelByteLoginAuthFactorType | AuthFactorType, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will make default factor for 2FA.
| AuthFactorType | AuthFactorType user want to set as default factor |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::RefreshPlatformToken | ( | EAccelBytePlatformType | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| THandler< FPlatformTokenRefreshResponse > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token.
| Platform | The targeted platform to be refreshed. |
| NativePlatformToken | The platform token that will used to refresh IAM storage. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::RefreshPlatformToken | ( | FString const & | NativePlatform, |
| FString const & | NativePlatformToken, | ||
| THandler< FPlatformTokenRefreshResponse > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token.
| Platform | The targeted platform to be refreshed. |
| NativePlatformToken | The platform token that will used to refresh IAM storage. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::Register | ( | FString const & | Username, |
| FString const & | Password, | ||
| FString const & | DisplayName, | ||
| FString const & | Country, | ||
| FString const & | DateOfBirth, | ||
| THandler< FRegisterResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| FString const & | UniqueDisplayName = TEXT(""), | ||
| FString const & | Code = TEXT("") ) |
This function will register a new user with email-based account.
| Username | Email address of the user, can be used as login username. |
| Password | The Password. |
| DisplayName | The DisplayName. |
| Country | User's country, ISO3166-1 alpha-2 two letter, e.g. US. |
| DateOfBirth | User's date of birth, valid values are between 1905-01-01 until current date. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| UniqueDisplayName | If uniqueDisplayNameEnabled config is enabled, this param is required to be filled. |
| Code | If mandatoryEmailVerificationEnabled config is enabled, this param is required. Retrieved from user email. Use SendVerificationCodeToNewUser for sending the code to user email. |
| FAccelByteTaskWPtr AccelByte::Api::User::Registerv2 | ( | FString const & | EmailAddress, |
| FString const & | Username, | ||
| FString const & | Password, | ||
| FString const & | DisplayName, | ||
| FString const & | Country, | ||
| FString const & | DateOfBirth, | ||
| THandler< FRegisterResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| FString const & | UniqueDisplayName = TEXT(""), | ||
| FString const & | Code = TEXT("") ) |
This function will register a new user with email-based account.
| EmailAddress | Email address of the user, can be used as login username. |
| Username | The username can be used as login username, case insensitive, alphanumeric with allowed symbols underscore (_) and dot (.). |
| Password | The Password. |
| DisplayName | The DisplayName. |
| Country | User's country, ISO3166-1 alpha-2 two letter, e.g. US. |
| DateOfBirth | User's date of birth, valid values are between 1905-01-01 until current date. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| UniqueDisplayName | If uniqueDisplayNameEnabled config is enabled, this param is required to be filled. |
| Code | If mandatoryEmailVerificationEnabled config is enabled, this param is required. Retrieved from user email. Use SendVerificationCodeToNewUser for sending the code to user email. |
| FAccelByteTaskWPtr AccelByte::Api::User::Registerv3 | ( | FRegisterRequestv3 const & | RegisterRequest, |
| THandler< FRegisterResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will register a new user with email-based account and complete agreement.
| RegisterRequest | invoke Accepted Policies, EmailAddress, Username, Password, Display Name, Country and Date of Birth |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::ResetPassword | ( | FString const & | VerificationCode, |
| FString const & | EmailAddress, | ||
| FString const & | NewPassword, | ||
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Reset user's password with sent verification code.
SendPasswordResetCode()
| EmailAddress | User email address or phone number. |
| VerificationCode | Code sent to the email address. |
| NewPassword | The new password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::RetrieveUserThirdPartyPlatformToken | ( | EAccelBytePlatformType | PlatformType, |
| THandler< FThirdPartyPlatformTokenData > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
This function is used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members. Note: The third party platform and platform group covered for this is: (psn) ps4web, (psn) ps4, (psn) ps5, epicgames, twitch, awscognito.
| PlatformType | Platform type value. |
| OnSuccess | This will be called when the operation succeeded. The result is FThirdPartyPlatformTokenData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SearchUsers | ( | FString const & | Query, |
| EAccelBytePlatformType | PlatformType, | ||
| EAccelByteSearchPlatformType | PlatformBy, | ||
| THandler< FPagedPublicUsersInfo > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| int32 | Offset = 0, | ||
| int32 | Limit = 100 ) |
This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name.
| Query | Targeted user's Username or Display Name. |
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| PlatformBy | Filter the responded PagedPublicUsersInfo by SearchPlatformType. |
| Offset | Targeted offset query filter. |
| Limit | Targeted limit query filter. |
| OnSuccess | This will be called when the operation succeeded. The result is FPagedPublicUsersInfo. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SearchUsers | ( | FString const & | Query, |
| EAccelByteSearchType | By, | ||
| THandler< FPagedPublicUsersInfo > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| int32 | Offset = 0, | ||
| int32 | Limit = 100, | ||
| FString const & | PlatformId = TEXT(""), | ||
| EAccelByteSearchPlatformType | PlatformBy = EAccelByteSearchPlatformType::NONE ) |
Searches for users on third-party platforms using their Username or Display Name. This function specifically targets users on platforms and utilizes the platform's DisplayName for the search.
| Query | Targeted user's Username or Display Name. |
| By | Filter the responded PagedPublicUsersInfo by SearchType. Choose the SearchType.ALL if you want to be responded with all query type. |
| OnSuccess | This will be called when the operation succeeded. The result is FPagedPublicUsersInfo. |
| OnError | This will be called when the operation failed. |
| Offset | Targeted offset query filter. |
| Limit | Targeted limit query filter. |
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC). |
| PlatformBy | Filter the responded PagedPublicUsersInfo by SearchPlatformType. |
| FAccelByteTaskWPtr AccelByte::Api::User::SearchUsers | ( | FString const & | Query, |
| FString const & | PlatformId, | ||
| EAccelByteSearchPlatformType | PlatformBy, | ||
| THandler< FPagedPublicUsersInfo > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| int32 | Offset = 0, | ||
| int32 | Limit = 100 ) |
Searches for users on third-party platforms using their Username or Display Name. This function specifically targets users on platforms and utilizes the platform's DisplayName for the search.
| Query | Targeted user's Username or Display Name. |
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC). |
| PlatformBy | Filter the responded PagedPublicUsersInfo by SearchPlatformType. |
| Offset | Targeted offset query filter. |
| Limit | Targeted limit query filter. |
| OnSuccess | This will be called when the operation succeeded. The result is FPagedPublicUsersInfo. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SearchUsers | ( | FString const & | Query, |
| int32 | Offset, | ||
| int32 | Limit, | ||
| THandler< FPagedPublicUsersInfo > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name.
| Query | Targeted user's Username or Display Name. |
| Offset | Targeted offset query filter. |
| Limit | Targeted limit query filter. |
| OnSuccess | This will be called when the operation succeeded. The result is FPagedPublicUsersInfo. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SearchUsers | ( | FString const & | Query, |
| THandler< FPagedPublicUsersInfo > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will search user by their Username or Display Name. The query will be used to find the user with the most approximate username or display name.
| Query | Targeted user's Username or Display Name. |
| OnSuccess | This will be called when the operation succeeded. The result is FPagedPublicUsersInfo. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendMfaCodeToEmail | ( | const EAccelByteSendMfaEmailAction | Action, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Send multi-factor authentication code to email.
| Action | Supported action are update password, disable/enable email mfa (use EAccelByteSendMfaEmailAction::DisableMFAEmail for disable/enable). |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendResetPasswordCode | ( | FString const & | EmailAddress, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Send a request to reset user's password. For some reason the endpoint uses HTTP basic authentication instead of bearer, because you know... our IAM is very inconsistent.
| EmailAddress | User email address or phone number. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendUpdateEmailVerificationCode | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
Send request verification code with Change email context. User should login with email and password first to get access token.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendUpgradeVerificationCode | ( | FString const & | EmailAddress, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function should be done before user upgrade their headless account. After this function successfully called, obtain the verification code from the submitted email. Then call UpgradeHeadlessAccountWithVerificationCode function afterwards.
| EmailAddress | Email or phone number that will be used to upgrade the headless account. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendVerificationCode | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
Verify user's email. User should login with email and password first to get access token.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::SendVerificationCodeToNewUser | ( | FSendVerificationCodeToNewUserRequest const & | Request, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Send verification code to new unregistered account's email address.
| Request | The request for sending a new user a verification code to email. |
| OnSuccess | This will be called when the operation succeeded. The result is bool. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::TryRelogin | ( | FString const & | PlatformUserID, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Relogin using the previously logged-in platform account. WINDOWS ONLY.
| PlatformUserID | The user ID that used previously and used . |
| OnSuccess | This will be called when the provided Platform User Account is acknowledged and not expired yet. Continue the session. |
| OnError | This will be called when the Platform User Account that provided is not known yet — OR it existed but already expired. |
| FAccelByteTaskWPtr AccelByte::Api::User::TryRelogin | ( | FString const & | PlatformUserID, |
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Relogin using the previously logged-in platform account. WINDOWS ONLY.
| PlatformUserID | The user ID that used previously and used . |
| OnSuccess | This will be called when the provided Platform User Account is acknowledged and not expired yet. Continue the session. |
| OnError | This will be called when the Platform User Account that provided is not known yet — OR it existed but already expired. |
| FAccelByteTaskWPtr AccelByte::Api::User::TryReloginV4 | ( | FString const & | PlatformUserID, |
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError ) |
Relogin using the previously logged-in platform account. WINDOWS ONLY.
| PlatformUserID | The user ID that used previously and used . |
| OnSuccess | This will be called when the provided Platform User Account is acknowledged and not expired yet. Continue the session. |
| OnError | This will be called when the Platform User Account that provided is not known yet — OR it existed but already expired. |
| FAccelByteTaskWPtr AccelByte::Api::User::UnlinkAllOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function unlinks all the user's current account from their other accounts in other platforms.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UnlinkAllOtherPlatformId | ( | FString const & | PlatformId, |
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function unlinks all the user's current account from their other accounts in other platforms, especially to support OIDC.
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC). |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UnlinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function unlinks user's current account from their other account in other platform.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UnlinkOtherPlatform | ( | EAccelBytePlatformType | PlatformType, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function unlinks user's current account from their other account in other platform.
| PlatformType | The PlatformType (Steam, PS4, Xbox, etc). |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UnlinkOtherPlatformId | ( | FString const & | PlatformId, |
| FVoidHandler const & | OnSuccess, | ||
| FCustomErrorHandler const & | OnError ) |
This function unlinks user's current account from their other account in other platform, especially to support OIDC.
| PlatformId | Specify platform type, string type of this field makes support OpenID Connect (OIDC) |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpdateEmail | ( | FUpdateEmailRequest const & | UpdateEmailRequest, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for update user account info within the game.
| UpdateEmailRequest | Set verify code and new user email address. |
| OnSuccess | This will be called when the operation succeeded. The result is FUserData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpdatePassword | ( | FUpdatePasswordRequest const & | Request, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Update current user password.
| Request | Details for updating password including mfa token, new password and old password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpdateUser | ( | FUserUpdateRequest const & | UpdateRequest, |
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function for update user account info within the game.
| UpdateRequest | The data you want to update. for DateOfBirth, the format is YYYY-MM-DD. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpdateUserV3 | ( | FUserUpdateRequest const & | UpdateRequest, |
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
DEPRECATED: This function is no longer supported and will be removed in future releases. This function for update user account info within the game.
| UpdateRequest | The data you want to update. for DateOfBirth, the format is YYYY-MM-DD. |
| OnSuccess | This will be called when the operation succeeded. The result is FAccountUserData. |
| OnError | This will be called when the operation failed. Please use UpdateUser instead. |
| FAccelByteTaskWPtr AccelByte::Api::User::Upgrade | ( | FString const & | Username, |
| FString const & | Password, | ||
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| bool | bNeedVerificationCode = false ) |
This function will upgrade user's headless account. You may call SendUserAccountVerificationCode afterwards. Headless account is an account that doesn't have an email and password. If user logs in with a device/platform and they cannot login with email-and-password, their account is considered as a headless account. Therefore, the function requests user’s Username and Password for parameters.
| Username | The EmailAddress of the user. |
| Password | The Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bNeedVerificationCode | Will send verification code to email if true, default false. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpgradeAndVerify | ( | FString const & | Username, |
| FString const & | Password, | ||
| FString const & | VerificationCode, | ||
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError, | ||
| FString const & | UniqueDisplayName = TEXT("") ) |
This function should be called after you call SendUserUpgradeVerificationCode and obtain verification code.
| Username | Email or phone number that will be used to upgrade the headless account. |
| Password | User's password. |
| VerificationCode | User's verification code that obtained from email. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| UniqueDisplayName | If uniqueDisplayNameEnabled config is enabled, this param is required to be filled. |
| FAccelByteTaskWPtr AccelByte::Api::User::UpgradeAndVerify2 | ( | FUpgradeAndVerifyRequest const & | UpgradeAndVerifyRequest, |
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function should be called after you call SendUpgradeVerificationCode and obtain verification code.
| UpgradeAndVerifyRequest | contain user data will be used to upgrade the headless account. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::Upgradev2 | ( | FString const & | EmailAddress, |
| FString const & | Username, | ||
| FString const & | Password, | ||
| THandler< FAccountUserData > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will upgrade user's headless account. You may call SendUserAccountVerificationCode afterwards. Headless account is an account that doesn't have an email and password. If user logs in with a device/platform and they cannot login with email-and-password, their account is considered as a headless account. Therefore, the function requests user’s Username and Password for parameters.
| EmailAddress | The EmailAddress of the user. |
| Username | The Username. |
| Password | The Password. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::ValidateUserInput | ( | FUserInputValidationRequest const & | UserInputValidationRequest, |
| THandler< FUserInputValidationResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will validate user's input This endpoint will check the input validation with profanity filter service Call this endpoint GetInputValidations To check the profanity filter enablement.
| UserInputValidationRequest | List of user input validation request |
| OnSuccess | This will be called when the operation succeeded. The result is FUserInputValidationResponse. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::Verify | ( | FString const & | VerificationCode, |
| FVoidHandler const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
This function will verify the registered email after user receives verification code sent with ::SendUserAccountVerificationCode() to their email.
| VerificationCode | The VerificationCode. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::VerifyLoginWithNewDevice2FAEnabled | ( | FString const & | MfaToken, |
| EAccelByteLoginAuthFactorType | AuthFactorType, | ||
| FString const & | Code, | ||
| FVoidHandler const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bRememberDevice = false ) |
Verify log in with new device when user enabled 2FA.
| MfaToken | return from BE when user login with new device and 2FA enabled. |
| AuthFactorType | 2FA factor used. Could be "authenticator" or "backupCode". User should make sure what type used |
| Code | auth code from 3rd party authenticator or backupCode. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bRememberDevice | This will use for refresh token expiration extension, default value is false. |
| FAccelByteTaskWPtr AccelByte::Api::User::VerifyLoginWithNewDevice2FAEnabledV4 | ( | FString const & | MfaToken, |
| EAccelByteLoginAuthFactorType | AuthFactorType, | ||
| FString const & | Code, | ||
| THandler< FAccelByteModelsLoginQueueTicketInfo > const & | OnSuccess, | ||
| FOAuthErrorHandler const & | OnError, | ||
| bool | bRememberDevice = false ) |
Verify log in with new device when user enabled 2FA.
| MfaToken | return from BE when user login with new device and 2FA enabled. |
| AuthFactorType | 2FA factor used. Could be "authenticator" or "backupCode". User should make sure what type used |
| Code | auth code from 3rd party authenticator or backupCode. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| bRememberDevice | This will use for refresh token expiration extension, default value is false. |
| FAccelByteTaskWPtr AccelByte::Api::User::VerifyMfaCode | ( | EAccelByteLoginAuthFactorType const & | Factor, |
| FString const & | Code, | ||
| THandler< FVerifyMfaResponse > const & | OnSuccess, | ||
| FErrorHandler const & | OnError ) |
Verify code from MFA to retrieve MFA Token.
| Factor | Factor used for multi-factor authentication (e.g. email, backup codes or authenticator app). |
| Code | The code received from multi-factor authentication. |
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
| FAccelByteTaskWPtr AccelByte::Api::User::VerifyToken | ( | FVoidHandler const & | OnSuccess, |
| FErrorHandler const & | OnError ) |
This function for OAuth2 token verification API.
| OnSuccess | This will be called when the operation succeeded. |
| OnError | This will be called when the operation failed. |
