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

API/Autodoc/Classes/RuStore.PayClient.RuStorePayClient.md

RuStore::PayClient::RuStorePayClient

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

Public Functions

Name
void GetUserAuthorizationStatus(Action< RuStoreError > onFailure, Action< UserAuthorizationStatus > onSuccess)
Проверка статуса авторизации пользователя.
void GetPurchaseAvailability(Action< RuStoreError > onFailure, Action< PurchaseAvailabilityResult > onSuccess)
Проверка доступности платежей. Если все условия выполняются, возвращается RuStore.PayClient.PurchaseAvailabilityResult.isAvailable == true. В противном случае возвращается RuStore.PayClient.PurchaseAvailabilityResult.isAvailable == false.
bool IsRuStoreInstalled()
Проверка установлен ли на устройстве пользователя RuStore.
void GetProducts(ProductId[] productsId, Action< RuStoreError > onFailure, Action< List< Product > > onSuccess)
Получение списка продуктов, добавленных в ваше приложение через RuStore консоль.
void GetPurchases(Action< RuStoreError > onFailure, Action< List< IPurchase > > onSuccess)
Получение списка покупок пользователя.
void GetPurchases(ProductType? productType, Enum? purchaseStatus, Action< RuStoreError > onFailure, Action< List< IPurchase > > onSuccess)
Получение списка покупок пользователя.
void GetPurchase(PurchaseId purchaseId, Action< RuStoreError > onFailure, Action< IPurchase > onSuccess)
Получение информации о покупке.
void Purchase(ProductPurchaseParams parameters, PreferredPurchaseType preferredPurchaseType, Action< RuStoreError > onFailure, Action< ProductPurchaseResult > onSuccess, PurchaseEventListener? purchaseEventListener =null)
Покупка продукта.
void Purchase(ProductPurchaseParams parameters, PreferredPurchaseType preferredPurchaseType, SdkTheme sdkTheme, Action< RuStoreError > onFailure, Action< ProductPurchaseResult > onSuccess, PurchaseEventListener? purchaseEventListener =null)
Покупка продукта.
void PurchaseTwoStep(ProductPurchaseParams parameters, Action< RuStoreError > onFailure, Action< ProductPurchaseResult > onSuccess, PurchaseEventListener? purchaseEventListener =null)
Покупки продукта с двустадийной оплатой.
void PurchaseTwoStep(ProductPurchaseParams parameters, SdkTheme sdkTheme, Action< RuStoreError > onFailure, Action< ProductPurchaseResult > onSuccess, PurchaseEventListener? purchaseEventListener =null)
Покупки продукта с двустадийной оплатой.
void ConfirmTwoStepPurchase(PurchaseId purchaseId, DeveloperPayload? developerPayload, Action< RuStoreError > onFailure, Action onSuccess)
Потребление (подтверждение) покупки. После вызова подтверждения покупка перейдёт в статус CONFIRMED. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.
void CancelTwoStepPurchase(PurchaseId purchaseId, Action< RuStoreError > onFailure, Action onSuccess)
Отмена покупки. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.

Public Properties

Name
RuStorePayClient Instance — Возвращает единственный экземпляр RuStorePayClient (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.

Public Attributes

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

function GetUserAuthorizationStatus

void GetUserAuthorizationStatus(
    Action< RuStoreError > onFailure,
    Action< UserAuthorizationStatus > onSuccess
)

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

Parameters:

  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStore.RuStoreError с информацией об ошибке.

RuStorePayClient.Instance.GetUserAuthorizationStatus(
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    }
);

Filename: public_void_GetUserAuthorizationStatus.cs

function GetPurchaseAvailability

void GetPurchaseAvailability(
    Action< RuStoreError > onFailure,
    Action< PurchaseAvailabilityResult > onSuccess
)

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

Parameters:

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

RuStorePayClient.Instance.GetPurchaseAvailability(
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    }
);

Filename: public_void_GetPurchaseAvailability.cs

function IsRuStoreInstalled

bool IsRuStoreInstalled()


RuStorePayClient.Instance.IsRuStoreInstalled();

Filename: public_bool_IsRuStoreInstalled.cs

function GetProducts

void GetProducts(
    ProductId[] productsId,
    Action< RuStoreError > onFailure,
    Action< List< Product > > onSuccess
)

Parameters:

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

