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
523 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
524 void GetVirtualCurrencyPackage(const FString& PackageSKU,
525 const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
526 const FOnCurrencyPackageUpdate& SuccessCallback, const FOnError& ErrorCallback);
527
539 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|VirtualCurrency", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
540 void BuyItemWithVirtualCurrency(const FString& AuthToken, const FString& ItemSKU, const FString& CurrencySKU,
541 const EXsollaPublishingPlatform Platform, const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
542
551 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
552 void GetPromocodeRewards(const FString& AuthToken, const FString& PromocodeCode,
553 const FOnGetPromocodeRewardsUpdate& SuccessCallback, const FOnError& ErrorCallback);
554
564 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
565 void RedeemPromocode(const FString& AuthToken, const FString& PromocodeCode, const FString& CartId,
566 const FOnPromocodeUpdate& SuccessCallback, const FOnError& ErrorCallback);
567
576 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Promocode", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
577 void RemovePromocodeFromCart(const FString& AuthToken, const FString& CartId,
578 const FOnPromocodeUpdate& SuccessCallback, const FOnError& ErrorCallback);
579
590 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys" , meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
591 void GetGamesList(const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
592 const FOnStoreGamesUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
593
605 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
606 void GetGamesListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
607 const FOnGetGamesListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
608
618 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
619 void GetGameItem(const FString& GameSKU, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
620 const FOnGameUpdate& SuccessCallback, const FOnError& ErrorCallback);
621
632 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
633 void GetGameKeyItem(const FString& ItemSKU, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
634 const FOnGameKeyUpdate& SuccessCallback, const FOnError& ErrorCallback);
635
647 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
648 void GetGameKeysListBySpecifiedGroup(const FString& ExternalId, const FString& Locale, const FString& Country, const TArray<FString>& AdditionalFields,
649 const FOnGetGameKeysListBySpecifiedGroup& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
650
656 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
657 void GetDRMList(const FOnDRMListUpdate& SuccessCallback, const FOnError& ErrorCallback);
658
670 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "AdditionalFields, SuccessCallback, ErrorCallback"))
671 void GetOwnedGames(const FString& AuthToken, const TArray<FString>& AdditionalFields,
672 const FOnOwnedGamesListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0, const bool bIsSandbox = false);
673
681 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|GameKeys", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
682 void RedeemGameCodeByClient(const FString& AuthToken, const FString& Code,
683 const FOnRedeemGameCodeSuccess& SuccessCallback, const FOnError& ErrorCallback);
684
698 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "PlanId, PlanExternalId, SuccessCallback, ErrorCallback"))
699 void GetSubscriptionPublicPlans(const TArray<int> PlanId, const TArray<FString>& PlanExternalId, const FString& Country, const FString& Locale,
700 const FOnSubscriptionPublicPlansListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
701
716 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "PlanId, PlanExternalId, SuccessCallback, ErrorCallback"))
717 void GetSubscriptionPlans(const FString& AuthToken, const TArray<int> PlanId, const TArray<FString>& PlanExternalId, const FString& Country, const FString& Locale,
718 const FOnSubscriptionPlansListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
719
731 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
732 void GetSubscriptions(const FString& AuthToken, const FString& Locale,
733 const FOnSubscriptionsListUpdate& SuccessCallback, const FOnError& ErrorCallback, const int Limit = 50, const int Offset = 0);
734
745 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
746 void GetSubscriptionDetails(const FString& AuthToken, const int32 SubscriptionId, const FString& Locale,
747 const FOnGetSubscriptionDetailsSuccess& SuccessCallback, const FOnError& ErrorCallback);
748
758 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
759 void GetSubscriptionPurchaseUrl(const FString& AuthToken, const FString& PlanExternalId, const FString& Country,
760 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
761
770 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
771 void GetSubscriptionManagementUrl(const FString& AuthToken, const FString& Country,
772 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
773
782 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
783 void GetSubscriptionRenewalUrl(const FString& AuthToken, const int32 SubscriptionId,
784 const FOnGetSubscriptionPayStationLinkSuccess& SuccessCallback, const FOnError& ErrorCallback);
785
794 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Subscriptions", meta = (AutoCreateRefTerm = "SuccessCallback, ErrorCallback"))
795 void CancelSubscription(const FString& AuthToken, const int32 SubscriptionId,
796 const FOnCancelSubscriptionSuccess& SuccessCallback, const FOnError& ErrorCallback);
797
802 UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Xsolla|Store|Utils", meta = (WorldContext = "WorldContextObject"))
803 static bool IsCustomTabsBrowserAvailable(UObject* WorldContextObject);
804
805protected:
806 void GetVirtualItems_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
807 const bool bSucceeded, FOnStoreItemsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
808 void GetItemGroups_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
809 const bool bSucceeded, FOnItemGroupsUpdate SuccessCallback, FOnError ErrorCallback);
810 void GetVirtualCurrencies_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
811 const bool bSucceeded, FOnVirtualCurrenciesUpdate SuccessCallback, FOnError ErrorCallback);
812 void GetVirtualCurrencyPackages_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
813 const bool bSucceeded, FOnVirtualCurrencyPackagesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
814 void GetItemsListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
815 const bool bSucceeded, FOnGetItemsListBySpecifiedGroup SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
816 void GetAllItemsList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
817 const bool bSucceeded, FOnGetItemsList SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
818
819 void FetchPaymentToken_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
820 const bool bSucceeded, FOnFetchTokenSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
821 void CheckOrder_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
822 const bool bSucceeded, FOnCheckOrder SuccessCallback, FOnError ErrorCallback);
823
824 void CreateOrderWithSpecifiedFreeItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
825 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
826 void CreateOrderWithFreeCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
827 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
828
829 void ClearCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
830 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
831 void GetCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
832 const bool bSucceeded, FOnCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
833 void UpdateItemInCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
834 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
835 void RemoveFromCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
836 const bool bSucceeded, FOnStoreCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
837 void FillCartById_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
838 const bool bSucceeded, FOnCartUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
839
840 void GetListOfBundles_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
841 const bool bSucceeded, FOnGetListOfBundlesUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
842 void GetSpecifiedBundle_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
843 const bool bSucceeded, FOnGetSpecifiedBundleUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
844
845 void GetVirtualCurrency_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
846 const bool bSucceeded, FOnCurrencyUpdate SuccessCallback, FOnError ErrorCallback);
847 void GetVirtualCurrencyPackage_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
848 const bool bSucceeded, FOnCurrencyPackageUpdate SuccessCallback, FOnError ErrorCallback);
849
850 void BuyItemWithVirtualCurrency_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
851 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
852
853 void GetPromocodeRewards_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
854 const bool bSucceeded, FOnGetPromocodeRewardsUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
855 void RedeemPromocode_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
856 const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
857 void RemovePromocodeFromCart_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
858 const bool bSucceeded, FOnPromocodeUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
859
860 void GetGamesList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
861 const bool bSucceeded, FOnStoreGamesUpdate SuccessCallback, FOnError ErrorCallback);
862
863 void GetGamesListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
864 const bool bSucceeded, FOnGetGamesListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback);
865
866 void GetGameItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
867 const bool bSucceeded, FOnGameUpdate SuccessCallback, FOnError ErrorCallback);
868
869 void GetGameKeyItem_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
870 const bool bSucceeded, FOnGameKeyUpdate SuccessCallback, FOnError ErrorCallback);
871
872 void GetGameKeysListBySpecifiedGroup_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
873 const bool bSucceeded, FOnGetGameKeysListBySpecifiedGroup SuccessCallback, FOnError ErrorCallback);
874
875 void GetDRMList_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
876 const bool bSucceeded, FOnDRMListUpdate SuccessCallback, FOnError ErrorCallback);
877
878 void GetOwnedGames_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
879 const bool bSucceeded, FOnOwnedGamesListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
880
881 void RedeemGameCodeByClient_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
882 const bool bSucceeded, FOnRedeemGameCodeSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
883
884 void GetSubscriptionPublicPlans_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
885 const bool bSucceeded, FOnSubscriptionPublicPlansListUpdate SuccessCallback, FOnError ErrorCallback);
886
887 void GetSubscriptionPlans_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
888 const bool bSucceeded, FOnSubscriptionPlansListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
889
890 void GetSubscriptions_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
891 const bool bSucceeded, FOnSubscriptionsListUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
892
893 void GetSubscriptionDetails_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
894 const bool bSucceeded, FOnGetSubscriptionDetailsSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
895
896 void GetSubscriptionPaystationLink_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
897 const bool bSucceeded, FOnGetSubscriptionPayStationLinkSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
898
899 void CancelSubscription_HttpRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
900 const bool bSucceeded, FOnCancelSubscriptionSuccess SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
901
903 void HandleRequestError(XsollaHttpRequestError ErrorData, FOnError ErrorCallback);
904
905 void HandlePurchaseFreeItemsRequest(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse,
906 const bool bSucceeded, FOnPurchaseUpdate SuccessCallback, FErrorHandlersWrapper ErrorHandlersWrapper);
907
908protected:
910 bool IsSandboxEnabled() const;
911
912 void InnerPurchase(const FString& AuthToken, const FString& Sku, bool bIsFree, const TArray<FXsollaVirtualCurrencyPrice>& VirtualPrices,
913 const FXsollaPaymentTokenRequestPayload PaymentTokenRequestPayload, const FOnPurchaseUpdate& SuccessCallback, const FOnError& ErrorCallback);
914
915 UFUNCTION()
916 void FetchTokenCallback(const FString& AccessToken, int32 InOrderId);
917
918 UFUNCTION()
919 void BuyVirtualOrFreeItemCallback(int32 InOrderId);
920
921 UFUNCTION()
922 void CheckPendingOrderSuccessCallback();
923
924 UFUNCTION()
925 void BrowserClosedCallback(bool bIsManually);
926
927 // virtual items
928 UFUNCTION()
929 void GetVirtualItemsCallback(const FStoreItemsData& InItemsData);
930
931 UFUNCTION()
932 void GetVirtualItemsError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
933
934 void CallGetVirtualItems();
935
936 // virtual currencies
937 UFUNCTION()
938 void GetVirtualCurrenciesCallback(const FVirtualCurrencyData& InCurrenciesData);
939
940 UFUNCTION()
941 void GetVirtualCurrenciesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
942
943 void CallGetVirtualCurrencies();
944
945 // virtual currency packages
946 UFUNCTION()
947 void GetVirtualCurrencyPackagesCallback(const FVirtualCurrencyPackagesData& InPackagesData);
948
949 UFUNCTION()
950 void GetVirtualCurrencyPackagesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
951
952 void CallGetVirtualCurrencyPackages();
953
954 // items by specified group
955 UFUNCTION()
956 void GetAllItemsListBySpecifiedGroupCallback(const FStoreItemsList& InItemsList);
957
958 UFUNCTION()
959 void GetAllItemsListBySpecifiedGroupError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
960
961 void CallGetAllItemsListBySpecifiedGroup();
962
963 // bundles
964 UFUNCTION()
965 void GetBundlesCallback(const FStoreListOfBundles& InBundlesData);
966
967 UFUNCTION()
968 void GetBundlesError(int32 StatusCode, int32 ErrorCode, const FString& ErrorMessage);
969
970 void CallGetBundles();
971
972private:
974 TSharedRef<IHttpRequest, ESPMode::ThreadSafe> CreateHttpRequest(const FString& Url, const EXsollaHttpRequestVerb Verb = EXsollaHttpRequestVerb::VERB_GET,
975 const FString& AuthToken = FString(), const FString& Content = FString());
976
978 FString SerializeJson(const TSharedPtr<FJsonObject> DataJson) const;
979
981 TSharedPtr<FJsonObject> PreparePaymentTokenRequestPayload(const FXsollaPaymentTokenRequestPayload& PaymentTokenRequestPayload);
982
984 TSharedPtr<FJsonObject> PreparePaystationSettings(const bool bAddAdditionalParameters = false, const bool bDisableSdkParameter = false, const bool bShowCloseButton = false, const FString& CloseButtonIcon = TEXT("cross"), const bool bGpQuickPaymentButton = false);
985
987 bool GetSteamUserId(const FString& AuthToken, FString& SteamId, FString& OutError);
988
989 FString GetPayStationVersionPath(const EXsollaPayStationVersion PayStationVersion) const;
990
991 FString GetTokenQueryParameterName(const EXsollaPayStationVersion PayStationVersion) const;
992
993 FString GetBrowserType() const;
994
995 FString GetBuildPlatform() const;
996
997public:
999 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1000 static TArray<FStoreItem> GetVirtualItemsWithoutGroup(const FStoreItemsData& StoreItemsData);
1001
1003 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1004 const FString& GetPendingPaystationUrl() const;
1005
1007 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1008 static FString GetItemName(const FStoreItemsData& StoreItemsData, const FString& ItemSKU);
1009
1011 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1012 static const FStoreItem& FindItemBySku(const FStoreItemsData& StoreItemsData, const FString& ItemSku, bool& bHasFound);
1013
1015 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store")
1016 static const FVirtualCurrencyPackage& FindVirtualCurrencyPackageBySku(const FVirtualCurrencyPackagesData& VirtualCurrencyPackagesData,
1017 const FString& ItemSku, bool& bHasFound);
1018
1020 UFUNCTION(BlueprintCallable, Category = "Xsolla|Store|Cart")
1021 static bool IsItemInCart(const FStoreCart& Cart, const FString& ItemSKU);
1022
1023protected:
1025 FString ProjectID;
1026
1028 FString CachedAuthToken;
1029
1031 FXsollaPaymentTokenRequestPayload CachedPaymentTokenRequestPayload;
1032
1034 FString PendingPaystationUrl;
1035
1036 UXsollaStoreBrowserWrapper* MyBrowser;
1037
1038private:
1039 UPROPERTY()
1040 TSubclassOf<UXsollaStoreBrowserWrapper> DefaultBrowserWidgetClass;
1041
1042 UPROPERTY()
1043 TArray<UXsollaOrderCheckObject*> CachedOrderCheckObjects;
1044
1045 UPROPERTY()
1046 UXsollaLoginSubsystem* LoginSubsystem;
1047
1048 UPROPERTY()
1049 FString PaymentAccessToken;
1050
1051 UPROPERTY()
1052 FString PaymentRedirectURI;
1053
1054 UPROPERTY()
1055 bool PaymentEnableSandbox;
1056
1057 UPROPERTY()
1058 int32 PaymentOrderId;
1059
1060 UPROPERTY()
1061 int32 PaymentPayStationVersionNumber;
1062
1063 UPROPERTY()
1064 FOnPurchaseUpdate PaymentSuccessCallback;
1065
1066 UPROPERTY()
1067 FOnError PaymentErrorCallback;
1068
1069 UPROPERTY()
1070 FOnStoreBrowserClosed PaymentBrowserClosedCallback;
1071
1072 UPROPERTY(Transient)
1073 FGetAllVirtualItemsParams GetAllVirtualItemsParams;
1074
1075 UPROPERTY(Transient)
1076 FGetAllVirtualCurrenciesParams GetAllVirtualCurrenciesParams;
1077
1078 UPROPERTY(Transient)
1079 FGetAllVirtualCurrencyPackagesParams GetAllVirtualCurrencyPackagesParams;
1080
1081 UPROPERTY(Transient)
1082 FGetAllItemsListBySpecifiedGroupParams GetAllItemsListBySpecifiedGroupParams;
1083
1084 UPROPERTY(Transient)
1085 FGetAllBundlesParams GetAllBundlesParams;
1086};
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