AccelByte::Api::LoginQueue Class Reference

Login Queue API for Login Ticket Management. More...

#include <AccelByteLoginQueueApi.h>

Inheritance diagram for AccelByte::Api::LoginQueue:

Public Member Functions
	LoginQueue (Credentials &Credentials, Settings &Settings, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	LoginQueue (Credentials &Credentials, Settings &Settings, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	RefreshTicket (FString const &Ticket, THandler< FAccelByteModelsLoginQueueTicketInfo > const &OnSuccess, FErrorHandler const &OnError, FString const &Namespace=TEXT(""))
	Refresh Login Ticket.
FAccelByteTaskWPtr	CancelTicket (FString const &Ticket, FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FString const &Namespace=TEXT(""))
	Cancel Login Ticket.
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

Detailed Description

Login Queue API for Login Ticket Management.

Member Function Documentation

CancelTicket()

FAccelByteTaskWPtr AccelByte::Api::LoginQueue::CancelTicket	(	FString const &	Ticket,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	Namespace = TEXT("") )

Cancel Login Ticket.

Parameters

Ticket	Login Ticket to cancel.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Namespace	Namespace of the game

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RefreshTicket()

FAccelByteTaskWPtr AccelByte::Api::LoginQueue::RefreshTicket	(	FString const &	Ticket,
		THandler< FAccelByteModelsLoginQueueTicketInfo > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	Namespace = TEXT("") )

Refresh Login Ticket.

Parameters

Ticket	Login Ticket to refresh.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Namespace	Namespace of the game

Returns

AccelByteTask object to track and cancel the ongoing API operation.