RuStorePayClient.Instance.GetProducts(
    productsId: new ProductId[] { new ProductId("product_id_1"), new ProductId("product_id_2") },
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (products) => {
        // Process result
    }
);

Filename: public_void_GetProducts.cs

function GetPurchases

void GetPurchases(
    Action< RuStoreError > onFailure,
    Action< List< IPurchase > > onSuccess
)

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

Parameters:

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

RuStorePayClient.Instance.GetPurchases(
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (purchases) => {
        // Process result
    }
);

Filename: public_void_GetPurchases.cs

function GetPurchases

void GetPurchases(
    ProductType? productType,
    Enum? purchaseStatus,
    Action< RuStoreError > onFailure,
    Action< List< IPurchase > > onSuccess
)

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

Parameters:

  • productType Тип продукта (необязательный параметр).
  • purchaseStatus Статус покупки (необязательный параметр).
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStore.RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает список объектов RuStore.PayClient.Purchase с информцаией о покупках.

RuStorePayClient.Instance.GetPurchases(
    productType: ProductType.CONSUMABLE_PRODUCT,
    purchaseStatus: ProductPurchaseStatus.CONFIRMED,
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (purchases) => {
        // Process result
    }
);

Filename: public_void_GetPurchases_with_params.cs

function GetPurchase

void GetPurchase(
    PurchaseId purchaseId,
    Action< RuStoreError > onFailure,
    Action< IPurchase > onSuccess
)

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

Parameters:

  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStore.RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект RuStore.PayClient.Purchase с информцаией о покупке.

RuStorePayClient.Instance.GetPurchase(
    purchaseId: new PurchaseId(value: "purchase_123"),
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    }
);

Filename: public_void_GetPurchase.cs

function Purchase

void Purchase(
    ProductPurchaseParams parameters,
    PreferredPurchaseType preferredPurchaseType,
    Action< RuStoreError > onFailure,
    Action< ProductPurchaseResult > onSuccess,
    PurchaseEventListener? purchaseEventListener =null
)

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

Parameters:

  • parameters Параметры покупки продукта.
  • preferredPurchaseType Предпочитаемый тип покупки – одностадийная (ONE_STEP) или двухстадийная (TWO_STEP).
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект ProductPurchaseResult с информцаией о результате покупки.
  • purchaseEventListener Набор callback функций, позволяющий получать данные об invoiceId и purchaseId на разных этапах покупки – опционально.

RuStorePayClient.Instance.Purchase(
    parameters: new ProductPurchaseParams {
        productId = new ProductId("product_id_123"),
        appUserEmail = new AppUserEmail("user@example.com"),
        appUserId = new AppUserId("user_id_456"),
        orderId = new OrderId("order_789"),
        quantity = new Quantity(2),
        developerPayload = new DeveloperPayload("payload_data")
    },
    preferredPurchaseType: PreferredPurchaseType.ONE_STEP,
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    },
    purchaseEventListener: new PurchaseEventListener(
        onPaymentCompleted: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentFailed: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentStarted: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCancelled: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCreated: (purchaseId, invoiceId) => { /* Process */ }
    )
);

Filename: public_void_Purchase.cs

function Purchase

void Purchase(
    ProductPurchaseParams parameters,
    PreferredPurchaseType preferredPurchaseType,
    SdkTheme sdkTheme,
    Action< RuStoreError > onFailure,
    Action< ProductPurchaseResult > onSuccess,
    PurchaseEventListener? purchaseEventListener =null
)

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

Parameters:

  • parameters Параметры покупки продукта.
  • preferredPurchaseType Предпочитаемый тип покупки – одностадийная (ONE_STEP) или двухстадийная (TWO_STEP).
  • sdkTheme Цветовая тема платежной шторки.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект ProductPurchaseResult с информцаией о результате покупки.
  • purchaseEventListener Набор callback функций, позволяющий получать данные об invoiceId и purchaseId на разных этапах покупки – опционально.

