AccelByte::Api::SeasonPass Class Reference

Season Pass APIs to access Season Pass service. User can obtaining season and claiming rewards. More...

#include <AccelByteSeasonPassApi.h>

Inheritance diagram for AccelByte::Api::SeasonPass:

Public Member Functions
	SeasonPass (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	SeasonPass (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetCurrentSeason (FString const &Language, THandler< FAccelByteModelsSeasonInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get current active season.
FAccelByteTaskWPtr	GetUserSeason (FString const &SeasonId, THandler< FAccelByteModelsUserSeasonInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user season data by SeasonId.
FAccelByteTaskWPtr	GetCurrentUserSeason (THandler< FAccelByteModelsUserSeasonInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get current active user season data.
FAccelByteTaskWPtr	ClaimRewards (FAccelByteModelsSeasonClaimRewardRequest const &RewardRequest, THandler< FAccelByteModelsSeasonClaimRewardResponse > const &OnSuccess, FErrorHandler const &OnError)
	Claim Season Rewards.
FAccelByteTaskWPtr	BulkClaimRewards (THandler< FAccelByteModelsSeasonClaimRewardResponse > const &OnSuccess, FErrorHandler const &OnError)
	Bulk claim season rewards.
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

Season Pass APIs to access Season Pass service. User can obtaining season and claiming rewards.

Member Function Documentation

BulkClaimRewards()

FAccelByteTaskWPtr AccelByte::Api::SeasonPass::BulkClaimRewards	(	THandler< FAccelByteModelsSeasonClaimRewardResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk claim season rewards.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsSeasonClaimRewardResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

ClaimRewards()

FAccelByteTaskWPtr AccelByte::Api::SeasonPass::ClaimRewards	(	FAccelByteModelsSeasonClaimRewardRequest const &	RewardRequest,
		THandler< FAccelByteModelsSeasonClaimRewardResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Claim Season Rewards.

Parameters

RewardRequest	Detail information for the Reward Request.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsSeasonClaimRewardResponse.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetCurrentSeason()

FAccelByteTaskWPtr AccelByte::Api::SeasonPass::GetCurrentSeason	(	FString const &	Language,
		THandler< FAccelByteModelsSeasonInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get current active season.

Parameters

Language	The language of the Season.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsSeasonInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetCurrentUserSeason()

FAccelByteTaskWPtr AccelByte::Api::SeasonPass::GetCurrentUserSeason	(	THandler< FAccelByteModelsUserSeasonInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get current active user season data.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserSeasonInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetUserSeason()

FAccelByteTaskWPtr AccelByte::Api::SeasonPass::GetUserSeason	(	FString const &	SeasonId,
		THandler< FAccelByteModelsUserSeasonInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user season data by SeasonId.

Parameters

SeasonId	The Id of the Season.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUserSeasonInfo.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.