rustore / RuStore Unreal Engine Billing [deprecated]
CI/CD
Реестр контейнеров и пакетов

API/Autodoc/Classes/URuStoreBillingClient.md

URuStoreBillingClient

Класс реализует API для интегрирации платежей в мобильное приложение.

#include <URuStoreBillingClient.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

Name
bool GetIsInitialized()
Проверка инициализации платежного клиента.
bool Init(FURuStoreBillingClientConfig config)
Выполняет инициализацию синглтона URuStoreBillingClient. Параметры инициализации задаются объектом типа FURuStoreBillingClientConfig.
void Dispose()
Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.
void ConditionalBeginDestroy()
URuStorePaymentResultClass * ConvertPaymentResult(TSharedPtr< FURuStorePaymentResult, ESPMode::ThreadSafe > value)
long CheckPurchasesAvailability(TFunction< void(long, TSharedPtr< FURuStorePurchaseAvailabilityResult, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Проверка доступности платежей. Если все условия выполняются, возвращается FURuStorePurchaseAvailabilityResult::isAvailable == true. В противном случае возвращается FURuStorePurchaseAvailabilityResult::isAvailable == false.
long GetAuthorizationStatus(TFunction< void(long, TSharedPtr< FURuStoreUserAuthorizationStatus, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Проверка статуса авторизации у пользователя.
long GetProducts(TArray< FString > & productIds, TFunction< void(long, TSharedPtr< FURuStoreProductsResponse, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение списка продуктов, добавленных в ваше приложение через RuStore консоль.
long GetPurchases(TFunction< void(long, TSharedPtr< FURuStorePurchasesResponse, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение списка покупок пользователя.
long PurchaseProduct(FString productId, FString orderId, int quantity, FString developerPayload, TFunction< void(long, TSharedPtr< FURuStorePaymentResult, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Покупка продукта.
long ConfirmPurchase(FString purchaseId, TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Потребление (подтверждение) покупки. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.
long DeletePurchase(FString purchaseId, TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Отмена покупки.
long GetPurchaseInfo(FString purchaseId, TFunction< void(long, TSharedPtr< FURuStorePurchase, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение информации о покупке.
void SetTheme(EURuStoreTheme theme)
SDK поддерживает динамическую смены темы. Установить тему интерфейса.
EURuStoreTheme GetTheme()
SDK SDK поддерживает динамическую смены темы. Получить текущую тему интерфейса.
bool IsRuStoreInstalled()
Проверка установлен ли на устройстве пользователя RuStore.
void CheckPurchasesAvailability(int64 & requestId)
void GetProducts(TArray< FString > productIds, int64 & requestId)
void GetPurchases(int64 & requestId)
void PurchaseProduct(FString productId, FString orderId, int quantity, FString developerPayload, int64 & requestId)
void ConfirmPurchase(FString purchaseId, int64 & requestId)
void DeletePurchase(FString purchaseId, int64 & requestId)
void GetPurchaseInfo(FString purchaseId, int64 & requestId)
URuStoreBillingClient * Instance()
Получить экземпляр URuStoreBillingClient.

Public Attributes

Name
const FString PluginVersion — Версия плагина.
FRuStoreCheckPurchasesAvailabilityErrorDelegate OnCheckPurchasesAvailabilityError
FRuStoreCheckPurchasesAvailabilityResponseDelegate OnCheckPurchasesAvailabilityResponse
FRuStoreGetProductsErrorDelegate OnGetProductsError
FRuStoreGetProductsResponseDelegate OnGetProductsResponse
FRuStoreGetPurchasesErrorDelegate OnGetPurchasesError
FRuStoreGetPurchasesResponseDelegate OnGetPurchasesResponse
FRuStorePurchaseProductErrorDelegate OnPurchaseProductError
FRuStoreUPurchaseProductResponseDelegate OnPurchaseProductResponse
FRuStoreConfirmPurchaseErrorDelegate OnConfirmPurchaseError
FRuStoreConfirmPurchaseResponseDelegate OnConfirmPurchaseResponse
FRuStoreDeletePurchaseErrorDelegate OnDeletePurchaseError
FRuStoreDeletePurchaseResponseDelegate OnDeletePurchaseResponse
FRuStoreGetPurchaseInfoErrorDelegate OnPurchaseInfoError
FRuStoreGetPurchaseInfoResponseDelegate OnPurchaseInfoResponse

Additional inherited members

Public Functions inherited from RuStoreSDK::RuStoreListenerContainer

Name
TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > ListenerBind(RuStoreListener * item)
void ListenerUnbind(long id)
void ListenerUnbind(RuStoreListener * item)
void ListenerUnbind(TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > item)
void ListenerRemoveAll()

function GetIsInitialized

bool GetIsInitialized()

Проверка инициализации платежного клиента.

Return: Возвращает true, если синглтон инициализирован, в противном случае — false.

function Init

bool Init(
    FURuStoreBillingClientConfig config
)

Выполняет инициализацию синглтона URuStoreBillingClient. Параметры инициализации задаются объектом типа FURuStoreBillingClientConfig.

Parameters:

  • config Объект класса FURuStoreBillingClientConfig. Содержит параметры инициализации платежного клиента.

Return: Возвращает true, если инициализация была успешно выполнена, в противном случае — false.

function Dispose

void Dispose()

Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function ConvertPaymentResult

URuStorePaymentResultClass * ConvertPaymentResult(
    TSharedPtr< FURuStorePaymentResult, ESPMode::ThreadSafe > value
)

function CheckPurchasesAvailability

long CheckPurchasesAvailability(
    TFunction< void(long, TSharedPtr< FURuStorePurchaseAvailabilityResult, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Проверка доступности платежей. Если все условия выполняются, возвращается FURuStorePurchaseAvailabilityResult::isAvailable == true. В противном случае возвращается FURuStorePurchaseAvailabilityResult::isAvailable == false.

Parameters:

  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStorePurchaseAvailabilityResult с информцаией о доступности оплаты.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function GetAuthorizationStatus

long GetAuthorizationStatus(
    TFunction< void(long, TSharedPtr< FURuStoreUserAuthorizationStatus, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Проверка статуса авторизации у пользователя.

Parameters:

  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStoreUserAuthorizationStatus с информцаией о доступности оплаты.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function GetProducts

long GetProducts(
    TArray< FString > & productIds,
    TFunction< void(long, TSharedPtr< FURuStoreProductsResponse, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Получение списка продуктов, добавленных в ваше приложение через RuStore консоль.

Parameters:

  • productIds Список идентификаторов продуктов (задаются при создании продукта в консоли разработчика). Список продуктов имеет ограничение в размере 1000 элементов.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStoreProductsResponse с информцаией о продуктах.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function GetPurchases

long GetPurchases(
    TFunction< void(long, TSharedPtr< FURuStorePurchasesResponse, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Получение списка покупок пользователя.

Parameters:

  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект типа FURuStorePurchasesResponse с информцаией о покупках.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function PurchaseProduct

long PurchaseProduct(
    FString productId,
    FString orderId,
    int quantity,
    FString developerPayload,
    TFunction< void(long, TSharedPtr< FURuStorePaymentResult, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Покупка продукта.

Parameters:

  • productId Идентификатор продукта, который был присвоен продукту в RuStore Консоли (обязательный параметр).
  • orderId Уникальный идентификатор оплаты, сформированный приложением (опциональный параметр). Если вы укажете этот параметр в вашей системе, вы получите его в ответе при работе с API. Если не укажете, он будет сгенерирован автоматически (uuid). Максимальная длина 150 символов.
  • quantity Количество продукта (1 или более).
  • developerPayload Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStorePaymentResult с информацией о результате покупки.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function ConfirmPurchase

long ConfirmPurchase(
    FString purchaseId,
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Потребление (подтверждение) покупки. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.

Parameters:

  • purchaseId Идентификатор покупки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function DeletePurchase

long DeletePurchase(
    FString purchaseId,
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Отмена покупки.

Parameters:

  • purchaseId Идентификатор покупки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function GetPurchaseInfo

long GetPurchaseInfo(
    FString purchaseId,
    TFunction< void(long, TSharedPtr< FURuStorePurchase, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Получение информации о покупке.

Parameters:

  • purchaseId Идентификатор покупки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект типа FURuStorePurchase с информцаией о покупке.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function SetTheme

void SetTheme(
    EURuStoreTheme theme
)

SDK поддерживает динамическую смены темы. Установить тему интерфейса.

Parameters:

  • theme Новая тема, заданная значением из перечисления EURuStoreTheme.

function GetTheme

EURuStoreTheme GetTheme()

SDK SDK поддерживает динамическую смены темы. Получить текущую тему интерфейса.

Return: Текущая тема, заданная значением из перечисления EURuStoreTheme.

function IsRuStoreInstalled

bool IsRuStoreInstalled()

Проверка установлен ли на устройстве пользователя RuStore.

Return: Возвращает true, если RuStore установлен, в противном случае — false.

function CheckPurchasesAvailability

void CheckPurchasesAvailability(
    int64 & requestId
)

function GetProducts

void GetProducts(
    TArray< FString > productIds,
    int64 & requestId
)

function GetPurchases

void GetPurchases(
    int64 & requestId
)

function PurchaseProduct

void PurchaseProduct(
    FString productId,
    FString orderId,
    int quantity,
    FString developerPayload,
    int64 & requestId
)

function ConfirmPurchase

void ConfirmPurchase(
    FString purchaseId,
    int64 & requestId
)

function DeletePurchase

void DeletePurchase(
    FString purchaseId,
    int64 & requestId
)

function GetPurchaseInfo

void GetPurchaseInfo(
    FString purchaseId,
    int64 & requestId
)

function Instance

static URuStoreBillingClient * Instance()

Получить экземпляр URuStoreBillingClient.

Return: Возвращает указатель на единственный экземпляр URuStoreBillingClient (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.

variable PluginVersion

static const FString PluginVersion = "10.5.0";

Версия плагина.

variable OnCheckPurchasesAvailabilityError

FRuStoreCheckPurchasesAvailabilityErrorDelegate OnCheckPurchasesAvailabilityError;

variable OnCheckPurchasesAvailabilityResponse

FRuStoreCheckPurchasesAvailabilityResponseDelegate OnCheckPurchasesAvailabilityResponse;

variable OnGetProductsError

FRuStoreGetProductsErrorDelegate OnGetProductsError;

variable OnGetProductsResponse

FRuStoreGetProductsResponseDelegate OnGetProductsResponse;

variable OnGetPurchasesError

FRuStoreGetPurchasesErrorDelegate OnGetPurchasesError;

variable OnGetPurchasesResponse

FRuStoreGetPurchasesResponseDelegate OnGetPurchasesResponse;

variable OnPurchaseProductError

FRuStorePurchaseProductErrorDelegate OnPurchaseProductError;

variable OnPurchaseProductResponse

FRuStoreUPurchaseProductResponseDelegate OnPurchaseProductResponse;

variable OnConfirmPurchaseError

FRuStoreConfirmPurchaseErrorDelegate OnConfirmPurchaseError;

variable OnConfirmPurchaseResponse

FRuStoreConfirmPurchaseResponseDelegate OnConfirmPurchaseResponse;

variable OnDeletePurchaseError

FRuStoreDeletePurchaseErrorDelegate OnDeletePurchaseError;

variable OnDeletePurchaseResponse

FRuStoreDeletePurchaseResponseDelegate OnDeletePurchaseResponse;

variable OnPurchaseInfoError

FRuStoreGetPurchaseInfoErrorDelegate OnPurchaseInfoError;

variable OnPurchaseInfoResponse

FRuStoreGetPurchaseInfoResponseDelegate OnPurchaseInfoResponse;
Назад