AccelByte::Api::Reward Class Reference

Reward API for getting information about the reward. More...

#include <AccelByteRewardApi.h>

Inheritance diagram for AccelByte::Api::Reward:

Public Member Functions
	Reward (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Reward (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetRewardByRewardCode (FString const &RewardCode, THandler< FAccelByteModelsRewardInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get Reward from a specific Reward Code.
FAccelByteTaskWPtr	GetRewardByRewardId (FString const &RewardId, THandler< FAccelByteModelsRewardInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get Reward from a specific Reward Id.
FAccelByteTaskWPtr	QueryRewards (FString const &EventTopic, int32 Offset, int32 Limit, EAccelByteRewardListSortBy const &SortBy, THandler< FAccelByteModelsQueryReward > const &OnSuccess, FErrorHandler const &OnError)
	Query all Reward from a specific Event Topic.
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

Reward API for getting information about the reward.

Member Function Documentation

GetRewardByRewardCode()

FAccelByteTaskWPtr AccelByte::Api::Reward::GetRewardByRewardCode	(	FString const &	RewardCode,
		THandler< FAccelByteModelsRewardInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Reward from a specific Reward Code.

Parameters

RewardCode	The RewardCode.
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsRewardInfoByCode&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetRewardByRewardId()

FAccelByteTaskWPtr AccelByte::Api::Reward::GetRewardByRewardId	(	FString const &	RewardId,
		THandler< FAccelByteModelsRewardInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Reward from a specific Reward Id.

Parameters

RewardId	The RewardId.
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsRewardInfoByCode&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

QueryRewards()

FAccelByteTaskWPtr AccelByte::Api::Reward::QueryRewards	(	FString const &	EventTopic,
		int32	Offset,
		int32	Limit,
		EAccelByteRewardListSortBy const &	SortBy,
		THandler< FAccelByteModelsQueryReward > const &	OnSuccess,
		FErrorHandler const &	OnError )

Query all Reward from a specific Event Topic.

Parameters

EventTopic
Offset	Offset of the data limit.
Limit	Limit of the data that gonna get.
SortBy	SortBy namespace, namespace:asc, namespace:desc, rewardcode, rewardcode:asc, rewardcode:desc
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsQueryReward&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.