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

Fulfillment API for user to fulfill an item to their entitlements. More...

#include <AccelByteFulfillmentApi.h>

Inheritance diagram for AccelByte::Api::Fulfillment:

Public Member Functions

 Fulfillment (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
 Fulfillment (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr RedeemCode (FString const &Code, FString const &Region, FString const &Language, THandler< FAccelByteModelsFulfillmentResult > const &OnSuccess, FErrorHandler const &OnError)
 Redeem Campaign Code to Receive In Game Item.
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

Fulfillment API for user to fulfill an item to their entitlements.

Member Function Documentation

◆ RedeemCode()

FAccelByteTaskWPtr AccelByte::Api::Fulfillment::RedeemCode ( FString const & Code,
FString const & Region,
FString const & Language,
THandler< FAccelByteModelsFulfillmentResult > const & OnSuccess,
FErrorHandler const & OnError )

Redeem Campaign Code to Receive In Game Item.

Parameters
CodeThe campaign code to redeem.
RegionRegion of the item. If not set, the region from the access token will be used.
LanguageDisplay language.null If not set, the language from the access token will be used.
OnSuccessThis will be called when the operation success. The result is const FAccelByteModelsFulfillmentResult.
OnErrorThis will be called when the operation failed.
Returns
AccelByteTask object to track and cancel the ongoing API operation.