FOnlineAsyncTaskAccelByteSimultaneousLogin Class Reference

#include <OnlineAsyncTaskAccelByteSimultaneousLogin.h>

Inheritance diagram for FOnlineAsyncTaskAccelByteSimultaneousLogin:

Public Member Functions
	FOnlineAsyncTaskAccelByteSimultaneousLogin (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, const FOnlineAccountCredentials &InAccountCredentials, bool bInCreateHeadlessAccount=true)
Public Member Functions inherited from FOnlineAsyncTaskAccelByteLogin
	FOnlineAsyncTaskAccelByteLogin (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, const FOnlineAccountCredentialsAccelByte &InAccountCredentials, bool bInCreateHeadlessAccount=true)
virtual void	OnTaskTimedOut () override
Public Member Functions inherited from FOnlineAsyncTaskAccelByte
	FOnlineAsyncTaskAccelByte (FOnlineSubsystemAccelByte *const InABSubsystem, bool bInShouldUseTimeout=true)
	FOnlineAsyncTaskAccelByte (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, bool bInShouldUseTimeout=true)
	FOnlineAsyncTaskAccelByte (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, int32 InFlags)
	FOnlineAsyncTaskAccelByte (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, int32 InFlags, TSharedPtr< FAccelByteKey > InLockKey)
virtual void	Tick (double Delta)
virtual bool	HasTaskTimedOut ()
void	ForcefullySetTimeoutState ()
virtual FString	ToString () const override
EAccelByteAsyncTaskState	GetCurrentState ()
int32	GetLocalUserNum ()
virtual void	SetParentTask (FOnlineAsyncTaskAccelByte *Task)
virtual FOnlineAsyncTaskAccelByte *	GetParentTask ()
virtual bool	HasParent ()
virtual void	SetEpicForThisTask (FOnlineAsyncEpicTaskAccelByte *AssignedEpic)
bool	SetLocalUserNum (int32 InLocalUserNum)

Protected Member Functions
virtual void	Initialize () override
virtual void	Finalize () override
virtual void	TriggerDelegates () override
virtual void	PerformLogin (const FOnlineAccountCredentials &Credentials) override
virtual const FString	GetTaskName () const override
Protected Member Functions inherited from FOnlineAsyncTaskAccelByteLogin
void	LoginWithNativeSubsystem ()
void	LoginWithSpecificSubsystem (IOnlineSubsystem *NativeSubsystem)
void	LoginWithSpecificSubsystem (FName InSubsystemName)
virtual void	OnSpecificSubysystemLoginComplete (int32 LocalUserNum, bool bWasSubsystemLoginSuccessful, const FUniqueNetId &SubsystemUserId, const FString &SubsystemError, IOnlineSubsystem *SpecificSubsystem)
void	OnSpecificSubysystemLoginUIClosed (FUniqueNetIdPtr UniqueId, const int ControllerIndex, const FOnlineError &SubsystemError, IOnlineSubsystem *SpecificSubsystem)
virtual void	OnLoginSuccess ()
virtual void	OnLoginSuccessV4 (const FAccelByteModelsLoginQueueTicketInfo &TicketInfo)
virtual void	Tick () override
void	OnLoginErrorOAuth (int32 ErrorCode, const FString &ErrorMessage, const FErrorOAuthInfo &ErrorObject)
void	OnLoginQueueCancelled (int32 InLocalUserNum)
void	OnLoginQueueTicketClaimed (int32 InLocalUserNum, bool bWasClaimSuccessful, const FErrorOAuthInfo &ErrorObject)
bool	ShouldInitiateNativePlatformLogin (FOnlineAccountCredentials const &InAccountCredentials, FName &OutSubsystemName)
bool	FetchOculusPlatformToken ()
void	OnFetchOculusPlatformTokenFinished (const FString &Token)
Protected Member Functions inherited from FOnlineAsyncTaskAccelByte
void	CompleteTask (const EAccelByteAsyncTaskCompleteState &InCompleteState)
virtual void	SetLastUpdateTimeToCurrentTime ()
template<typename T>
void	RaiseGenericError (T Args)
void	RaiseGenericError ()
template<>
void	RaiseGenericError (FString &InErrorStrMember)
template<>
void	RaiseGenericError (FOnlineError &InOnlineError)
template<>
void	RaiseGenericError (FOnlineErrorAccelByte &InOnlineError)
template<typename T>
void	RaiseGenericServerError (T Args)
void	RaiseGenericServerError ()
template<>
void	RaiseGenericServerError (FString &InErrorStrMember)
template<>
void	RaiseGenericServerError (FOnlineError &InOnlineError)
template<>
void	RaiseGenericServerError (FOnlineErrorAccelByte &InOnlineError)
virtual AccelByte::FApiClientPtr	GetApiClient (int32 InLocalUserNum)
virtual AccelByte::FApiClientPtr	GetApiClient (FUniqueNetIdAccelByteUserRef const &InUserId)
virtual FAccelByteInstanceWPtr	GetAccelByteInstance ()
AccelByte::FApiClientPtr	GetApiClientInternal ()
void	SetApiClient (AccelByte::FApiClientPtr Input)
bool	IsApiClientValid ()
void	GetOtherUserIdentifiers ()
virtual void	OnTaskStartWorking ()
bool	HasFlag (const EAccelByteAsyncTaskFlags &Flag) const
bool	HasFlag (uint8 FlagBit) const
void	ExecuteCriticalSectionAction (FVoidHandler Action)

