SDKs code references for Unreal Engine
Easily embed Xsolla services with this ready-to-use libraries for Unreal Engine applications and games.
XsollaStoreSubsystem.h
1// Copyright 2024 Xsolla Inc. All Rights Reserved.
2
3#pragma once
4
5#include "XsollaStoreDataModel.h"
6#include "XsollaUtilsHttpRequestHelper.h"
7#include "Blueprint/UserWidget.h"
8#include "Subsystems/GameInstanceSubsystem.h"
9#include "Subsystems/SubsystemCollection.h"
10#include "XsollaOrderCheckObject.h"
11#include "XsollaUtilsDataModel.h"
12#include "XsollaStoreDelegates.h"
13#include "XsollaStoreAuxiliaryDataModel.h"
14#include "XsollaStoreSubsystem.generated.h"
15
16
17enum class EXsollaPublishingPlatform : uint8;
18class FJsonObject;
19class UXsollaStoreBrowserWrapper;
20class UXsollaLoginSubsystem;
21
22DECLARE_DYNAMIC_DELEGATE(FOnStoreUpdate);
23DECLARE_DYNAMIC_DELEGATE(FOnStoreSuccessPayment);
24DECLARE_DYNAMIC_DELEGATE(FOnStoreCancelPayment);
25DECLARE_DYNAMIC_DELEGATE(FOnStoreCartUpdate);
26DECLARE_DYNAMIC_DELEGATE_OneParam(FOnStoreBrowserClosed, bool, bIsManually);
27DECLARE_DYNAMIC_DELEGATE_OneParam(FOnCartUpdate, const FStoreCart&, Cart);
28DECLARE_DYNAMIC_DELEGATE_TwoParams(FOnFetchTokenSuccess, const FString&, AccessToken, int32, OrderId);
29DECLARE_DYNAMIC_DELEGATE_ThreeParams(FOnCheckOrder, int32, OrderId, EXsollaOrderStatus, OrderStatus, FXsollaOrderContent, OrderContent);
30DECLARE_DYNAMIC_DELEGATE_OneParam(FOnCurrencyUpdate, const FVirtualCurrency&, Currency);
31DECLARE_DYNAMIC_DELEGATE_OneParam(FOnCurrencyPackageUpdate, const FVirtualCurrencyPackage&, CurrencyPackage);
32DECLARE_DYNAMIC_DELEGATE_OneParam(FOnPurchaseUpdate, int32, OrderId);
33DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetPromocodeRewardsUpdate, FStorePromocodeRewardData, RewardsData);
34DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetSpecifiedBundleUpdate, FStoreBundle, Bundle);
35DECLARE_DYNAMIC_DELEGATE_OneParam(FOnPromocodeUpdate, const FStoreCart&, Cart);
36DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetItemsList, FStoreItemsList, ItemsList);
37DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetGamesListBySpecifiedGroup, FStoreGamesList, GamesList);
38DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGameUpdate, const FGameItem&, Game);
39DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGameKeyUpdate, const FGameKeyItem&, GameKey);
40DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetGameKeysListBySpecifiedGroup, FStoreGameKeysList, GameKeysList);
41DECLARE_DYNAMIC_DELEGATE_OneParam(FOnDRMListUpdate, FStoreDRMList, DRMList);
42DECLARE_DYNAMIC_DELEGATE_OneParam(FOnOwnedGamesListUpdate, FOwnedGamesList, GamesList);
43DECLARE_DYNAMIC_DELEGATE_OneParam(FOnStoreGamesUpdate, const FStoreGamesData&, GamesData);
44DECLARE_DYNAMIC_DELEGATE_OneParam(FOnItemGroupsUpdate, const FStoreItemGroupsData&, ItemGroupsData);
45DECLARE_DYNAMIC_DELEGATE(FOnRedeemGameCodeSuccess);
46DECLARE_DYNAMIC_DELEGATE_OneParam(FOnSubscriptionPublicPlansListUpdate, FSubscriptionPlansList, SubscriptionPlansList);
47DECLARE_DYNAMIC_DELEGATE_OneParam(FOnSubscriptionPlansListUpdate, FSubscriptionPlansList, SubscriptionPlansList);
48DECLARE_DYNAMIC_DELEGATE_OneParam(FOnSubscriptionsListUpdate, FSubscriptionsList, SubscriptionsList);
49DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetSubscriptionDetailsSuccess, const FSubscriptionDetails&, SubscriptionDetails);
50DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGetSubscriptionPayStationLinkSuccess, const FString&, LinkToPaystation);
51DECLARE_DYNAMIC_DELEGATE(FOnCancelSubscriptionSuccess);
52
53UCLASS()
54class XSOLLASTORE_API UXsollaStoreSubsystem : public UGameInstanceSubsystem
55{
56 GENERATED_BODY()
57
58public:
59 UXsollaStoreSubsystem();
60
61 // Begin USubsystem
62 virtual void Initialize(FSubsystemCollectionBase& Collection) override;
63 virtual void Deinitialize() override;
64 // End USubsystem
65
71 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
72 void Initialize(const FString& InProjectId);
73
87 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
88 void GetPaginatedVirtualItems(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
89 const FOnStoreItemsUpdate& SuccessCallback, const FOnError& ErrorCallback,
90 const int Limit = 50, const int Offset = 0, const FString& AuthToken = TEXT(""));
91
102 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
103 void GetVirtualItems(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
104 const FOnStoreItemsUpdate& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
105
113 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
114 void GetItemGroups(const FString& PromoCode, const FOnItemGroupsUpdate& SuccessCallback, const FOnError& ErrorCallback);
115
128 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
129 void GetPaginatedVirtualCurrencies(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
130 const FOnVirtualCurrenciesUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
131
141 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
142 void GetVirtualCurrencies(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
143 const FOnVirtualCurrenciesUpdate& SuccessCallback, const FOnError& ErrorCallback);
144
158 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
159 void GetPaginatedVirtualCurrencyPackages(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
160 const FOnVirtualCurrencyPackagesUpdate& SuccessCallback, const FOnError& ErrorCallback,
161 const int Limit = 50, const int Offset = 0, const FString& AuthToken = TEXT(""));
162
163
174 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
175 void GetVirtualCurrencyPackages(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
176 const FOnVirtualCurrencyPackagesUpdate& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
177
192 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualItems", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
193 void GetPaginatedItemsListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
194 const FOnGetItemsListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0, const FString& AuthToken = TEXT(""));
195
207 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualItems", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
208 void GetItemsListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
209 const FOnGetItemsListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
210
219 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualItems", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
220 void GetAllItemsList(const FString& Locale, const FOnGetItemsList& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
221
231 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback, PurchaseParams"))
232 void FetchPaymentToken(const FString& AuthToken, const FString& ItemSKU,
233 const FOnFetchTokenSuccess& SuccessCallback, const FOnError& ErrorCallback, const FXsollaPaymentTokenRequestPayload& PurchaseParams);
234
244 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback, PurchaseParams"))
245 void FetchCartPaymentToken(const FString& AuthToken, const FString& CartId,
246 const FOnFetchTokenSuccess& SuccessCallback, const FOnError& ErrorCallback, const FXsollaPaymentTokenRequestPayload& PurchaseParams);
247
262 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (WorldContext = "WorldContextObject", AutoCreateRefTerm = "SuccessCallback, ErrorCallback, BrowserClosedCallback"))
263 void LaunchPaymentConsole(UObject* WorldContextObject, const int32 OrderId, const FString& AccessToken,
264 const FOnStoreSuccessPayment& SuccessCallback, const FOnError& ErrorCallback, const FOnStoreBrowserClosed& BrowserClosedCallback,
265 const EXsollaPayStationVersion PayStationVersion = EXsollaPayStationVersion::v4);
266
276 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "PurchaseParams, SuccessCallback, ErrorCallback, BrowserClosedCallback"))
277 void PurchaseItemBySku(const FString& AuthToken, const FString& ItemSKU, const FXsollaPaymentTokenRequestPayload& PurchaseParams,
278 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback, const FOnStoreBrowserClosed& BrowserClosedCallback);
279
280
290 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "PurchaseParams, SuccessCallback, ErrorCallback, BrowserClosedCallback"))
291 void PurchaseCart(const FString& AuthToken, const FString& CartId, const FXsollaPaymentTokenRequestPayload& PurchaseParams,
292 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback, const FOnStoreBrowserClosed& BrowserClosedCallback);
293
301 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
302 void PurchaseFreeCart(const FString& AuthToken, const FString& CartId,
303 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
304
312 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
313 void CheckOrder(const FString& AuthToken, const int32 OrderId,
314 const FOnCheckOrder& SuccessCallback, const FOnError& ErrorCallback);
315
324 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
325 void CheckPendingOrder(const FString& AccessToken, const int32 OrderId,
326 const FOnStoreSuccessPayment& SuccessCallback, const FOnError& ErrorCallback, bool bIsUserInvolvedToPayment = false);
327
337 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
338 void CreateOrderWithSpecifiedFreeItem(const FString& AuthToken, const FString& ItemSKU,
339 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback, const int32 Quantity = 1);
340
349 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
350 void CreateOrderWithFreeCart(const FString& AuthToken, const FString& CartId,
351 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
352
361 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "PurchaseParams, SuccessCallback, ErrorCallback"))
362 void PurchaseStoreItem(const FString& AuthToken, const FStoreItem& StoreItem, const FXsollaPaymentTokenRequestPayload& PurchaseParams,
363 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
364
373 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "PurchaseParams, SuccessCallback, ErrorCallback"))
374 void PurchaseCurrencyPackage(const FString& AuthToken, const FVirtualCurrencyPackage& CurrencyPackage, const FXsollaPaymentTokenRequestPayload& PurchaseParams,
375 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
376
385 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store", meta = (AutoCreateRefTerm = "PurchaseParams, SuccessCallback, ErrorCallback"))
386 void PurchaseBundle(const FString& AuthToken, const FStoreBundle& Bundle, const FXsollaPaymentTokenRequestPayload& PurchaseParams,
387 const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
388
397 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
398 void ClearCart(const FString& AuthToken, const FString& CartId,
399 const FOnStoreCartUpdate& SuccessCallback, const FOnError& ErrorCallback);
400
411 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
412 void GetCart(const FString& AuthToken, const FString& CartId, const FString& Currency, const FString& Locale,
413 const FOnCartUpdate& SuccessCallback, const FOnError& ErrorCallback);
414
425 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
426 void UpdateItemInCart(const FString& AuthToken, const FString& CartId, const FString& ItemSKU, const int32 Quantity,
427 const FOnStoreCartUpdate& SuccessCallback, const FOnError& ErrorCallback);
428
438 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
439 void RemoveFromCart(const FString& AuthToken, const FString& CartId, const FString& ItemSKU,
440 const FOnStoreCartUpdate& SuccessCallback, const FOnError& ErrorCallback);
441
451 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
452 void FillCartById(const FString& AuthToken, const FString& CartId, const TArray<FStoreCartItem>& Items,
453 const FOnCartUpdate& SuccessCallback, const FOnError& ErrorCallback);
454
463 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Bundle", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
464 void GetSpecifiedBundle(const FString& Sku, const FOnGetSpecifiedBundleUpdate& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
465
479 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Bundle", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
480 void GetPaginatedBundles(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
481 const FOnGetListOfBundlesUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0, const FString& AuthToken = TEXT(""));
482
483
494 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Bundle", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
495 void GetBundles(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
496 const FOnGetListOfBundlesUpdate& SuccessCallback, const FOnError& ErrorCallback, const FString& AuthToken = TEXT(""));
497
507 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
508 void GetVirtualCurrency(const FString& CurrencySKU,
509 const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
510 const FOnCurrencyUpdate& SuccessCallback, const FOnError& ErrorCallback);
511
522 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
523 void GetVirtualCurrencyPackage(const FString& PackageSKU,
524 const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
525 const FOnCurrencyPackageUpdate& SuccessCallback, const FOnError& ErrorCallback);
526
538 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
539 void BuyItemWithVirtualCurrency(const FString& AuthToken, const FString& ItemSKU, const FString& CurrencySKU,
540 const EXsollaPublishingPlatform Platform, const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
541
550 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
551 void GetPromocodeRewards(const FString& AuthToken, const FString& PromocodeCode,
552 const FOnGetPromocodeRewardsUpdate& SuccessCallback, const FOnError& ErrorCallback);
553
563 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
564 void RedeemPromocode(const FString& AuthToken, const FString& PromocodeCode, const FString& CartId,
565 const FOnPromocodeUpdate& SuccessCallback, const FOnError& ErrorCallback);
566
575 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
576 void RemovePromocodeFromCart(const FString& AuthToken, const FString& CartId,
577 const FOnPromocodeUpdate& SuccessCallback, const FOnError& ErrorCallback);
578
589 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys" , meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
590 void GetGamesList(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
591 const FOnStoreGamesUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
592
604 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
605 void GetGamesListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
606 const FOnGetGamesListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
607
617 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
618 void GetGameItem(const FString& GameSKU, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
619 const FOnGameUpdate& SuccessCallback, const FOnError& ErrorCallback);
620
631 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
632 void GetGameKeyItem(const FString& ItemSKU, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
633 const FOnGameKeyUpdate& SuccessCallback, const FOnError& ErrorCallback);
634
646 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
647 void GetGameKeysListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
648 const FOnGetGameKeysListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
649
655 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
656 void GetDRMList(const FOnDRMListUpdate& SuccessCallback, const FOnError& ErrorCallback);
657
669 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
670 void GetOwnedGames(const FString& AuthToken, const TArray<FString>& AdditionalFields,
671 const FOnOwnedGamesListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0, const bool bIsSandbox = false);
672
680 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
681 void RedeemGameCodeByClient(const FString& AuthToken, const FString& Code,
682 const FOnRedeemGameCodeSuccess& SuccessCallback, const FOnError& ErrorCallback);
683
697 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "PlanId, PlanExternalId, SuccessCallback, ErrorCallback"))
698 void GetSubscriptionPublicPlans(const TArray<int> PlanId, const TArray<FString>& PlanExternalId, const FString& Country, const FString& Locale,
699 const FOnSubscriptionPublicPlansListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
700
715 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "PlanId, PlanExternalId, SuccessCallback, ErrorCallback"))
716 void GetSubscriptionPlans(const FString& AuthToken, const TArray<int> PlanId, const TArray<FString>& PlanExternalId, const FString& Country, const FString& Locale,
717 const FOnSubscriptionPlansListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
718
730 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
731 void GetSubscriptions(const FString& AuthToken, const FString& Locale,
732 const FOnSubscriptionsListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
733
744 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
745 void GetSubscriptionDetails(const FString& AuthToken, const int32 SubscriptionId, const FString& Locale,
746 const FOnGetSubscriptionDetailsSuccess& SuccessCallback, const FOnError& ErrorCallback);
747
757 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
758 void GetSubscriptionPurchaseUrl(const FString& AuthToken, const FString& PlanExternalId, const FString& Country,
759 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
760
769 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
770 void GetSubscriptionManagementUrl(const FString& AuthToken, const FString& Country,
771 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
772
781 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
782 void GetSubscriptionRenewalUrl(const FString& AuthToken, const int32 SubscriptionId,
783 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
784
793 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
794 void CancelSubscription(const FString& AuthToken, const int32 SubscriptionId,
795 const FOnCancelSubscriptionSuccess& SuccessCallback, const FOnError& ErrorCallback);
796
801 UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Xsolla|Store|Utils", meta = (WorldContext = "WorldContextObject"))
802 static bool IsCustomTabsBrowserAvailable(UObject* WorldContextObject);
803
804protected:
805 void GetVirtualItems_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
806 const bool bSucceeded, FOnStoreItemsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
807 void GetItemGroups_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
808 const bool bSucceeded, FOnItemGroupsUpdate SuccessCallback, FOnError ErrorCallback);
809 void GetVirtualCurrencies_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
810 const bool bSucceeded, FOnVirtualCurrenciesUpdate SuccessCallback, FOnError ErrorCallback);
811 void GetVirtualCurrencyPackages_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
812 const bool bSucceeded, FOnVirtualCurrencyPackagesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
813 void GetItemsListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
814 const bool bSucceeded, FOnGetItemsListBySpecifiedGroup SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
815 void GetAllItemsList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
816 const bool bSucceeded, FOnGetItemsList SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
817
818 void FetchPaymentToken_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
819 const bool bSucceeded, FOnFetchTokenSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
820 void CheckOrder_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
821 const bool bSucceeded, FOnCheckOrder SuccessCallback, FOnError ErrorCallback);
822
823 void CreateOrderWithSpecifiedFreeItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
824 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
825 void CreateOrderWithFreeCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
826 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
827
828 void ClearCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
829 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
830 void GetCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
831 const bool bSucceeded, FOnCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
832 void UpdateItemInCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
833 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
834 void RemoveFromCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
835 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
836 void FillCartById_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
837 const bool bSucceeded, FOnCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
838
839 void GetListOfBundles_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
840 const bool bSucceeded, FOnGetListOfBundlesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
841 void GetSpecifiedBundle_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
842 const bool bSucceeded, FOnGetSpecifiedBundleUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
843
844 void GetVirtualCurrency_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
845 const bool bSucceeded, FOnCurrencyUpdate SuccessCallback, FOnError ErrorCallback);
846 void GetVirtualCurrencyPackage_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
847 const bool bSucceeded, FOnCurrencyPackageUpdate SuccessCallback, FOnError ErrorCallback);
848
849 void BuyItemWithVirtualCurrency_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
850 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
851
852 void GetPromocodeRewards_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
853 const bool bSucceeded, FOnGetPromocodeRewardsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
854 void RedeemPromocode_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
855 const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
856 void RemovePromocodeFromCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
857 const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
858
859 void GetGamesList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
860 const bool bSucceeded, FOnStoreGamesUpdate SuccessCallback, FOnError ErrorCallback);
861
862 void GetGamesListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
863 const bool bSucceeded, FOnGetGamesListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback);
864
865 void GetGameItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
866 const bool bSucceeded, FOnGameUpdate SuccessCallback, FOnError ErrorCallback);
867
868 void GetGameKeyItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
869 const bool bSucceeded, FOnGameKeyUpdate SuccessCallback, FOnError ErrorCallback);
870
871 void GetGameKeysListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
872 const bool bSucceeded, FOnGetGameKeysListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback);
873
874 void GetDRMList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
875 const bool bSucceeded, FOnDRMListUpdate SuccessCallback, FOnError ErrorCallback);
876
877 void GetOwnedGames_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
878 const bool bSucceeded, FOnOwnedGamesListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
879
880 void RedeemGameCodeByClient_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
881 const bool bSucceeded, FOnRedeemGameCodeSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
882
883 void GetSubscriptionPublicPlans_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
884 const bool bSucceeded, FOnSubscriptionPublicPlansListUpdate SuccessCallback, FOnError ErrorCallback);
885
886 void GetSubscriptionPlans_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
887 const bool bSucceeded, FOnSubscriptionPlansListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
888
889 void GetSubscriptions_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
890 const bool bSucceeded, FOnSubscriptionsListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
891
892 void GetSubscriptionDetails_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
893 const bool bSucceeded, FOnGetSubscriptionDetailsSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
894
895 void GetSubscriptionPaystationLink_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
896 const bool bSucceeded, FOnGetSubscriptionPayStationLinkSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
897
898 void CancelSubscription_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
899 const bool bSucceeded, FOnCancelSubscriptionSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
900
902 void HandleRequestError(XsollaHttpRequestError ErrorData, FOnError ErrorCallback);
903
904 void HandlePurchaseFreeItemsRequest(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
905 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
906
907protected:
909 bool IsSandboxEnabled() const;
910
911 void InnerPurchase(const FString& AuthToken, const FString& Sku, bool bIsFree, const TArray<FXsollaVirtualCurrencyPrice>& VirtualPrices,
912 const FXsollaPaymentTokenRequestPayload PaymentTokenRequestPayload, const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
913
914 UFUNCTION()
915 void FetchTokenCallback(const FString& AccessToken, int32 InOrderId);
916
917 UFUNCTION()
918 void BuyVirtualOrFreeItemCallback(int32 InOrderId);
919
920 UFUNCTION()
921 void CheckPendingOrderSuccessCallback();
922
923 UFUNCTION()
924 void BrowserClosedCallback(bool bIsManually);
925
926 // virtual items
927 UFUNCTION()
928 void GetVirtualItemsCallback(const FStoreItemsData& InItemsData);
929
930 UFUNCTION()
931 void GetVirtualItemsError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
932
933 void CallGetVirtualItems();
934
935 // virtual currencies
936 UFUNCTION()
937 void GetVirtualCurrenciesCallback(const FVirtualCurrencyData& InCurrenciesData);
938
939 UFUNCTION()
940 void GetVirtualCurrenciesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
941
942 void CallGetVirtualCurrencies();
943
944 // virtual currency packages
945 UFUNCTION()
946 void GetVirtualCurrencyPackagesCallback(const FVirtualCurrencyPackagesData& InPackagesData);
947
948 UFUNCTION()
949 void GetVirtualCurrencyPackagesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
950
951 void CallGetVirtualCurrencyPackages();
952
953 // items by specified group
954 UFUNCTION()
955 void GetAllItemsListBySpecifiedGroupCallback(const FStoreItemsList& InItemsList);
956
957 UFUNCTION()
958 void GetAllItemsListBySpecifiedGroupError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
959
960 void CallGetAllItemsListBySpecifiedGroup();
961
962 // bundles
963 UFUNCTION()
964 void GetBundlesCallback(const FStoreListOfBundles& InBundlesData);
965
966 UFUNCTION()
967 void GetBundlesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
968
969 void CallGetBundles();
970
971private:
973 TSharedRef<IHttpRequest, ESPMode::ThreadSafe> CreateHttpRequest(const FString& Url, const EXsollaHttpRequestVerb Verb = EXsollaHttpRequestVerb::VERB_GET,
974 const FString& AuthToken = FString(), const FString& Content = FString());
975
977 FString SerializeJson(const TSharedPtr<FJsonObject> DataJson) const;
978
980 TSharedPtr<FJsonObject> PreparePaymentTokenRequestPayload(const FXsollaPaymentTokenRequestPayload& PaymentTokenRequestPayload);
981
983 TSharedPtr<FJsonObject> PreparePaystationSettings(const bool bAddAdditionalParameters = false, const bool bDisableSdkParameter = false, const bool bShowCloseButton = false, const FString& CloseButtonIcon = TEXT("cross"), const bool bGpQuickPaymentButton = false);
984
986 bool GetSteamUserId(const FString& AuthToken, FString& SteamId, FString& OutError);
987
988 FString GetPayStationVersionPath(const EXsollaPayStationVersion PayStationVersion) const;
989
990 FString GetTokenQueryParameterName(const EXsollaPayStationVersion PayStationVersion) const;
991
992 FString GetBrowserType() const;
993
994 FString GetBuildPlatform() const;
995
996public:
998 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
999 static TArray<FStoreItem> GetVirtualItemsWithoutGroup(const FStoreItemsData& StoreItemsData);
1000
1002 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1003 const FString& GetPendingPaystationUrl() const;
1004
1006 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1007 static FString GetItemName(const FStoreItemsData& StoreItemsData, const FString& ItemSKU);
1008
1010 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1011 static const FStoreItem& FindItemBySku(const FStoreItemsData& StoreItemsData, const FString& ItemSku, bool& bHasFound);
1012
1014 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1015 static const FVirtualCurrencyPackage& FindVirtualCurrencyPackageBySku(const FVirtualCurrencyPackagesData& VirtualCurrencyPackagesData,
1016 const FString& ItemSku, bool& bHasFound);
1017
1019 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart")
1020 static bool IsItemInCart(const FStoreCart& Cart, const FString& ItemSKU);
1021
1022protected:
1024 FString ProjectID;
1025
1027 FString CachedAuthToken;
1028
1030 FXsollaPaymentTokenRequestPayload CachedPaymentTokenRequestPayload;
1031
1033 FString PendingPaystationUrl;
1034
1035 UXsollaStoreBrowserWrapper* MyBrowser;
1036
1037private:
1038 UPROPERTY()
1039 TSubclassOf<UXsollaStoreBrowserWrapper> DefaultBrowserWidgetClass;
1040
1041 UPROPERTY()
1042 TArray<UXsollaOrderCheckObject*> CachedOrderCheckObjects;
1043
1044 UPROPERTY()
1045 UXsollaLoginSubsystem* LoginSubsystem;
1046
1047 UPROPERTY()
1048 FString PaymentAccessToken;
1049
1050 UPROPERTY()
1051 FString PaymentRedirectURI;
1052
1053 UPROPERTY()
1054 bool PaymentEnableSandbox;
1055
1056 UPROPERTY()
1057 int32 PaymentOrderId;
1058
1059 UPROPERTY()
1060 int32 PaymentPayStationVersionNumber;
1061
1062 UPROPERTY()
1063 FOnPurchaseUpdate PaymentSuccessCallback;
1064
1065 UPROPERTY()
1066 FOnError PaymentErrorCallback;
1067
1068 UPROPERTY()
1069 FOnStoreBrowserClosed PaymentBrowserClosedCallback;
1070
1071 UPROPERTY(Transient)
1072 FGetAllVirtualItemsParams GetAllVirtualItemsParams;
1073
1074 UPROPERTY(Transient)
1075 FGetAllVirtualCurrenciesParams GetAllVirtualCurrenciesParams;
1076
1077 UPROPERTY(Transient)
1078 FGetAllVirtualCurrencyPackagesParams GetAllVirtualCurrencyPackagesParams;
1079
1080 UPROPERTY(Transient)
1081 FGetAllItemsListBySpecifiedGroupParams GetAllItemsListBySpecifiedGroupParams;
1082
1083 UPROPERTY(Transient)
1084 FGetAllBundlesParams GetAllBundlesParams;
1085};
UXsollaLoginSubsystem
Definition: XsollaLoginSubsystem.h:51
UXsollaOrderCheckObject
Definition: XsollaOrderCheckObject.h:21
UXsollaStoreBrowserWrapper
Definition: XsollaStoreBrowserWrapper.h:16
UXsollaStoreSubsystem
Definition: XsollaStoreSubsystem.h:55
FGetAllBundlesParams
Definition: XsollaStoreAuxiliaryDataModel.h:347
FGetAllItemsListBySpecifiedGroupParams
Definition: XsollaStoreAuxiliaryDataModel.h:258
FGetAllVirtualCurrenciesParams
Definition: XsollaStoreAuxiliaryDataModel.h:95
FGetAllVirtualCurrencyPackagesParams
Definition: XsollaStoreAuxiliaryDataModel.h:174
FGetAllVirtualItemsParams
Definition: XsollaStoreAuxiliaryDataModel.h:11
FStoreBundle
Definition: XsollaStoreDataModel.h:607
FStoreCart
Definition: XsollaStoreDataModel.h:550
FStoreCartItem
Definition: XsollaStoreDataModel.h:465
FStoreItem
Definition: XsollaStoreDataModel.h:116
FStoreItemsData
Definition: XsollaStoreDataModel.h:248
FStoreItemsList
Definition: XsollaStoreDataModel.h:236
FStoreListOfBundles
Definition: XsollaStoreDataModel.h:658
FVirtualCurrencyData
Definition: XsollaStoreDataModel.h:338
FVirtualCurrencyPackage
Definition: XsollaStoreDataModel.h:386
FVirtualCurrencyPackagesData
Definition: XsollaStoreDataModel.h:449