AccelByte::Api::Wallet Class Reference

Wallet API for buying things from the online store; a wallet can be a virtual or real currency. More...

#include <AccelByteWalletApi.h>

Inheritance diagram for AccelByte::Api::Wallet:

Public Member Functions
	Wallet (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Wallet (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetWalletInfoByCurrencyCode (FString const &CurrencyCode, THandler< FAccelByteModelsWalletInfo > const &OnSuccess, FErrorHandler const &OnError)
	Get user's wallet information for a specific currency code.
FAccelByteTaskWPtr	GetWalletInfoByCurrencyCodeV2 (FString const &CurrencyCode, THandler< FAccelByteModelsWalletInfoResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get user's wallet information for a specific currency code.
FAccelByteTaskWPtr	ListWalletTransactionsByCurrencyCode (FString const &CurrencyCode, THandler< FAccelByteModelsWalletTransactionPaging > const &OnSuccess, FErrorHandler const &OnError, int32 Offset=0, int32 Limit=20)
	Get user's wallet transactions list for a specific currency code.
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

Wallet API for buying things from the online store; a wallet can be a virtual or real currency.

Member Function Documentation

GetWalletInfoByCurrencyCode()

FAccelByteTaskWPtr AccelByte::Api::Wallet::GetWalletInfoByCurrencyCode	(	FString const &	CurrencyCode,
		THandler< FAccelByteModelsWalletInfo > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's wallet information for a specific currency code.

Parameters

CurrencyCode	The currency code.
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsWalletInfo&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetWalletInfoByCurrencyCodeV2()

FAccelByteTaskWPtr AccelByte::Api::Wallet::GetWalletInfoByCurrencyCodeV2	(	FString const &	CurrencyCode,
		THandler< FAccelByteModelsWalletInfoResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user's wallet information for a specific currency code.

Parameters

CurrencyCode	The currency code.
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsWalletResponse&.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

ListWalletTransactionsByCurrencyCode()

FAccelByteTaskWPtr AccelByte::Api::Wallet::ListWalletTransactionsByCurrencyCode	(	FString const &	CurrencyCode,
		THandler< FAccelByteModelsWalletTransactionPaging > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Offset = 0,
		int32	Limit = 20 )

Get user's wallet transactions list for a specific currency code.

Parameters

CurrencyCode	The currency code.
OnSuccess	This will be called when operation succeeded. The result is const FAccelByteModelsWalletTransactionPaging&.
OnError	This will be called when the operation failed.
Offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0).
Limit	The limit of item on page (optional, default = 20).

Returns

AccelByteTask object to track and cancel the ongoing API operation.