Loading...
Searching...
No Matches
AccelByte::Api::Currency Class Reference

Currency API for getting information from Currency. More...

#include <AccelByteCurrencyApi.h>

Inheritance diagram for AccelByte::Api::Currency:

Public Member Functions

 Currency (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
 Currency (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr GetCurrencyList (FString const &Namespace, THandler< TArray< FAccelByteModelsCurrencyList > > const &OnSuccess, FErrorHandler const &OnError, EAccelByteCurrencyType CurrencyType=EAccelByteCurrencyType::NONE)
 Get currency list information for a specific namespace.
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
FHttpRetrySchedulerBaseHttpRef
FHttpClient HttpClient
FAccelBytePlatformPtr AccelBytePlatformPtr

Detailed Description

Currency API for getting information from Currency.

Member Function Documentation

◆ GetCurrencyList()

FAccelByteTaskWPtr AccelByte::Api::Currency::GetCurrencyList ( FString const & Namespace,
THandler< TArray< FAccelByteModelsCurrencyList > > const & OnSuccess,
FErrorHandler const & OnError,
EAccelByteCurrencyType CurrencyType = EAccelByteCurrencyType::NONE )

Get currency list information for a specific namespace.

Parameters
NamespaceThe Namespace.
OnSuccessThis will be called when operation succeeded. The result is const FAccelByteModelsCurrencyList&.
OnErrorThis will be called when the operation failed.
CurrencyTypeThe Currency type.
Returns
AccelByteTask object to track and cancel the ongoing API operation.