#include <OnlineIdentityInterfaceAccelByte.h>
Public Member Functions | |
| FOnlineIdentityAccelByte (FOnlineSubsystemAccelByte *InSubsystem) | |
| virtual bool | Login (int32 LocalUserNum, const FOnlineAccountCredentialsAccelByte &AccountCredentials) |
| virtual bool | Login (int32 LocalUserNum, const FOnlineAccountCredentials &AccountCredentials) override |
| virtual bool | Logout (int32 LocalUserNum) override |
| virtual bool | AutoLogin (int32 LocalUserNum) override |
| virtual TSharedPtr< FUserOnlineAccount > | GetUserAccount (const FUniqueNetId &UserId) const override |
| virtual TArray< TSharedPtr< FUserOnlineAccount > > | GetAllUserAccounts () const override |
| virtual FUniqueNetIdPtr | GetUniquePlayerId (int32 LocalUserNum) const override |
| virtual FUniqueNetIdPtr | CreateUniquePlayerId (uint8 *Bytes, int32 Size) override |
| virtual FUniqueNetIdPtr | CreateUniquePlayerId (const FString &Str) override |
| virtual ELoginStatus::Type | GetLoginStatus (int32 LocalUserNum) const override |
| virtual ELoginStatus::Type | GetLoginStatus (const FUniqueNetId &UserId) const override |
| virtual FString | GetPlayerNickname (int32 LocalUserNum) const override |
| virtual FString | GetPlayerNickname (const FUniqueNetId &UserId) const override |
| virtual FString | GetAuthToken (int32 LocalUserNum) const override |
| virtual void | RevokeAuthToken (const FUniqueNetId &UserId, const FOnRevokeAuthTokenCompleteDelegate &Delegate) override |
| virtual void | GetLinkedAccountAuthToken (int32 LocalUserNum, const FOnGetLinkedAccountAuthTokenCompleteDelegate &Delegate) const override |
| virtual void | GetUserPrivilege (const FUniqueNetId &UserId, EUserPrivileges::Type Privilege, const FOnGetUserPrivilegeCompleteDelegate &Delegate) override |
| virtual FPlatformUserId | GetPlatformUserIdFromUniqueNetId (const FUniqueNetId &UniqueNetId) const override |
| virtual FString | GetAuthType () const override |
| bool | GetLocalUserNum (const FUniqueNetId &NetId, int32 &OutLocalUserNum) const |
| bool | GetLocalUserNumFromPlatformUserId (const FString &PlatformUserId, int32 &OutLocalUserNum) |
| bool | Logout (int32 LocalUserNum, FString Reason) |
| AccelByte::FApiClientPtr | GetApiClient (const FUniqueNetId &UserId) |
| AccelByte::FApiClientPtr | GetApiClient (int32 LocalUserNum) |
| bool | AuthenticateAccelByteServer (const FOnAuthenticateServerComplete &Delegate, int32 LocalUserNum=0) |
| bool | IsServerAuthenticated (int32 LocalUserNum=0) |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnConnectLobbyComplete, bool, const FUniqueNetId &, const FString &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, OnLoginWithOAuthErrorComplete, bool, const FUniqueNetId &, const FErrorOAuthInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLoginComplete, bool, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnSimultaneousLoginComplete, bool, ESimultaneousLoginResult, const FUniqueNetId &, const FErrorOAuthInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLogoutComplete, bool, const FOnlineErrorAccelByte &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnConnectLobbyComplete, bool, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLobbyConnectionClosed, const FUniqueNetId &, int32, const FString &, bool) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLobbyReconnecting, const FUniqueNetId &, int32, const FString &, bool) | |
| DEFINE_ONLINE_PLAYER_DELEGATE (MAX_LOCAL_PLAYERS, AccelByteOnLobbyReconnected) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLobbyReconnectAttempted, const AccelByte::FReconnectAttemptInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLobbyMassiveOutageEvent, const AccelByte::FMassiveOutageInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnPlatformTokenRefreshedComplete, bool, const FPlatformTokenRefreshResponse &, const FName &, const FErrorOAuthInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLoginQueued, const FAccelByteModelsLoginQueueTicketInfo &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLoginQueueCancelComplete, bool, const FOnlineErrorAccelByte &) | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnLoginQueueClaimTicketComplete, bool, const FErrorOAuthInfo &) | |
| bool | ConnectAccelByteLobby (int32 LocalUserNum) |
| void | SetAutoLoginCreateHeadless (bool bInIsAutoLoginCreateHeadless) |
| void | GenerateCodeForPublisherToken (int32 LocalUserNum, const FString &PublisherClientId, FGenerateCodeForPublisherTokenComplete Delegate) |
| This function generate ab code that can be exchanged into publisher namespace token (i.e. by web portal). | |
| bool | RefreshPlatformToken (int32 LocalUserNum) |
| Refresh the native platform token that is stored in the backend. Therefore we can prevent expiration on the backend. Default behavior: this function already registered automatically and follow the schedule of refresh token expiration. To disable this default: | |
| bool | RefreshPlatformToken (int32 LocalUserNum, FName SubsystemName) |
| Refresh the native platform token that is stored in the backend. Therefore we can prevent expiration on the backend. | |
| bool | CancelLoginQueue (int32 LocalUserNum) |
| bool | ClaimLoginQueueTicket (int32 LocalUserNum) |
| void | SetLoginStatus (int32 LocalUserNum, ELoginStatus::Type NewStatus) |
| void | AddAuthenticatedServer (int32 LocalUserNum) |
| void | FinalizeLoginQueueCancel (int32 LoginUserNum) |
| void | InitializeLoginQueue (int32 LoginUserNum, const FString &TicketId) |
| void | FinalizeLoginQueue (int32 LoginUserNum) |
| virtual TSharedPtr< FUserOnlineAccount > | GetUserAccount (int LocalUserNum) const |
| Retrieve User Account information from given Local User. | |
| virtual TSharedPtr< FUserOnlineAccount > | GetUserAccount (const FUniqueNetIdRef &LocalUserId) const |
| Retrieve User Account information from given Local User. | |
| virtual TSharedPtr< FUserOnlineAccount > | GetUserAccount (const FUniqueNetIdPtr &LocalUserId) const |
| Retrieve User Account information from given Local User. | |
| DEFINE_ONLINE_DELEGATE_ONE_PARAM (AccelByteOnLoginQueueCanceledByUser, int32) | |
| bool | VerifyLoginMfa (int32 LocalUserNum, EAccelByteLoginAuthFactorType FactorType, const FString &Code, const FString &MfaToken, bool bRememberDevice=false) |
| Verify user using multifactor authentication. Add handler to AccelByteOnLoginCompleteDelegate for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnUpdatePasswordComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | UpdatePassword (int32 LocalUserNum, const FUpdatePasswordRequest &Request, EAccelByteLoginAuthFactorType FactorType=EAccelByteLoginAuthFactorType::None, const FString &Code=TEXT("")) |
| Update user password. Add handler to AccelByteOnUpdatePasswordComplete for the result. | |
| bool | UpdatePassword (const FUniqueNetId &UserId, const FUpdatePasswordRequest &Request, EAccelByteLoginAuthFactorType FactorType=EAccelByteLoginAuthFactorType::None, const FString &Code=TEXT("")) |
| Update user password. Add handler to AccelByteOnUpdatePasswordComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnGetMfaStatusComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &, const FMfaStatusResponse &) | |
| bool | GetMfaStatus (int32 LocalUserNum) |
| Get multifactor authentication status for the user. Add handler to AccelByteOnGetMfaStatusComplete for the result. | |
| bool | GetMfaStatus (const FUniqueNetId &UserId) |
| Get multifactor authentication status for the user. Add handler to AccelByteOnGetMfaStatusComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnEnableMfaBackupCodesComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | EnableMfaBackupCodes (int32 LocalUserNum) |
| Enable multifactor authentication using backup codes. Add handler to AccelByteOnEnableMfaBackupCodesComplete for the result. | |
| bool | EnableMfaBackupCodes (const FUniqueNetId &UserId) |
| Enable multifactor authentication using backup codes. Add handler to AccelByteOnEnableMfaBackupCodesComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnDisableMfaBackupCodesComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | DisableMfaBackupCodes (int32 LocalUserNum, const FString &Code) |
| Disable multifactor authentication backup codes. Add handler to AccelByteOnDisableMfaBackupCodesComplete for the result. | |
| bool | DisableMfaBackupCodes (const FUniqueNetId &UserId, const FString &Code) |
| Disable multifactor authentication backup codes. Add handler to AccelByteOnDisableMfaBackupCodesComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnGenerateMfaBackupCodesComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &, const FUser2FaBackupCode &) | |
| bool | GenerateMfaBackupCode (int32 LocalUserNum) |
| Generate multifactor authentication backup codes. Add handler to AccelByteOnGenerateMfaBackupCodesComplete for the result. | |
| bool | GenerateMfaBackupCode (const FUniqueNetId &UserId) |
| Generate multifactor authentication backup codes. Add handler to AccelByteOnGenerateMfaBackupCodesComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnEnableMfaAuthenticatorComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | EnableMfaAuthenticator (int32 LocalUserNum, const FString &Code) |
| Enable multifactor authentication using authenticator app. Add handler to AccelByteOnEnableMfaAuthenticatorComplete for the result. | |
| bool | EnableMfaAuthenticator (const FUniqueNetId &UserId, const FString &Code) |
| Enable multifactor authentication using authenticator app. Add handler to AccelByteOnEnableMfaAuthenticatorComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnDisableMfaAuthenticatorComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | DisableMfaAuthenticator (int32 LocalUserNum, const FString &Code) |
| Disable multifactor authentication using authenticator app. Add handler to AccelByteOnDisableMfaAuthenticatorComplete for the result. | |
| bool | DisableMfaAuthenticator (const FUniqueNetId &UserId, const FString &Code) |
| Disable multifactor authentication using authenticator app. Add handler to AccelByteOnDisableMfaAuthenticatorComplete for the result. | |
| bool | GenerateMfaAuthenticatorSecretKey (int32 LocalUserNum) |
| Generate multifactor authentication secret key for authenticator app. Add handler to AccelByteOnGenerateMfaAuthenticatorSecretKeyComplete for the result. | |
| bool | GenerateMfaAuthenticatorSecretKey (const FUniqueNetId &UserId) |
| Generate multifactor authentication secret key for authenticator app. Add handler to AccelByteOnGenerateMfaAuthenticatorSecretKeyComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnEnableMfaEmailComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | EnableMfaEmail (int32 LocalUserNum, const FString &Code) |
| Enable multifactor authentication using email. Add handler to AccelByteOnEnableMfaEmailComplete for the result. | |
| bool | EnableMfaEmail (const FUniqueNetId &UserId, const FString &Code) |
| Enable multifactor authentication using email. Add handler to AccelByteOnEnableMfaEmailComplete for the result. | |
| DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM (MAX_LOCAL_PLAYERS, AccelByteOnDisableMfaEmailComplete, const FUniqueNetId &, const FOnlineErrorAccelByte &) | |
| bool | DisableMfaEmail (int32 LocalUserNum, const FString &Code) |
| Disable multifactor authentication using email. Add handler to AccelByteOnDisableMfaEmailComplete for the result. | |
| bool | DisableMfaEmail (const FUniqueNetId &UserId, const FString &Code) |
| Disable multifactor authentication using email. Add handler to AccelByteOnDisableMfaEmailComplete for the result. | |
| bool | SendMfaCodeToEmail (int32 LocalUserNum, const EAccelByteSendMfaEmailAction Action) |
| Send multifactor authentication code to user email. Add handler to AccelByteOnSendMfaCodeToEmailComplete for the result. | |
| bool | SendMfaCodeToEmail (const FUniqueNetId &UserId, const EAccelByteSendMfaEmailAction Action) |
| Send multifactor authentication code to user email. Add handler to AccelByteOnSendMfaCodeToEmailComplete for the result. | |
Static Public Member Functions | |
| static bool | GetFromSubsystem (const IOnlineSubsystem *Subsystem, TSharedPtr< FOnlineIdentityAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance) |
| static bool | GetFromWorld (const UWorld *World, TSharedPtr< FOnlineIdentityAccelByte, ESPMode::ThreadSafe > &OutInterfaceInstance) |
| static bool | IsLogoutRequired (int32 WsClosedConnectionStatusCode) |
AccelByte service implementation of the online identity interface
| FOnlineIdentityAccelByte::FOnlineIdentityAccelByte | ( | FOnlineSubsystemAccelByte * | InSubsystem | ) |
Construct an instance of our identity interface
| InSubsystem | Subsystem that owns this identity interface |
Begin FOnlineIdentityAccelByte
| void FOnlineIdentityAccelByte::AddAuthenticatedServer | ( | int32 | LocalUserNum | ) |
Add a new authenticated server to the identity interface mappings for V2 session flow
| bool FOnlineIdentityAccelByte::AuthenticateAccelByteServer | ( | const FOnAuthenticateServerComplete & | Delegate, |
| int32 | LocalUserNum = 0 ) |
Authenticate a server on the backend
#TODO (Maxwell): This really should be supported by AutoLogin as a separate authentication path, as there's a ton of hacky code we need to write to make sure that any server call is working when authenticated. If we use AutoLogin for server auth, we bypass a lot of that code. However, this would require a rework to the current server code that we don't have time for... For now, use this method for all server auth...
| FOnlineIdentityAccelByte::DEFINE_ONLINE_DELEGATE_ONE_PARAM | ( | AccelByteOnLoginQueueCanceledByUser | , |
| int32 | ) |
Online delegate to notify poller when a user cancelled login queue
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLobbyReconnected | ) |
Called when lobby connected after try to reconnect
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLobbyConnectionClosed | , | ||
| const FUniqueNetId & | , | ||
| int32 | , | ||
| const FString & | , | ||
| bool | ) |
Called when lobby connection closed
| LocalUserNum | the controller number of the associated user |
| UserId | the user id received from the server on successful connect |
| StatusCode | Current status response code from lobby closed connection |
| Reason | The reason of lobby connection closed |
| bWasClean | Whether the connection closed with a clean status or not |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLobbyReconnecting | , | ||
| const FUniqueNetId & | , | ||
| int32 | , | ||
| const FString & | , | ||
| bool | ) |
Called when lobby try to reconnect
| LocalUserNum | the controller number of the associated user |
| UserId | the user id received from the server on successful connect |
| StatusCode | Current status response code from lobby closed connection |
| Reason | The reason of lobby reconnecting |
| bWasClean | Whether the connection reconnect with a clean status or not |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnPlatformTokenRefreshedComplete | , | ||
| bool | , | ||
| const FPlatformTokenRefreshResponse & | , | ||
| const FName & | , | ||
| const FErrorOAuthInfo & | ) |
Triggered when the platform token refresh is already responded
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| FPlatformTokenRefreshResponse | the refresh result & information |
| PlatformName | The platform that was refreshed |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_FOUR_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnSimultaneousLoginComplete | , | ||
| bool | , | ||
| ESimultaneousLoginResult | , | ||
| const FUniqueNetId & | , | ||
| const FErrorOAuthInfo & | ) |
Called when user simultaneous login has completed after calling Login()
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| ESimultaneousLoginResult | the result from the login attempt, or the last known state |
| UserId | the user id received from the server on successful login |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLobbyMassiveOutageEvent | , | ||
| const AccelByte::FMassiveOutageInfo & | ) |
Called when the lobby has been disconnected for longer than usual and can't be reconnected yet
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLobbyReconnectAttempted | , | ||
| const AccelByte::FReconnectAttemptInfo & | ) |
Called when the disconnected lobby websocket trying to establish the connection again
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_ONE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLoginQueued | , | ||
| const FAccelByteModelsLoginQueueTicketInfo & | ) |
Triggered when the login process is queued
| LocalUserNum | the controller number of the associated user |
| TicketInfo | Information about the queue ticket |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnConnectLobbyComplete | , | ||
| bool | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Called when user account login succesfully connected to lobby
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| UserId | the user id received from the server on successful connect |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnGenerateMfaBackupCodesComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | , | ||
| const FUser2FaBackupCode & | ) |
Online delegate to notify user when generate mfa backup code completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnGetMfaStatusComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | , | ||
| const FMfaStatusResponse & | ) |
Online delegate to notify user when get mfa status completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_THREE_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLoginComplete | , | ||
| bool | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Called when user account login has completed after calling Login() or AutoLogin()
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| UserId | the user id received from the server on successful login |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnDisableMfaAuthenticatorComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when disable mfa authenticator completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnDisableMfaBackupCodesComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when disable mfa backup code completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnDisableMfaEmailComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when disable mfa email completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnEnableMfaAuthenticatorComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when enable mfa authenticator completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnEnableMfaBackupCodesComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when enable mfa backup code completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnEnableMfaEmailComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when enable mfa email completed.
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLoginQueueCancelComplete | , | ||
| bool | , | ||
| const FOnlineErrorAccelByte & | ) |
Triggered when login queue cancel operation is completed
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLoginQueueClaimTicketComplete | , | ||
| bool | , | ||
| const FErrorOAuthInfo & | ) |
Triggered when the login process is queued
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| TicketInfo | Information about the queue ticket |
| Error | Information about the error condition Triggered when the login process is queued |
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| TicketInfo | Information about the queue ticket |
| Error | Information about the error condition Triggered when the login process is queued |
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | true if server was contacted and a valid result received |
| TicketInfo | Information about the queue ticket |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnLogoutComplete | , | ||
| bool | , | ||
| const FOnlineErrorAccelByte & | ) |
Delegate used in notifying the that manual logout completed
| LocalUserNum | the controller number of the associated user |
| bWasSuccessful | whether the async call completed properly or not |
| Error | Information about the error condition |
| FOnlineIdentityAccelByte::DEFINE_ONLINE_PLAYER_DELEGATE_TWO_PARAM | ( | MAX_LOCAL_PLAYERS | , |
| AccelByteOnUpdatePasswordComplete | , | ||
| const FUniqueNetId & | , | ||
| const FOnlineErrorAccelByte & | ) |
Online delegate to notify user when password updated.
| bool FOnlineIdentityAccelByte::DisableMfaAuthenticator | ( | const FUniqueNetId & | UserId, |
| const FString & | Code ) |
Disable multifactor authentication using authenticator app. Add handler to AccelByteOnDisableMfaAuthenticatorComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Code | The code generated from authenticator app. |
| bool FOnlineIdentityAccelByte::DisableMfaAuthenticator | ( | int32 | LocalUserNum, |
| const FString & | Code ) |
Disable multifactor authentication using authenticator app. Add handler to AccelByteOnDisableMfaAuthenticatorComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| Code | The code generated from authenticator app. |
| bool FOnlineIdentityAccelByte::DisableMfaBackupCodes | ( | const FUniqueNetId & | UserId, |
| const FString & | Code ) |
Disable multifactor authentication backup codes. Add handler to AccelByteOnDisableMfaBackupCodesComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Code | One of the valid backup codes. |
| bool FOnlineIdentityAccelByte::DisableMfaBackupCodes | ( | int32 | LocalUserNum, |
| const FString & | Code ) |
Disable multifactor authentication backup codes. Add handler to AccelByteOnDisableMfaBackupCodesComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| Code | One of the valid backup codes. |
| bool FOnlineIdentityAccelByte::DisableMfaEmail | ( | const FUniqueNetId & | UserId, |
| const FString & | Code ) |
Disable multifactor authentication using email. Add handler to AccelByteOnDisableMfaEmailComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Code | The verification code from user email. |
| bool FOnlineIdentityAccelByte::DisableMfaEmail | ( | int32 | LocalUserNum, |
| const FString & | Code ) |
Disable multifactor authentication using email. Add handler to AccelByteOnDisableMfaEmailComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| Code | The verification code from user email. |
| bool FOnlineIdentityAccelByte::EnableMfaAuthenticator | ( | const FUniqueNetId & | UserId, |
| const FString & | Code ) |
Enable multifactor authentication using authenticator app. Add handler to AccelByteOnEnableMfaAuthenticatorComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Code | The code generated from authenticator app. |
| bool FOnlineIdentityAccelByte::EnableMfaAuthenticator | ( | int32 | LocalUserNum, |
| const FString & | Code ) |
Enable multifactor authentication using authenticator app. Add handler to AccelByteOnEnableMfaAuthenticatorComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| bool FOnlineIdentityAccelByte::EnableMfaBackupCodes | ( | const FUniqueNetId & | UserId | ) |
Enable multifactor authentication using backup codes. Add handler to AccelByteOnEnableMfaBackupCodesComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| bool FOnlineIdentityAccelByte::EnableMfaBackupCodes | ( | int32 | LocalUserNum | ) |
Enable multifactor authentication using backup codes. Add handler to AccelByteOnEnableMfaBackupCodesComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| bool FOnlineIdentityAccelByte::EnableMfaEmail | ( | const FUniqueNetId & | UserId, |
| const FString & | Code ) |
Enable multifactor authentication using email. Add handler to AccelByteOnEnableMfaEmailComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Code | The verification code from user email. |
| bool FOnlineIdentityAccelByte::EnableMfaEmail | ( | int32 | LocalUserNum, |
| const FString & | Code ) |
Enable multifactor authentication using email. Add handler to AccelByteOnEnableMfaEmailComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| Code | The verification code from user email. |
| void FOnlineIdentityAccelByte::FinalizeLoginQueue | ( | int32 | LoginUserNum | ) |
Used to clear ticket ID according to it's user num.
| LoginUserNum | UserNum trying to login |
| void FOnlineIdentityAccelByte::FinalizeLoginQueueCancel | ( | int32 | LoginUserNum | ) |
Used by login queue cancel to notify poller when user cancelled login queue
| LoginUserNum | the user num we cancelled the login |
| void FOnlineIdentityAccelByte::GenerateCodeForPublisherToken | ( | int32 | LocalUserNum, |
| const FString & | PublisherClientId, | ||
| FGenerateCodeForPublisherTokenComplete | Delegate ) |
This function generate ab code that can be exchanged into publisher namespace token (i.e. by web portal).
| PublisherClientID | The targeted game's publisher ClientID. |
| bool FOnlineIdentityAccelByte::GenerateMfaAuthenticatorSecretKey | ( | const FUniqueNetId & | UserId | ) |
Generate multifactor authentication secret key for authenticator app. Add handler to AccelByteOnGenerateMfaAuthenticatorSecretKeyComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| bool FOnlineIdentityAccelByte::GenerateMfaAuthenticatorSecretKey | ( | int32 | LocalUserNum | ) |
Generate multifactor authentication secret key for authenticator app. Add handler to AccelByteOnGenerateMfaAuthenticatorSecretKeyComplete for the result.
Online delegate to notify user when generate mfa authenticator secret key completed.
| LocalUserNum | The controller number of the associated user. |
| bool FOnlineIdentityAccelByte::GenerateMfaBackupCode | ( | const FUniqueNetId & | UserId | ) |
Generate multifactor authentication backup codes. Add handler to AccelByteOnGenerateMfaBackupCodesComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| bool FOnlineIdentityAccelByte::GenerateMfaBackupCode | ( | int32 | LocalUserNum | ) |
Generate multifactor authentication backup codes. Add handler to AccelByteOnGenerateMfaBackupCodesComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| AccelByte::FApiClientPtr FOnlineIdentityAccelByte::GetApiClient | ( | const FUniqueNetId & | UserId | ) |
Get the FApiClient that is used for a particular user by their net ID.
Used to make raw SDK calls for user if needed.
| AccelByte::FApiClientPtr FOnlineIdentityAccelByte::GetApiClient | ( | int32 | LocalUserNum | ) |
Get the FApiClient that is used for a particular user by their net ID.
Used to make raw SDK calls for user if needed.
|
static |
Convenience method to get an instance of this interface from the subsystem passed in.
| Subsystem | Subsystem instance that we wish to get this interface from |
| OutInterfaceInstance | Instance of the interface that we got from the subsystem, or nullptr if not found |
|
static |
Convenience method to get an instance of this interface from the subsystem associated with the world passed in.
| World | World instance that we wish to get the interface from |
| OutInterfaceInstance | Instance of the interface that we got from the subsystem, or nullptr if not found |
| bool FOnlineIdentityAccelByte::GetLocalUserNum | ( | const FUniqueNetId & | NetId, |
| int32 & | OutLocalUserNum ) const |
Extra method to try and get a LocalUserNum from a FUniqueNetId instance
| bool FOnlineIdentityAccelByte::GetMfaStatus | ( | const FUniqueNetId & | UserId | ) |
Get multifactor authentication status for the user. Add handler to AccelByteOnGetMfaStatusComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| bool FOnlineIdentityAccelByte::GetMfaStatus | ( | int32 | LocalUserNum | ) |
Get multifactor authentication status for the user. Add handler to AccelByteOnGetMfaStatusComplete for the result.
| LocalUserNum | The controller number of the associated user. |
|
virtual |
Retrieve User Account information from given Local User.
| LocalUserId | SharedPtr of given Local User. |
|
virtual |
Retrieve User Account information from given Local User.
| LocalUserId | SharedRef of given Local User. |
|
virtual |
Retrieve User Account information from given Local User.
| LocalUserNum | the controller number of the associated user. |
| void FOnlineIdentityAccelByte::InitializeLoginQueue | ( | int32 | LoginUserNum, |
| const FString & | TicketId ) |
Used to store ticket ID according to it's user num.
| LoginUserNum | UserNum trying to login |
| TicketId | Login queue ticket ID |
|
static |
To decide whether the current user should be logged out or not. Logout required for specific range of codes. Which means connection closure is abnormal and client should not reconnect (i.e. ban & access token revocation)
| bool FOnlineIdentityAccelByte::IsServerAuthenticated | ( | int32 | LocalUserNum = 0 | ) |
Check whether or not our server is authenticated or not
| bool FOnlineIdentityAccelByte::RefreshPlatformToken | ( | int32 | LocalUserNum | ) |
Refresh the native platform token that is stored in the backend. Therefore we can prevent expiration on the backend. Default behavior: this function already registered automatically and follow the schedule of refresh token expiration. To disable this default:
| bool FOnlineIdentityAccelByte::RefreshPlatformToken | ( | int32 | LocalUserNum, |
| FName | SubsystemName ) |
Refresh the native platform token that is stored in the backend. Therefore we can prevent expiration on the backend.
| SubsystemName | The name of the subsystem authorization ticket that will be refreshed |
| bool FOnlineIdentityAccelByte::SendMfaCodeToEmail | ( | const FUniqueNetId & | UserId, |
| const EAccelByteSendMfaEmailAction | Action ) |
Send multifactor authentication code to user email. Add handler to AccelByteOnSendMfaCodeToEmailComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Action | Supported action are update password, disable/enable email mfa (use EAccelByteSendMfaEmailAction::DisableMFAEmail for disable/enable). |
| bool FOnlineIdentityAccelByte::SendMfaCodeToEmail | ( | int32 | LocalUserNum, |
| const EAccelByteSendMfaEmailAction | Action ) |
Send multifactor authentication code to user email. Add handler to AccelByteOnSendMfaCodeToEmailComplete for the result.
Online delegate to notify user when send mfa code to email completed.
| LocalUserNum | The controller number of the associated user. |
| Action | Supported action are update password, disable/enable email mfa (use EAccelByteSendMfaEmailAction::DisableMFAEmail for disable/enable). |
| void FOnlineIdentityAccelByte::SetAutoLoginCreateHeadless | ( | bool | bInIsAutoLoginCreateHeadless | ) |
Set whether to create headless account when try to do 3rd party login using AutoLogin. The default value is true.
| void FOnlineIdentityAccelByte::SetLoginStatus | ( | int32 | LocalUserNum, |
| ELoginStatus::Type | NewStatus ) |
Set login status.
| bool FOnlineIdentityAccelByte::UpdatePassword | ( | const FUniqueNetId & | UserId, |
| const FUpdatePasswordRequest & | Request, | ||
| EAccelByteLoginAuthFactorType | FactorType = EAccelByteLoginAuthFactorType::None, | ||
| const FString & | Code = TEXT("") ) |
Update user password. Add handler to AccelByteOnUpdatePasswordComplete for the result.
| UserId | FUniqueNetId of the user who performed this action. |
| Request | The request containing old and new password. |
| FactorType | [optional] Multifactor authentication type (backup codes, email or authenticator app). Only needed if mfa for sensitive action enabled in the environment. |
| Code | [optional] The code for multifactor authentication. Only needed if mfa for sensitive action enabled in the environment. |
| bool FOnlineIdentityAccelByte::UpdatePassword | ( | int32 | LocalUserNum, |
| const FUpdatePasswordRequest & | Request, | ||
| EAccelByteLoginAuthFactorType | FactorType = EAccelByteLoginAuthFactorType::None, | ||
| const FString & | Code = TEXT("") ) |
Update user password. Add handler to AccelByteOnUpdatePasswordComplete for the result.
| LocalUserNum | The controller number of the associated user. |
| Request | The request containing old and new password. |
| FactorType | [optional] Multifactor authentication type (backup codes, email or authenticator app). Only needed if mfa for sensitive action enabled in the environment. |
| Code | [optional] The code for multifactor authentication. Only needed if mfa for sensitive action enabled in the environment. |
| bool FOnlineIdentityAccelByte::VerifyLoginMfa | ( | int32 | LocalUserNum, |
| EAccelByteLoginAuthFactorType | FactorType, | ||
| const FString & | Code, | ||
| const FString & | MfaToken, | ||
| bool | bRememberDevice = false ) |
Verify user using multifactor authentication. Add handler to AccelByteOnLoginCompleteDelegate for the result.
| LocalUserNum | The controller number of the associated user. |
| FactorType | Multifactor authentication type (backup codes, email or authenticator app). |
| Code | The code for multifactor authentication. |
| MfaToken | The mfa token received from AccelByteOnLoginCompleteDelegate. |
| bRememberDevice | Option to remember current device. If set to true the authentication only require once for every account. |