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

API/Autodoc/Classes/URuStorePayClient.md

URuStorePayClient

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

#include <URuStorePayClient.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

Name
bool GetIsInitialized()
Проверка инициализации менеджера.
bool Init()
Выполняет инициализацию синглтона URuStorePayClient.
void Dispose()
Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.
void ConditionalBeginDestroy()
long GetUserAuthorizationStatus(TFunction< void(long, EURuStorePayUserAuthorizationStatus)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Проверка статуса авторизации пользователя.
long GetPurchaseAvailability(TFunction< void(long, TSharedPtr< FURuStorePayPurchaseAvailabilityResult, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Проверка доступности платежей. Если все условия выполняются, возвращается FURuStorePayPurchaseAvailabilityResult::isAvailable == true. В противном случае возвращается FURuStorePayPurchaseAvailabilityResult::isAvailable == false.
long GetProducts(TArray< URuStorePayProductId * > & productIds, TFunction< void(long, TSharedPtr< TArray< FURuStorePayProduct >, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение списка продуктов, добавленных в ваше приложение через консоль RuStore.
long GetPurchases(TFunction< void(long, TSharedPtr< TArray< FURuStorePayPurchase >, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение списка покупок пользователя.
long GetPurchases(bool bUseProductType, bool bUsePurchaseStatusFilter, bool bUseAcknowledgementState, EURuStorePayProductType productType, EURuStorePayPurchaseStatusFilter purchaseStatusFilter, EURuStorePayAcknowledgementState acknowledgementState, TFunction< void(long, TSharedPtr< TArray< FURuStorePayPurchase >, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение списка покупок пользователя.
long GetPurchase(URuStorePayPurchaseId * purchaseId, TFunction< void(long, TSharedPtr< FURuStorePayPurchase, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение информации о покупке.
long Purchase(FURuStorePayProductPurchaseParams & productPurchaseParams, EURuStorePayPreferredPurchaseType preferredPurchaseType, EURuStorePaySdkTheme sdkTheme, TFunction< void(long, TSharedPtr< FURuStorePayProductPurchaseResult, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure, TSharedPtr< RuStoreSDK::Pay::PurchaseEventListenerImpl, ESPMode::ThreadSafe > purchaseEventListener =nullptr)
Покупка продукта.
long PurchaseTwoStep(FURuStorePayProductPurchaseParams & productPurchaseParams, EURuStorePaySdkTheme sdkTheme, TFunction< void(long, TSharedPtr< FURuStorePayProductPurchaseResult, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure, TSharedPtr< RuStoreSDK::Pay::PurchaseEventListenerImpl, ESPMode::ThreadSafe > purchaseEventListener =nullptr)
Покупка продукта с двустадийной оплатой.
long ConfirmTwoStepPurchase(URuStorePayPurchaseId * purchaseId, URuStorePayDeveloperPayload * developerPayload, TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Потребление (подтверждение) покупки. После вызова подтверждения, покупка перейдёт в статус CONFIRMED. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.
long CancelTwoStepPurchase(URuStorePayPurchaseId * purchaseId, TFunction< void(long)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Отмена покупки. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.
long UpdateAcknowledgementState(URuStorePayPurchaseId * purchaseId, EURuStorePayAcknowledgementState state, URuStorePayDeveloperPayload * developerPayload, TFunction< void(long, EURuStorePayAcknowledgementState)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Обновление состояния подтверждения покупки.
bool IsRuStoreInstalled()
Проверка установлен ли на устройстве пользователя RuStore.
URuStorePayClient * Instance()
Получить экземпляр URuStorePayClient.
URuStorePayProductId * MakeProductId(FString productId)
Создает объект идентификатора продукта.
TArray< URuStorePayProductId * > MakeProductIdArray(TArray< FString > productIds)
Создает массив объектов идентификаторов продуктов.
URuStorePayQuantity * MakeQuantity(int value =1)
Создает объект, представляющее количество продукта.
URuStorePayOrderId * MakeOrderId(FString value)
Создает объект уникального идентификатора оплаты.
URuStorePayDeveloperPayload * MakeDeveloperPayload(FString value)
Создает объект полезной нагрузки разработчика.
URuStorePayAppUserId * MakeAppUserId(FString value)
Создает объект внутреннего ID пользователя в приложении.
URuStorePayAppUserEmail * MakeAppUserEmail(FString value)
Создает объект адреса электронной почты пользователя.
FURuStorePayProductPurchaseParams MakeProductPurchaseParams(URuStorePayProductId * productId, URuStorePayAppUserEmail * appUserEmail =nullptr, URuStorePayAppUserId * appUserId =nullptr, URuStorePayDeveloperPayload * developerPayload =nullptr, URuStorePayOrderId * orderId =nullptr, URuStorePayQuantity * quantity =nullptr)
Создает структуру параметров покупки продукта.

Public Attributes

Name
const FString PluginVersion — Версия плагина.

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()

Выполняет инициализацию синглтона URuStorePayClient.

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

function Dispose

void Dispose()

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

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function GetUserAuthorizationStatus

long GetUserAuthorizationStatus(
    TFunction< void(long, EURuStorePayUserAuthorizationStatus)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function GetPurchaseAvailability

long GetPurchaseAvailability(
    TFunction< void(long, TSharedPtr< FURuStorePayPurchaseAvailabilityResult, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function GetProducts

long GetProducts(
    TArray< URuStorePayProductId * > & productIds,
    TFunction< void(long, TSharedPtr< TArray< FURuStorePayProduct >, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function GetPurchases

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

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

Parameters:

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

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

function GetPurchases

long GetPurchases(
    bool bUseProductType,
    bool bUsePurchaseStatusFilter,
    bool bUseAcknowledgementState,
    EURuStorePayProductType productType,
    EURuStorePayPurchaseStatusFilter purchaseStatusFilter,
    EURuStorePayAcknowledgementState acknowledgementState,
    TFunction< void(long, TSharedPtr< TArray< FURuStorePayPurchase >, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

  • bUseProductType Использовать фильтрацию по типу товаров.
  • bUsePurchaseStatusFilter Использовать фильтрацию по статусу покупки.
  • bUseAcknowledgementState Использовать фильтрацию по состоянию подтверждения покупки.
  • productType Опциональная фильтрация по типу товаров (потребляемые или непотреблямые товары).
  • purchaseStatusFilter Опциональная фильтрация по статусу покупки. Поддерживаются статусы PAID и CONFIRMED для покупок, ACTIVE и PAUSED для подписок.
  • acknowledgementState Опциональная фильтрация по состоянию подтверждения покупки. Поддерживаются состояния PENDING, ACKNOWLEDGED и UNKNOWN.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и список объектов FURuStorePayPurchase с информцаией о покупках.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

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

function GetPurchase

long GetPurchase(
    URuStorePayPurchaseId * purchaseId,
    TFunction< void(long, TSharedPtr< FURuStorePayPurchase, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function Purchase

long Purchase(
    FURuStorePayProductPurchaseParams & productPurchaseParams,
    EURuStorePayPreferredPurchaseType preferredPurchaseType,
    EURuStorePaySdkTheme sdkTheme,
    TFunction< void(long, TSharedPtr< FURuStorePayProductPurchaseResult, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure,
    TSharedPtr< RuStoreSDK::Pay::PurchaseEventListenerImpl, ESPMode::ThreadSafe > purchaseEventListener =nullptr
)

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

Parameters:

  • productPurchaseParams Параметры покупки продукта.
  • preferredPurchaseType Предпочитаемый тип покупки.
  • sdkTheme Цветовая тема платежной шторки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект реализующий интерфейс FURuStorePayProductPurchaseResult с информцаией о результате покупки.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.
  • purchaseEventListener Набор callback функций, позволяющий получать данные об invoiceId и purchaseId на разных этапах покупки — опционально.

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

function PurchaseTwoStep

long PurchaseTwoStep(
    FURuStorePayProductPurchaseParams & productPurchaseParams,
    EURuStorePaySdkTheme sdkTheme,
    TFunction< void(long, TSharedPtr< FURuStorePayProductPurchaseResult, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure,
    TSharedPtr< RuStoreSDK::Pay::PurchaseEventListenerImpl, ESPMode::ThreadSafe > purchaseEventListener =nullptr
)

Покупка продукта с двустадийной оплатой.

Parameters:

  • productPurchaseParams Параметры покупки продукта.
  • sdkTheme Цветовая тема платежной шторки.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект реализующий интерфейс FURuStorePayProductPurchaseResult с информцаией о результате покупки.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.
  • purchaseEventListener Набор callback функций, позволяющий получать данные об invoiceId и purchaseId на разных этапах покупки — опционально.

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

function ConfirmTwoStepPurchase

long ConfirmTwoStepPurchase(
    URuStorePayPurchaseId * purchaseId,
    URuStorePayDeveloperPayload * developerPayload,
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function CancelTwoStepPurchase

long CancelTwoStepPurchase(
    URuStorePayPurchaseId * purchaseId,
    TFunction< void(long)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

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

Parameters:

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

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

function UpdateAcknowledgementState

long UpdateAcknowledgementState(
    URuStorePayPurchaseId * purchaseId,
    EURuStorePayAcknowledgementState state,
    URuStorePayDeveloperPayload * developerPayload,
    TFunction< void(long, EURuStorePayAcknowledgementState)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Обновление состояния подтверждения покупки.

Parameters:

  • purchaseId Идентификатор покупки.
  • state Новое состояние подтверждения покупки.
  • developerPayload Строка, содержащая дополнительную информацию о заказе (необязательный параметр).
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и значение EURuStorePayAcknowledgementState с новым состоянием подтверждения покупки.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

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

function IsRuStoreInstalled

bool IsRuStoreInstalled()

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

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

function Instance

static URuStorePayClient * Instance()

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

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

function MakeProductId

static URuStorePayProductId * MakeProductId(
    FString productId
)

Создает объект идентификатора продукта.

Parameters:

  • productId Строка, содержащая идентификатор.

Return: Объект типа URuStorePayProductId.

function MakeProductIdArray

static TArray< URuStorePayProductId * > MakeProductIdArray(
    TArray< FString > productIds
)

Создает массив объектов идентификаторов продуктов.

Parameters:

  • productIds Массив строк, представляющих идентификаторы продуктов.

Return: Массив указателей на объекты типа URuStorePayProductId.

function MakeQuantity

static URuStorePayQuantity * MakeQuantity(
    int value =1
)

Создает объект, представляющее количество продукта.

Parameters:

  • value Целочисленное значение, представляющее количество продукта. По умолчанию равно 1.

Return: Объект типа URuStorePayQuantity.

function MakeOrderId

static URuStorePayOrderId * MakeOrderId(
    FString value
)

Создает объект уникального идентификатора оплаты.

Parameters:

  • value Строка, содержащая идентификатор.

Return: Объект типа URuStorePayOrderId.

function MakeDeveloperPayload

static URuStorePayDeveloperPayload * MakeDeveloperPayload(
    FString value
)

Создает объект полезной нагрузки разработчика.

Parameters:

  • value Строка, содержащая дополнительную информацию о заказе.

Return: Объект типа URuStorePayDeveloperPayload.

function MakeAppUserId

static URuStorePayAppUserId * MakeAppUserId(
    FString value
)

Создает объект внутреннего ID пользователя в приложении.

Parameters:

  • value Строка, представляющая идентификатор.

Return: Объект типа URuStorePayAppUserId.

function MakeAppUserEmail

static URuStorePayAppUserEmail * MakeAppUserEmail(
    FString value
)

Создает объект адреса электронной почты пользователя.

Parameters:

  • value Строка, представляющая адрес электронной почты.

Return: Объект типа URuStorePayAppUserEmail.

function MakeProductPurchaseParams

static FURuStorePayProductPurchaseParams MakeProductPurchaseParams(
    URuStorePayProductId * productId,
    URuStorePayAppUserEmail * appUserEmail =nullptr,
    URuStorePayAppUserId * appUserId =nullptr,
    URuStorePayDeveloperPayload * developerPayload =nullptr,
    URuStorePayOrderId * orderId =nullptr,
    URuStorePayQuantity * quantity =nullptr
)

Создает структуру параметров покупки продукта.

Parameters:

  • productId Идентификатор продукта, указанный при создании продукта в консоли разработчика.
  • appUserEmail Адрес электронной почты пользователя — опционально.
  • appUserId Внутренний ID пользователя в приложении — опционально.
  • developerPayload Указанная разработчиком строка, содержащая дополнительную информацию о заказе — опционально.
  • orderId Уникальный идентификатор оплаты, указанный разработчиком или сформированный автоматически (uuid) — опционально.
  • quantity Количество продукта — опционально.

Return: Объект типа FURuStorePayProductPurchaseParams с информацией о параметрах покупки.

variable PluginVersion

static const FString PluginVersion = "10.5.0";

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

Назад