RuStorePayClient.Instance.Purchase(
    parameters: new ProductPurchaseParams {
        productId = new ProductId("product_id_123"),
        appUserEmail = new AppUserEmail("user@example.com"),
        appUserId = new AppUserId("user_456"),
        orderId = new OrderId("order_789"),
        quantity = new Quantity(2),
        developerPayload = new DeveloperPayload("payload_data")
    },
    preferredPurchaseType: PreferredPurchaseType.ONE_STEP,
    sdkTheme: SdkTheme.DARK,
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    },
    purchaseEventListener: new PurchaseEventListener(
        onPaymentCompleted: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentFailed: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentStarted: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCancelled: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCreated: (purchaseId, invoiceId) => { /* Process */ }
    )
);

Filename: public_void_Purchase_with_theme.cs

function PurchaseTwoStep

void PurchaseTwoStep(
    ProductPurchaseParams parameters,
    Action< RuStoreError > onFailure,
    Action< ProductPurchaseResult > onSuccess,
    PurchaseEventListener? purchaseEventListener =null
)

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

Parameters:

  • parameters Параметры покупки продукта.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект ProductPurchaseResult с информацией о результате покупки.
  • purchaseEventListener Набор callback функций, позволяющий получать данные об invoiceId и purchaseId на разных этапах покупки – опционально.

RuStorePayClient.Instance.PurchaseTwoStep(
    parameters: new ProductPurchaseParams(
        productId: new ProductId(value: "product_id_value"),
        appUserEmail: new AppUserEmail(value: "user@example.com"),
        appUserId: new AppUserId(value: "user_id_value"),
        orderId: new OrderId(value: "order_id_value"),
        quantity: new Quantity(value: 1),
        developerPayload: new DeveloperPayload(value: "payload_data")
    ),
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    },
    purchaseEventListener: new PurchaseEventListener(
        onPaymentCompleted: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentFailed: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentStarted: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCancelled: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCreated: (purchaseId, invoiceId) => { /* Process */ }
    )
);

Filename: public_void_PurchaseTwoStep.cs

function PurchaseTwoStep

void PurchaseTwoStep(
    ProductPurchaseParams parameters,
    SdkTheme sdkTheme,
    Action< RuStoreError > onFailure,
    Action< ProductPurchaseResult > onSuccess,
    PurchaseEventListener? purchaseEventListener =null
)

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

Parameters:

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

RuStorePayClient.Instance.PurchaseTwoStep(
    parameters: new ProductPurchaseParams {
        productId = new ProductId("product_id_123"),
        appUserEmail = new AppUserEmail("user@example.com"),
        appUserId = new AppUserId("user_456"),
        orderId = new OrderId("order_789"),
        quantity = new Quantity(2),
        developerPayload = new DeveloperPayload("payload_data")
    },
    sdkTheme: SdkTheme.DARK,
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (result) => {
        // Process result
    },
    purchaseEventListener: new PurchaseEventListener(
        onPaymentCompleted: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentFailed: (purchaseId, invoiceId) => { /* Process */ },
        onPaymentStarted: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCancelled: (purchaseId, invoiceId) => { /* Process */ },
        onPurchaseCreated: (purchaseId, invoiceId) => { /* Process */ }
    )
);

Filename: public_void_PurchaseTwoStep_with_theme.cs

function ConfirmTwoStepPurchase

void ConfirmTwoStepPurchase(
    PurchaseId purchaseId,
    DeveloperPayload? developerPayload,
    Action< RuStoreError > onFailure,
    Action onSuccess
)

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

Parameters:

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

RuStorePayClient.Instance.ConfirmTwoStepPurchase(
    purchaseId: new PurchaseId(value: "purchase123"),
    developerPayload: new DeveloperPayload(value: "payload456"),
    onFailure: (error) => {
        // Process error
    },
    onSuccess: () => {
        // Process success
    }
);

Filename: public_void_ConfirmTwoStepPurchase.cs

function CancelTwoStepPurchase

void CancelTwoStepPurchase(
    PurchaseId purchaseId,
    Action< RuStoreError > onFailure,
    Action onSuccess
)

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

Parameters:

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

RuStorePayClient.Instance.CancelTwoStepPurchase(
    purchaseId: new PurchaseId(value: "purchase_123"),
    onFailure: (error) => {
        // Process error
    },
    onSuccess: () => {
        // Process success
    }
);

Filename: public_void_CancelTwoStepPurchase.cs

property Instance

static RuStorePayClient Instance;

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


RuStorePayClient.Instance;

Filename: public_static_RuStorePayClient_Instance.cs

variable PluginVersion

static string PluginVersion = "10.3.1";

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

Назад