Additional Inherited Members
Protected Types inherited from FOnlineAsyncTaskAccelByte
using	Super = FOnlineAsyncTaskAccelByte
Protected Attributes inherited from FOnlineAsyncTaskAccelByteLogin
FOnlineAccountCredentialsAccelByte	AccountCredentials
FString	ErrorStr
FErrorOAuthInfo	ErrorOAuthObject
int32	ErrorCode
EAccelByteLoginType	LoginType
TSharedPtr< FUserOnlineAccountAccelByte >	Account
TSharedPtr< FOnlineUserCacheAccelByte, ESPMode::ThreadSafe >	UserCache
ELoginStatus::Type	LoginStatus = ELoginStatus::NotLoggedIn
FAccelByteTimerObject	TimerObject
bool	bRetryLoginSkipExternalUI {false}
FUniqueNetIdPtr	NativePlatformPlayerId = nullptr
FUniqueNetIdPtr	SecondaryPlatformPlayerId = nullptr
FOnlineAccountCredentials	NativePlatformCredentials {}
bool	bLoginPerformed {false}
FString	PlatformId {}
bool	bCreateHeadlessAccount = true
bool	bIsNativePlatformCredentialLogin = true
bool	bLoginInQueue = false
FDelegateHandle	LoginCompletedHandle
FDelegateHandle	OnLoginQueueCancelledDelegateHandle
FAccelByteOnLoginQueueCanceledByUserDelegate	OnLoginQueueCancelledDelegate
FDelegateHandle	OnLoginQueueClaimTicketCompleteDelegateHandle
FAccelByteOnLoginQueueClaimTicketCompleteDelegate	OnLoginQueueClaimTicketCompleteDelegate
Protected Attributes inherited from FOnlineAsyncTaskAccelByte
FOnlineSubsystemAccelByteWPtr	AccelByteSubsystem
EAccelByteAsyncTaskState	CurrentState = EAccelByteAsyncTaskState::Uninitialized
EAccelByteAsyncTaskCompleteState	CompleteState = EAccelByteAsyncTaskCompleteState::Incomplete
EOnlineErrorResult	TaskOnlineError = EOnlineErrorResult::Unknown
FString	TaskErrorCode {}
FString	TaskErrorStr {}
bool	bShouldUseTimeout = false
double	LastTaskUpdateInSeconds = FPlatformTime::Seconds()
double	TaskTimeoutInSeconds = 30.0
double	DeltaTickAccumulation = 0.0
FCriticalSection	TimeoutLock
int32	LocalUserNum = INVALID_CONTROLLERID
FUniqueNetIdAccelByteUserPtr	UserId = nullptr
int32	Flags = 0
TBitArray< FDefaultBitArrayAllocator >	BitFlags
FOnlineAsyncTaskAccelByte *	ParentTask = nullptr
FOnlineAsyncEpicTaskAccelByte *	Epic = nullptr
TSharedPtr< FAccelByteKey >	LockKey

Detailed Description

Async task to authenticate a user with the AccelByte backend, either using a native platform account, or a user specified account

Member Function Documentation

Finalize()

void FOnlineAsyncTaskAccelByteSimultaneousLogin::Finalize ( )

overrideprotectedvirtual

Reimplemented from FOnlineAsyncTaskAccelByteLogin.

GetTaskName()

virtual const FString FOnlineAsyncTaskAccelByteSimultaneousLogin::GetTaskName ( ) const

inlineoverrideprotectedvirtual

Basic method to get the current name of the task, used for ToString on tasks as well as trace logs.

Should be overridden by any async task that extends from this base class.

Reimplemented from FOnlineAsyncTaskAccelByteLogin.

Initialize()

void FOnlineAsyncTaskAccelByteSimultaneousLogin::Initialize ( )

overrideprotectedvirtual

Basic initialize override to check if we are using timeouts, and if so update the last task update time to the current time.

Reimplemented from FOnlineAsyncTaskAccelByteLogin.

PerformLogin()

void FOnlineAsyncTaskAccelByteSimultaneousLogin::PerformLogin ( const FOnlineAccountCredentials & Credentials )

overrideprotectedvirtual

Perform login on the AccelByte backend using defined login type and OAuth error type

Reimplemented from FOnlineAsyncTaskAccelByteLogin.

TriggerDelegates()

void FOnlineAsyncTaskAccelByteSimultaneousLogin::TriggerDelegates ( )

overrideprotectedvirtual

Reimplemented from FOnlineAsyncTaskAccelByteLogin.