SDK for / Overview

UXsollaStoreSubsystem Class Reference

Inheritance diagram for UXsollaStoreSubsystem:

Public Member Functions

virtual void Initialize (FSubsystemCollectionBase &Collection) override
 
virtual void Deinitialize () override
 
void Initialize (const FString &InProjectId)
 
void GetVirtualItems (const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnStoreItemsUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0, const FString &AuthToken=TEXT(""))
 
void GetItemGroups (const FString &Locale, const FOnItemGroupsUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetVirtualCurrencies (const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnVirtualCurrenciesUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetVirtualCurrencyPackages (const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnVirtualCurrencyPackagesUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0, const FString &AuthToken=TEXT(""))
 
void GetItemsListBySpecifiedGroup (const FString &ExternalId, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGetItemsListBySpecifiedGroup &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0, const FString &AuthToken=TEXT(""))
 
void GetAllItemsList (const FString &Locale, const FOnGetItemsList &SuccessCallback, const FOnError &ErrorCallback, const FString &AuthToken=TEXT(""))
 
void FetchPaymentToken (const FString &AuthToken, const FString &ItemSKU, const FString &Currency, const FString &Country, const FString &Locale, const FXsollaParameters CustomParameters, const FOnFetchTokenSuccess &SuccessCallback, const FOnError &ErrorCallback, const int32 Quantity=1)
 
void FetchCartPaymentToken (const FString &AuthToken, const FString &CartId, const FString &Currency, const FString &Country, const FString &Locale, const FXsollaParameters CustomParameters, const FOnFetchTokenSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void LaunchPaymentConsole (UObject *WorldContextObject, const int32 OrderId, const FString &AccessToken, const FOnStoreSuccessPayment &SuccessCallback, const FOnError &ErrorCallback)
 
void CheckPendingOrder (const FString &AccessToken, const int32 OrderId, const FOnStoreSuccessPayment &SuccessCallback, const FOnError &ErrorCallback)
 
void ShortPollingCheckOrder (const FString &AccessToken, const int32 OrderId, const FOnStoreSuccessPayment &SuccessCallback, const FOnError &ErrorCallback)
 
void CheckOrder (const FString &AuthToken, const int32 OrderId, const FOnCheckOrder &SuccessCallback, const FOnError &ErrorCallback)
 
void ClearCart (const FString &AuthToken, const FString &CartId, const FOnStoreCartUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void UpdateCart (const FString &AuthToken, const FString &CartId, const FString &Currency, const FString &Locale, const FOnStoreCartUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void AddToCart (const FString &AuthToken, const FString &CartId, const FString &ItemSKU, const int32 Quantity, const FOnStoreCartUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void RemoveFromCart (const FString &AuthToken, const FString &CartId, const FString &ItemSKU, const FOnStoreCartUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void FillCartById (const FString &AuthToken, const FString &CartId, const TArray< FStoreCartItem > &Items, const FOnStoreCartUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetSpecifiedBundle (const FString &Sku, const FOnGetSpecifiedBundleUpdate &SuccessCallback, const FOnError &ErrorCallback, const FString &AuthToken=TEXT(""))
 
void GetBundles (const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGetListOfBundlesUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0, const FString &AuthToken=TEXT(""))
 
void GetVirtualCurrency (const FString &CurrencySKU, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnCurrencyUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetVirtualCurrencyPackage (const FString &PackageSKU, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnCurrencyPackageUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void BuyItemWithVirtualCurrency (const FString &AuthToken, const FString &ItemSKU, const FString &CurrencySKU, const EXsollaPublishingPlatform Platform, const FOnPurchaseUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetPromocodeRewards (const FString &AuthToken, const FString &PromocodeCode, const FOnGetPromocodeRewardsUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void RedeemPromocode (const FString &AuthToken, const FString &PromocodeCode, const FOnPromocodeUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void RemovePromocodeFromCart (const FString &AuthToken, const FOnPromocodeUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetGamesList (const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnStoreGamesUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetGamesListBySpecifiedGroup (const FString &ExternalId, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGetGamesListBySpecifiedGroup &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetGameItem (const FString &GameSKU, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGameUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetGameKeyItem (const FString &ItemSKU, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGameKeyUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetGameKeysListBySpecifiedGroup (const FString &ExternalId, const FString &Locale, const FString &Country, const TArray< FString > &AdditionalFields, const FOnGetGameKeysListBySpecifiedGroup &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetDRMList (const FOnDRMListUpdate &SuccessCallback, const FOnError &ErrorCallback)
 
void GetOwnedGames (const FString &AuthToken, const TArray< FString > &AdditionalFields, const FOnOwnedGamesListUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0, const bool bIsSandbox=false)
 
void RedeemGameCodeByClient (const FString &AuthToken, const FString &Code, const FOnRedeemGameCodeSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void GetSubscriptionPublicPlans (const TArray< int > PlanId, const TArray< FString > &PlanExternalId, const FString &Country, const FString &Locale, const FOnSubscriptionPublicPlansListUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetSubscriptionPlans (const FString &AuthToken, const TArray< int > PlanId, const TArray< FString > &PlanExternalId, const FString &Country, const FString &Locale, const FOnSubscriptionPlansListUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetSubscriptions (const FString &AuthToken, const FString &Locale, const FOnSubscriptionsListUpdate &SuccessCallback, const FOnError &ErrorCallback, const int Limit=50, const int Offset=0)
 
void GetSubscriptionDetails (const FString &AuthToken, const int32 SubscriptionId, const FString &Locale, const FOnGetSubscriptionDetailsSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void GetSubscriptionPurchaseUrl (const FString &AuthToken, const FString &PlanExternalId, const FString &Country, const FOnGetSubscriptionPayStationLinkSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void GetSubscriptionManagementUrl (const FString &AuthToken, const FString &Country, const FOnGetSubscriptionPayStationLinkSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void GetSubscriptionRenewalUrl (const FString &AuthToken, const int32 SubscriptionId, const FOnGetSubscriptionPayStationLinkSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
void CancelSubscription (const FString &AuthToken, const int32 SubscriptionId, const FOnCancelSubscriptionSuccess &SuccessCallback, const FOnError &ErrorCallback)
 
TArray< FStoreItemGetVirtualItemsWithoutGroup () const
 
const FStoreItemsDataGetItemsData () const
 
const FStoreCartGetCart () const
 
const FString & GetPendingPaystationUrl () const
 
FString GetItemName (const FString &ItemSKU) const
 
const FStoreItemFindItemBySku (const FString &ItemSku, bool &bHasFound) const
 
const FVirtualCurrencyPackageFindVirtualCurrencyPackageBySku (const FString &ItemSku, bool &bHasFound) const
 
bool IsItemInCart (const FString &ItemSKU) const
 

Public Attributes

FOnCartUpdate OnCartUpdate
 

Protected Member Functions

void GetVirtualItems_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreItemsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetItemGroups_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnItemGroupsUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetVirtualCurrencies_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnVirtualCurrenciesUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetVirtualCurrencyPackages_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnVirtualCurrencyPackagesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetItemsListBySpecifiedGroup_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetItemsListBySpecifiedGroup SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetAllItemsList_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetItemsList SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void FetchPaymentToken_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnFetchTokenSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void CheckOrder_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnCheckOrder SuccessCallback, FOnError ErrorCallback)
 
void CreateCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FOnError ErrorCallback)
 
void ClearCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FOnError ErrorCallback)
 
void UpdateCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FOnError ErrorCallback)
 
void AddToCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FOnError ErrorCallback)
 
void RemoveFromCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FOnError ErrorCallback)
 
void FillCartById_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetListOfBundles_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetListOfBundlesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetSpecifiedBundle_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetSpecifiedBundleUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetVirtualCurrency_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnCurrencyUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetVirtualCurrencyPackage_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnCurrencyPackageUpdate SuccessCallback, FOnError ErrorCallback)
 
void BuyItemWithVirtualCurrency_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetPromocodeRewards_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetPromocodeRewardsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void RedeemPromocode_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void RemovePromocodeFromCart_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetGamesList_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnStoreGamesUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetGamesListBySpecifiedGroup_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetGamesListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback)
 
void GetGameItem_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGameUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetGameKeyItem_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGameKeyUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetGameKeysListBySpecifiedGroup_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetGameKeysListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback)
 
void GetDRMList_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnDRMListUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetOwnedGames_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnOwnedGamesListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void RedeemGameCodeByClient_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnRedeemGameCodeSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetSubscriptionPublicPlans_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnSubscriptionPublicPlansListUpdate SuccessCallback, FOnError ErrorCallback)
 
void GetSubscriptionPlans_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnSubscriptionPlansListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetSubscriptions_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnSubscriptionsListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetSubscriptionDetails_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetSubscriptionDetailsSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void GetSubscriptionPaystationLink_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnGetSubscriptionPayStationLinkSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void CancelSubscription_HttpRequestComplete (FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, const bool bSucceeded, FOnCancelSubscriptionSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper)
 
void HandleRequestError (XsollaHttpRequestError ErrorData, FOnError ErrorCallback)
 
void LoadData ()
 
void SaveData ()
 
bool IsSandboxEnabled () const
 

Protected Attributes

FString ProjectID
 
FStoreItemsData ItemsData
 
FStoreCart Cart
 
FVirtualCurrencyPackagesData VirtualCurrencyPackages
 
FString CachedCartCurrency
 
FString CachedAuthToken
 
FString CachedCartId
 
FString CachedCartLocale
 
FString PengindPaystationUrl
 
UXsollaWebBrowserWrapperMyBrowser
 

Member Function Documentation

◆ AddToCart()

void UXsollaStoreSubsystem::AddToCart (const FString & AuthToken,
const FString & CartId,
const FString & ItemSKU,
const int32 Quantity,
const FOnStoreCartUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Add to Cart Adds an item to the cart and changes its quantity.

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of a cart to which item will be added. The current user cart will be modified if empty.
ItemSKUDesired item SKU.
QuantityAmount of items to be added to the cart.
SuccessCallbackCallback function called after successfully adding a new item to the cart.
ErrorCallbackCallback function called after the request resulted with an error.

◆ BuyItemWithVirtualCurrency()

void UXsollaStoreSubsystem::BuyItemWithVirtualCurrency (const FString & AuthToken,
const FString & ItemSKU,
const FString & CurrencySKU,
const EXsollaPublishingPlatform Platform,
const FOnPurchaseUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Buy Item with Virtual Currency Buys an item using virtual currency.

Parameters
AuthTokenUser authorization token.
ItemSKUDesired item SKU.
CurrencySKUCurrency to buy virtual items with.
PlatformTarget platform
SuccessCallbackCallback function called after the successful item purchase.
ErrorCallbackCallback function called after the request resulted with an error.

◆ CancelSubscription()

void UXsollaStoreSubsystem::CancelSubscription (const FString & AuthToken,
const int32 SubscriptionId,
const FOnCancelSubscriptionSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Cancel Subscription Changes a regular subscription status to non_renewing (subscription is automatically canceled after expiration).

Parameters
AuthTokenUser authorization token.
SubscriptionIdSubscription ID. Required.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ CheckPendingOrder()

void UXsollaStoreSubsystem::CheckPendingOrder (const FString & AccessToken,
const int32 OrderId,
const FOnStoreSuccessPayment & SuccessCallback,
const FOnError & ErrorCallback 
)

Check Pending Order Checks pending order

Parameters
AccessTokenPayment token used during purchase processing.
OrderIdIdentifier of order.
SuccessCallbackCallback function called after the payment was successfully completed.
ErrorCallbackCallback function called after the request resulted with an error.

◆ ClearCart()

void UXsollaStoreSubsystem::ClearCart (const FString & AuthToken,
const FString & CartId,
const FOnStoreCartUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Clear Cart Removes all items from the cart.

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of a cart to be cleared. The current user cart will be cleared if empty.
SuccessCallbackCallback function called after successful cart clearing.
ErrorCallbackCallback function called after the request resulted with an error.

◆ FetchCartPaymentToken()

void UXsollaStoreSubsystem::FetchCartPaymentToken (const FString & AuthToken,
const FString & CartId,
const FString & Currency,
const FString & Country,
const FString & Locale,
const FXsollaParameters CustomParameters,
const FOnFetchTokenSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Fetch Cart Payment Token Initiates a cart purchase session and fetches a token for payment console.

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of the cart for the purchase. The current user cart will be purchased if empty.
Currency(optional) Desired payment currency. Leave empty to use the default value.
Country(optional) Desired payment country ISO code. Leave empty to use the default value.
Locale(optional) Desired payment locale. Leave empty to use the default value.
CustomParameters(optional) Map of custom parameters. Leave empty to use the default value.
SuccessCallbackCallback function called after the payment token was successfully fetched.
ErrorCallbackCallback function called after the request resulted with an error.

◆ FetchPaymentToken()

void UXsollaStoreSubsystem::FetchPaymentToken (const FString & AuthToken,
const FString & ItemSKU,
const FString & Currency,
const FString & Country,
const FString & Locale,
const FXsollaParameters CustomParameters,
const FOnFetchTokenSuccess & SuccessCallback,
const FOnError & ErrorCallback,
const int32 Quantity = 1 
)

Fetch Payment Token Initiates an item purchase session and fetches token for payment console.

Parameters
AuthTokenUser authorization token.
ItemSKUDesired item SKU.
Currency(optional) Desired payment currency. Leave empty to use the default value.
Country(optional) Desired payment country ISO code. Leave empty to use the default value.
Locale(optional) Desired payment locale. Leave empty to use the default value.
CustomParameters(optional) Map of custom parameters. Leave empty to use the default value.
SuccessCallbackCallback function called after payment token was successfully fetched.
ErrorCallbackCallback function called after the request resulted with an error.
QuantityItem quantity.

◆ FillCartById()

void UXsollaStoreSubsystem::FillCartById (const FString & AuthToken,
const FString & CartId,
const TArray< FStoreCartItem > & Items,
const FOnStoreCartUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Fill Cart By ID Fills out the specific cart with items. If the cart already has an item, the existing item position will be replaced by the given value.

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of cart which will be filled. The current user cart will be filled if empty.
ItemsItem for filling the cart.
SuccessCallbackCallback function called after cart is successfully filled.
ErrorCallbackCallback function called after the request resulted with an error.

◆ FindItemBySku()

const FStoreItem & UXsollaStoreSubsystem::FindItemBySku (const FString & ItemSku,
bool & bHasFound 
) const

Gets item from the cache with the given SKU.

◆ FindVirtualCurrencyPackageBySku()

const FVirtualCurrencyPackage & UXsollaStoreSubsystem::FindVirtualCurrencyPackageBySku (const FString & ItemSku,
bool & bHasFound 
) const

Gets package from the cache with the given SKU.

◆ GetAllItemsList()

void UXsollaStoreSubsystem::GetAllItemsList (const FString & Locale,
const FOnGetItemsList & SuccessCallback,
const FOnError & ErrorCallback,
const FString & AuthToken = TEXT("") 
)

Get All Items List Gets a list of all virtual items.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
SuccessCallbackCallback function called after server response.
ErrorCallbackCallback function called after the request resulted with an error.
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetBundles()

void UXsollaStoreSubsystem::GetBundles (const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGetListOfBundlesUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0,
const FString & AuthToken = TEXT("") 
)

Get Bundles Gets a list of bundles for building a catalog.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after bundles are successfully received.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetCart()

const FStoreCart & UXsollaStoreSubsystem::GetCart () const

Gets cached cart data

◆ GetDRMList()

void UXsollaStoreSubsystem::GetDRMList (const FOnDRMListUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get DRM List Gets the list of available DRMs.

Parameters
SuccessCallbackCallback function called after successful request of specified DRM data.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetGameItem()

void UXsollaStoreSubsystem::GetGameItem (const FString & GameSKU,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGameUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Game Item Gets a game item with the specified SKU for the catalog.

Parameters
GameSKUDesired game SKU.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified game data.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetGameKeyItem()

void UXsollaStoreSubsystem::GetGameKeyItem (const FString & ItemSKU,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGameKeyUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Game Key Item Gets a game key item with the specified SKU for the catalog.

Parameters
ItemSKUDesired game item SKU.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified game data.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetGameKeysListBySpecifiedGroup()

void UXsollaStoreSubsystem::GetGameKeysListBySpecifiedGroup (const FString & ExternalId,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGetGameKeysListBySpecifiedGroup & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Game Key List Gets a game key list from the specified group for building a catalog.

Parameters
ExternalIdGroup external ID.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address in not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified game key data.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).

◆ GetGamesList()

void UXsollaStoreSubsystem::GetGamesList (const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnStoreGamesUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Games Gets list of games for building a catalog.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calcualtions are based on the user's IP address if the country is not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified games list data.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).

◆ GetGamesListBySpecifiedGroup()

void UXsollaStoreSubsystem::GetGamesListBySpecifiedGroup (const FString & ExternalId,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGetGamesListBySpecifiedGroup & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Games By Specified Group Gets the list of games from the specified group for building a catalog.

Parameters
ExternalIdGroup external ID.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1.
CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculations are based on the user's IP address if the country is not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified game list data.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).

◆ GetItemGroups()

void UXsollaStoreSubsystem::GetItemGroups (const FString & Locale,
const FOnItemGroupsUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Item Groups Gets the list of virtual item groups.

Parameters
Locale(optional) Response language (e.g. item name, item description). Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
SuccessCallbackCallback function called after virtual item groups were successfully received.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).

◆ GetItemName()

FString UXsollaStoreSubsystem::GetItemName (const FString & ItemSKU) const

Gets name of the cached item with the given SKU.

◆ GetItemsData()

const FStoreItemsData & UXsollaStoreSubsystem::GetItemsData () const

Gets cached items data.

◆ GetItemsListBySpecifiedGroup()

void UXsollaStoreSubsystem::GetItemsListBySpecifiedGroup (const FString & ExternalId,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnGetItemsListBySpecifiedGroup & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0,
const FString & AuthToken = TEXT("") 
)

Get Items List By Specified Group Gets an item list from the specified group for building a catalog.

Parameters
ExternalIdGroup external ID.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after server response.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count start from 0).
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetOwnedGames()

void UXsollaStoreSubsystem::GetOwnedGames (const FString & AuthToken,
const TArray< FString > & AdditionalFields,
const FOnOwnedGamesListUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0,
const bool bIsSandbox = false 
)

Get Owned Games Gets the list of games owned by the user. The response will contain an array of games owned by a particular user.

Parameters
AuthTokenUser authorization token.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields 'attributes'.
SuccessCallbackCallback function called after successful request of specified owned games data.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).
bIsSandboxWhat type of entitlements should be returned. If the parameter is set to true, the entitlements received by the user in the sandbox mode only are returned. If the parameter is set to false, the entitlements received by the user in the live mode only are returned.

◆ GetPendingPaystationUrl()

const FString & UXsollaStoreSubsystem::GetPendingPaystationUrl () const

Gets the pending PayStation URL to be opened in browser.

◆ GetPromocodeRewards()

void UXsollaStoreSubsystem::GetPromocodeRewards (const FString & AuthToken,
const FString & PromocodeCode,
const FOnGetPromocodeRewardsUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Promocode Rewards Gets promo code rewards by its code. Can be used to let users choose one of many items as a bonus. The usual case is choosing a DRM if the promo code contains a game as a bonus (type=unit).

Parameters
AuthTokenUser authorization token.
PromocodeCodeUnique case sensitive code. Contains letters and numbers.
SuccessCallbackCallback function called after successfully receiving promocode rewards.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetSpecifiedBundle()

void UXsollaStoreSubsystem::GetSpecifiedBundle (const FString & Sku,
const FOnGetSpecifiedBundleUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const FString & AuthToken = TEXT("") 
)

Get Specified Bundle Gets a specified bundle.

Parameters
SkuBundle SKU.
SuccessCallbackCallback function called after the cart is successfully filled.
ErrorCallbackCallback function called after the request resulted with an error.
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetSubscriptionDetails()

void UXsollaStoreSubsystem::GetSubscriptionDetails (const FString & AuthToken,
const int32 SubscriptionId,
const FString & Locale,
const FOnGetSubscriptionDetailsSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Subscriptions Details Returns information about a subscription by its ID. Subscription can be have any status.

Parameters
AuthTokenUser authorization token.
SubscriptionIdSubscription ID. Required.
LocaleLanguage of the UI. By default, it is determined by the user's IP address. Can be enforced by using an ISO 639-1 code.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetSubscriptionManagementUrl()

void UXsollaStoreSubsystem::GetSubscriptionManagementUrl (const FString & AuthToken,
const FString & Country,
const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Subscription Management Url Returns Pay Station URL for the subscription management.

Parameters
AuthTokenUser authorization token.
CountryUser's country. Affects the choice of locale and currency. By default, it is determined by the user's IP address.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetSubscriptionPlans()

void UXsollaStoreSubsystem::GetSubscriptionPlans (const FString & AuthToken,
const TArray< int > PlanId,
const TArray< FString > & PlanExternalId,
const FString & Country,
const FString & Locale,
const FOnSubscriptionPlansListUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Subscription Plans Returns a list of all plans, including plans purchased by the user while promotions are active.

Parameters
AuthTokenUser authorization token.
PlanIdArray of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{merplan_id}).
PlanExternalIdArray of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
CountryUser's country. Affects the choice of locale and currency. By default, it is determined by the user's IP address.
LocaleLanguage of the UI. By default, it is determined by the user's IP address. Can be enforced by using an ISO 639-1 code.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page (15 elements are displayed by default).
OffsetNumber of elements from which the list is generated (the count starts from 0).

◆ GetSubscriptionPublicPlans()

void UXsollaStoreSubsystem::GetSubscriptionPublicPlans (const TArray< int > PlanId,
const TArray< FString > & PlanExternalId,
const FString & Country,
const FString & Locale,
const FOnSubscriptionPublicPlansListUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Subscription Public Plans Returns a list of all plans, including plans purchased by the user while promotions are active.

Parameters
PlanIdArray of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{merplan_id}).
PlanExternalIdArray of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
CountryUser's country. Affects the choice of locale and currency. By default, it is determined by the user's IP address.
LocaleLanguage of the UI. By default, it is determined by the user's IP address. Can be enforced by using an ISO 639-1 code.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page (15 elements are displayed by default).
OffsetNumber of elements from which the list is generated (the count starts from 0).

◆ GetSubscriptionPurchaseUrl()

void UXsollaStoreSubsystem::GetSubscriptionPurchaseUrl (const FString & AuthToken,
const FString & PlanExternalId,
const FString & Country,
const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Subscription Purchase Url Returns Pay Station URL for the subscription purchase.

Parameters
AuthTokenUser authorization token.
PlanExternalIdSubscription plan external ID (32 characters). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
CountryUser's country. Affects the choice of locale and currency. By default, it is determined by the user's IP address.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetSubscriptionRenewalUrl()

void UXsollaStoreSubsystem::GetSubscriptionRenewalUrl (const FString & AuthToken,
const int32 SubscriptionId,
const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Subscription Renewal Url Returns Pay Station URL for the subscription renewal.

Parameters
AuthTokenUser authorization token.
SubscriptionIdSubscription ID. Required.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetSubscriptions()

void UXsollaStoreSubsystem::GetSubscriptions (const FString & AuthToken,
const FString & Locale,
const FOnSubscriptionsListUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Subscriptions Returns a list of active recurrent subscriptions that have the status active, non renewing, and pause.

Parameters
AuthTokenUser authorization token.
LocaleLanguage of the UI. By default, it is determined by the user's IP address. Can be enforced by using an ISO 639-1 code.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page (15 elements are displayed by default).
OffsetNumber of elements from which the list is generated (the count starts from 0).

◆ GetVirtualCurrencies()

void UXsollaStoreSubsystem::GetVirtualCurrencies (const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnVirtualCurrenciesUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0 
)

Get Virtual Currencies Gets the list of virtual currencies.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address in not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields 'media_list', 'order' and 'long_description'.
SuccessCallbackCallback function called after virtual currencies were successfully received.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).

◆ GetVirtualCurrency()

void UXsollaStoreSubsystem::GetVirtualCurrency (const FString & CurrencySKU,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnCurrencyUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Virtual Currency Gets virtual currency with specified SKU.

Parameters
CurrencySKUDesired currency SKU.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after successful request of specified virtual currency data.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetVirtualCurrencyPackage()

void UXsollaStoreSubsystem::GetVirtualCurrencyPackage (const FString & PackageSKU,
const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnCurrencyPackageUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Get Virtual Currency Package Gets virtual currency package with specified SKU.

Parameters
PackageSKUDesired currency package SKU
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields 'media_list', 'order' and 'long_description'.
SuccessCallbackCallback function called after successful request of specified virtual currency package data.
ErrorCallbackCallback function called after the request resulted with an error.

◆ GetVirtualCurrencyPackages()

void UXsollaStoreSubsystem::GetVirtualCurrencyPackages (const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnVirtualCurrencyPackagesUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0,
const FString & AuthToken = TEXT("") 
)

Get Virtual Currency Packages Gets the list of virtual currency packages.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
SuccessCallbackCallback function called after virtual currency packages were successfully received.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetVirtualItems()

void UXsollaStoreSubsystem::GetVirtualItems (const FString & Locale,
const FString & Country,
const TArray< FString > & AdditionalFields,
const FOnStoreItemsUpdate & SuccessCallback,
const FOnError & ErrorCallback,
const int Limit = 50,
const int Offset = 0,
const FString & AuthToken = TEXT("") 
)

Get Virtual Items Gets the list of virtual items available for the configured project.

Parameters
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
CountryCountry to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. Calculated based on the user's IP address if not specified.
AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields 'media_list', 'order' and 'long_description'.
SuccessCallbackCallback function called after virtual items were successfully received.
ErrorCallbackCallback function called after the request resulted with an error.
LimitLimit for the number of elements on the page.
OffsetNumber of the element from which the list is generated (the count starts from 0).
AuthTokenUser JWT obtained during authorization using Xsolla Login (Bearer token). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

◆ GetVirtualItemsWithoutGroup()

TArray< FStoreItem > UXsollaStoreSubsystem::GetVirtualItemsWithoutGroup () const

Gets the list of cached virtual items without any Category provided.

◆ HandleRequestError()

void UXsollaStoreSubsystem::HandleRequestError (XsollaHttpRequestError ErrorData,
FOnError ErrorCallback 
)
protected

Return true if error is happened

◆ Initialize()

void UXsollaStoreSubsystem::Initialize (const FString & InProjectId)

Initializes the controller with the provided Project ID (used to override project settings).

Parameters
InProjectIdNew Project ID value from Publisher Account > Project settings > Project ID.

◆ IsItemInCart()

bool UXsollaStoreSubsystem::IsItemInCart (const FString & ItemSKU) const

Checks if the certain item is in the cart.

◆ IsSandboxEnabled()

bool UXsollaStoreSubsystem::IsSandboxEnabled () const
protected

Check whether sandbox is enabled

◆ LaunchPaymentConsole()

void UXsollaStoreSubsystem::LaunchPaymentConsole (UObject * WorldContextObject,
const int32 OrderId,
const FString & AccessToken,
const FOnStoreSuccessPayment & SuccessCallback,
const FOnError & ErrorCallback 
)

Launch Payment Console Opens payment console for the provided access token.

Parameters
WorldContextObjectThe world context.
OrderIdIdentifier of order.
AccessTokenPayment token used during purchase processing.
SuccessCallbackCallback function called after the payment was successfully completed.
ErrorCallbackCallback function called after the request resulted with an error.

◆ LoadData()

void UXsollaStoreSubsystem::LoadData ()
protected

Load save game and extract data

◆ RedeemGameCodeByClient()

void UXsollaStoreSubsystem::RedeemGameCodeByClient (const FString & AuthToken,
const FString & Code,
const FOnRedeemGameCodeSuccess & SuccessCallback,
const FOnError & ErrorCallback 
)

Redeem Game Code By Client Grants an entitlement by a provided game code.

Parameters
AuthTokenUser authorization token.
CodeGame code.
SuccessCallbackCallback function called after successful redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ RedeemPromocode()

void UXsollaStoreSubsystem::RedeemPromocode (const FString & AuthToken,
const FString & PromocodeCode,
const FOnPromocodeUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Redeem Promocode Redeems a promo code. After redeeming a promo code, the user will get free items and/or the price of cart will be decreased.

Parameters
AuthTokenUser authorization token.
PromocodeCodeUnique case sensitive code. Contains letters and numbers.
SuccessCallbackCallback function called after successful promocode redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ RemoveFromCart()

void UXsollaStoreSubsystem::RemoveFromCart (const FString & AuthToken,
const FString & CartId,
const FString & ItemSKU,
const FOnStoreCartUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Remove from Cart Completely removes an item from the cart.

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of a cart from which the item will be removed. The current user cart will be modified if empty.
ItemSKUDesired item SKU.
SuccessCallbackCallback function called after successfully removing an item from the cart.
ErrorCallbackCallback function called after the request resulted with an error.

◆ RemovePromocodeFromCart()

void UXsollaStoreSubsystem::RemovePromocodeFromCart (const FString & AuthToken,
const FOnPromocodeUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Remove Promocode From Cart Removes a promo code from a cart. After the promo code is removed, the total price of all items in the cart will be recalculated without bonuses and discounts provided by a promo code.

Parameters
AuthTokenUser authorization token.
SuccessCallbackCallback function called after successful promocode redemption.
ErrorCallbackCallback function called after the request resulted with an error.

◆ SaveData()

void UXsollaStoreSubsystem::SaveData ()
protected

Save cached data or reset one if necessary

◆ UpdateCart()

void UXsollaStoreSubsystem::UpdateCart (const FString & AuthToken,
const FString & CartId,
const FString & Currency,
const FString & Locale,
const FOnStoreCartUpdate & SuccessCallback,
const FOnError & ErrorCallback 
)

Update Cart Updates cart content (cached locally).

Parameters
AuthTokenUser authorization token.
CartId(optional) Identifier of the cart to be updated. The current user cart will be updated if empty.
CurrencyThe currency in which prices are displayed (USD by default). Three-letter currency code per ISO 4217.
LocaleResponse language. Two-letter lowercase language code per ISO 639-1. Leave empty to use the default value.
SuccessCallbackCallback function called after local cache of cart items was successfully updated.
ErrorCallbackCallback function called after the request resulted with an error.

Member Data Documentation

◆ CachedAuthToken

FString UXsollaStoreSubsystem::CachedAuthToken
protected

Cached auth token (used for silent cart update)

◆ CachedCartCurrency

FString UXsollaStoreSubsystem::CachedCartCurrency
protected

Cached cart desired currency (used for silent cart update)

◆ CachedCartId

FString UXsollaStoreSubsystem::CachedCartId
protected

Cached cart identifier (used for silent cart update)

◆ CachedCartLocale

FString UXsollaStoreSubsystem::CachedCartLocale
protected

Cached cart locale (used for silent cart update)

◆ Cart

FStoreCart UXsollaStoreSubsystem::Cart
protected

Current cart

◆ ItemsData

FStoreItemsData UXsollaStoreSubsystem::ItemsData
protected

Cached virtual items list

◆ OnCartUpdate

FOnCartUpdate UXsollaStoreSubsystem::OnCartUpdate

Event occurred when the cart was changed or updated.

◆ PengindPaystationUrl

FString UXsollaStoreSubsystem::PengindPaystationUrl
protected

Pending PayStation URL to be opened in browser

◆ ProjectID

FString UXsollaStoreSubsystem::ProjectID
protected

Cached Xsolla Store project id

◆ VirtualCurrencyPackages

FVirtualCurrencyPackagesData UXsollaStoreSubsystem::VirtualCurrencyPackages
protected

Cached virtual currency packages


The documentation for this class was generated from the following file: