FOnlineAsyncTaskAccelByteQueryUsersByIds Class Reference

#include <OnlineAsyncTaskAccelByteQueryUsersByIds.h>

Inheritance diagram for FOnlineAsyncTaskAccelByteQueryUsersByIds:

Public Member Functions
	FOnlineAsyncTaskAccelByteQueryUsersByIds (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, const TArray< FString > &AccelByteIds, bool InBIsImportant, const FOnQueryUsersComplete &InDelegate)
	FOnlineAsyncTaskAccelByteQueryUsersByIds (FOnlineSubsystemAccelByte *const InABSubsystem, int32 InLocalUserNum, const FString InPlatformType, const TArray< FString > &PlatformIds, bool InBIsImportant, const FOnQueryUsersComplete &InDelegate)
	FOnlineAsyncTaskAccelByteQueryUsersByIds (FOnlineSubsystemAccelByte *const InABSubsystem, const FUniqueNetId &InUserId, const TArray< FString > &AccelByteIds, bool InBIsImportant, const FOnQueryUsersComplete &InDelegate)
	FOnlineAsyncTaskAccelByteQueryUsersByIds (FOnlineSubsystemAccelByte *const InABSubsystem, const FUniqueNetId &InUserId, const FString InPlatformType, const TArray< FString > &PlatformIds, bool InBIsImportant, const FOnQueryUsersComplete &InDelegate)
virtual void	Initialize () override
virtual void	Tick () override
virtual void	Finalize () override
virtual void	TriggerDelegates () 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 const FString	GetTaskName () const override
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 void	OnTaskTimedOut ()
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 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

Task to query a bulk of users by AccelByte or platform IDs, will add these users to the user cache.

Constructor & Destructor Documentation

FOnlineAsyncTaskAccelByteQueryUsersByIds() [1/4]

FOnlineAsyncTaskAccelByteQueryUsersByIds::FOnlineAsyncTaskAccelByteQueryUsersByIds	(	FOnlineSubsystemAccelByte *const	InABSubsystem,
		int32	InLocalUserNum,
		const TArray< FString > &	AccelByteIds,
		bool	InBIsImportant,
		const FOnQueryUsersComplete &	InDelegate )

Queries a bulk of AccelByte IDs using a local user index

FOnlineAsyncTaskAccelByteQueryUsersByIds() [2/4]

FOnlineAsyncTaskAccelByteQueryUsersByIds::FOnlineAsyncTaskAccelByteQueryUsersByIds	(	FOnlineSubsystemAccelByte *const	InABSubsystem,
		int32	InLocalUserNum,
		const FString	InPlatformType,
		const TArray< FString > &	PlatformIds,
		bool	InBIsImportant,
		const FOnQueryUsersComplete &	InDelegate )

Queries a bulk of platform IDs to attempt to get AccelByte accounts using a local user index

FOnlineAsyncTaskAccelByteQueryUsersByIds() [3/4]

FOnlineAsyncTaskAccelByteQueryUsersByIds::FOnlineAsyncTaskAccelByteQueryUsersByIds	(	FOnlineSubsystemAccelByte *const	InABSubsystem,
		const FUniqueNetId &	InUserId,
		const TArray< FString > &	AccelByteIds,
		bool	InBIsImportant,
		const FOnQueryUsersComplete &	InDelegate )

Queries a bulk of AccelByte IDs using a user ID

FOnlineAsyncTaskAccelByteQueryUsersByIds() [4/4]

FOnlineAsyncTaskAccelByteQueryUsersByIds::FOnlineAsyncTaskAccelByteQueryUsersByIds	(	FOnlineSubsystemAccelByte *const	InABSubsystem,
		const FUniqueNetId &	InUserId,
		const FString	InPlatformType,
		const TArray< FString > &	PlatformIds,
		bool	InBIsImportant,
		const FOnQueryUsersComplete &	InDelegate )

Queries a bulk of platform IDs to attempt to get AccelByte accounts using a user ID

Member Function Documentation

GetTaskName()

virtual const FString FOnlineAsyncTaskAccelByteQueryUsersByIds::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 FOnlineAsyncTaskAccelByte.

Initialize()

void FOnlineAsyncTaskAccelByteQueryUsersByIds::Initialize ( )

overridevirtual

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 FOnlineAsyncTaskAccelByte.

Tick()

void FOnlineAsyncTaskAccelByteQueryUsersByIds::Tick ( )

overridevirtual

Simple tick override to check if we are using timeouts, and if so check the task timeout and complete the task unsuccessfully if it's over its timeout

Reimplemented from FOnlineAsyncTaskAccelByte.