AccelByte::Api::MatchmakingV2 Class Reference

Inheritance diagram for AccelByte::Api::MatchmakingV2:

Public Member Functions
	MatchmakingV2 (Credentials const &InCredentialsRef, Settings const &InSettingRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	MatchmakingV2 (Credentials const &InCredentialsRef, Settings const &InSettingRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	CreateMatchTicket (FString const &MatchPool, THandler< FAccelByteModelsV2MatchmakingCreateTicketResponse > const &OnSuccess, FErrorHandler const &OnError, FAccelByteModelsV2MatchTicketOptionalParams const &Optionals={})
	[DEPRECATED] Create a matchmaking ticket, this will start matchmaking process.
FAccelByteTaskWPtr	CreateMatchTicket (FString const &MatchPool, THandler< FAccelByteModelsV2MatchmakingCreateTicketResponse > const &OnSuccess, FCreateMatchmakingTicketErrorHandler const &OnError, FAccelByteModelsV2MatchTicketOptionalParams const &Optionals={})
	Create a matchmaking ticket, this will start matchmaking process.
FAccelByteTaskWPtr	GetMatchTicketDetails (FString const &TicketId, THandler< FAccelByteModelsV2MatchmakingGetTicketDetailsResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get the match ticket details, will get the status of match ticket if it's already matched and it's corresponding session ID if already matched into a session.
FAccelByteTaskWPtr	DeleteMatchTicket (FString const &TicketId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete the match ticket. Will cancel the matchmaking process on success.
FAccelByteTaskWPtr	GetMatchmakingMetrics (FString const &MatchPool, THandler< FAccelByteModelsV2MatchmakingMetrics > const &OnSuccess, FErrorHandler const &OnError)
	Get matchmaking matchpool's metrics.
FAccelByteTaskWPtr	GetMyMatchTickets (THandler< FAccelByteModelsV2MatchmakingTicketStatuses > const &OnSuccess, FErrorHandler const &OnError, FString const &MatchPool=TEXT(""), int32 Limit=20, int32 Offset=0)
	Get my match tickets already matched tickets will be listed for a while after it's matched.
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

Member Function Documentation

CreateMatchTicket() [1/2]

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::CreateMatchTicket	(	FString const &	MatchPool,
		THandler< FAccelByteModelsV2MatchmakingCreateTicketResponse > const &	OnSuccess,
		FCreateMatchmakingTicketErrorHandler const &	OnError,
		FAccelByteModelsV2MatchTicketOptionalParams const &	Optionals = {} )

Create a matchmaking ticket, this will start matchmaking process.

Parameters

MatchPool	Name of the match pool we want to matchmake into.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Optionals	optional variables we can set for matchmaking process.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateMatchTicket() [2/2]

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::CreateMatchTicket	(	FString const &	MatchPool,
		THandler< FAccelByteModelsV2MatchmakingCreateTicketResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FAccelByteModelsV2MatchTicketOptionalParams const &	Optionals = {} )

[DEPRECATED] Create a matchmaking ticket, this will start matchmaking process.

Parameters

MatchPool	Name of the match pool we want to matchmake into.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.
Optionals	optional variables we can set for matchmaking process.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

DeleteMatchTicket()

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::DeleteMatchTicket	(	FString const &	TicketId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete the match ticket. Will cancel the matchmaking process on success.

Parameters

TicketId	ID of the matchmaking ticket.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetMatchmakingMetrics()

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::GetMatchmakingMetrics	(	FString const &	MatchPool,
		THandler< FAccelByteModelsV2MatchmakingMetrics > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get matchmaking matchpool's metrics.

Parameters

MatchPool	Name of the matchpool.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetMatchTicketDetails()

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::GetMatchTicketDetails	(	FString const &	TicketId,
		THandler< FAccelByteModelsV2MatchmakingGetTicketDetailsResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get the match ticket details, will get the status of match ticket if it's already matched and it's corresponding session ID if already matched into a session.

Parameters

TicketId	ID of the matchmaking ticket.
OnSuccess	This will be called if the operation succeeded.
OnError	This will be called if the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetMyMatchTickets()

FAccelByteTaskWPtr AccelByte::Api::MatchmakingV2::GetMyMatchTickets	(	THandler< FAccelByteModelsV2MatchmakingTicketStatuses > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	MatchPool = TEXT(""),
		int32	Limit = 20,
		int32	Offset = 0 )

Get my match tickets already matched tickets will be listed for a while after it's matched.

Parameters

OnSuccess	Will be called if the operation succeeded.
OnError	This will be called if the operation failed.
MatchPool	Name of the match pool we want to query, leave empty will query all match pool.
Limit	Pagination item limit, default is 20.
Offset	Pagination item offset, default is 0.

Returns

AccelByteTask object to track and cancel the ongoing API operation.