API/Autodoc/Classes/RuStoreGodotPayClient.md

RU EN

RuStoreGodotPayClient

class_name RuStoreGodotPayClient extends Object

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

Public Member Functions

static	func	get_instance() -> RuStoreGodotPayClient: Получить экземпляр RuStoreGodotPayClient. Возвращает указатель на единственный экземпляр RuStoreGodotPayClient (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.
	func	get_user_authorization_status(): Проверка статуса авторизации пользователя.
	func	get_purchase_availability(): Проверка доступности платежей.
	func	is_rustore_installed() -> bool: Проверка установлен ли на устройстве пользователя RuStore. Возвращает true, если RuStore установлен, в противном случае — false.
	func	get_products(productIds: Array[RuStorePayProductId]): Получение списка продуктов, добавленных в ваше приложение через консоль RuStore. ◆ productIds — Список идентификаторов продуктов (задаются при создании продукта в консоли разработчика). Список продуктов имеет ограничение в размере 1000 элементов.
	func	get_purchases(product_type: Variant = null, purchase_status: Variant = null, acknowledgement_state: Variant = null,): Получение списка покупок пользователя. ◆ product_type — Тип продукта для фильтрации: ERuStorePayProductType.Item или null (все типы). ◆ purchase_status — Статус покупки для фильтрации: ERuStorePayPurchaseStatusFilter.Item или null (все статусы). ◆ acknowledgement_state — Состояние подтверждения для фильтрации: ERuStorePayAcknowledgementState.Item или null (все состояния).
	func	get_purchase(purchase_id: RuStorePayPurchaseId): Получение информации о покупке. ◆ purchaseId — Идентификатор продукта, который был присвоен продукту в консоли RuStore.
	func	purchase(parameters: RuStorePayProductPurchaseParams, preferred_purchase_type: ERuStorePayPreferredPurchaseType.Item = ERuStorePayPreferredPurchaseType.Item.ONE_STEP, sdk_theme: ERuStorePaySdkTheme.Item = ERuStorePaySdkTheme.Item.LIGHT, enable_purchase_event_listener: bool = false,): Покупка продукта. ◆ parameters — Параметры покупки продукта. ◆ preferred_purchase_type — Предпочитаемый тип покупки. ◆ sdk_theme — Цветовая тема платежной шторки. ◆ enable_purchase_event_listener — Дополнительный набор callback функций.
	func	purchase_two_step(parameters: RuStorePayProductPurchaseParams, sdk_theme: ERuStorePaySdkTheme.Item = ERuStorePaySdkTheme.Item.LIGHT, enable_purchase_event_listener: bool = false,): Покупка продукта с двустадийной оплатой. ◆ parameters — Параметры покупки продукта. ◆ sdk_theme — Цветовая тема платежной шторки. ◆ enable_purchase_event_listener — Дополнительный набор callback функций.
	func	confirm_two_step_purchase(purchase_id: RuStorePayPurchaseId, developer_payload: RuStorePayDeveloperPayload = null): Потребление (подтверждение) покупки. После вызова подтверждения покупка перейдёт в статус CONFIRMED. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара. ◆ purchase_id — Идентификатор покупки. ◆ developer_payload — Строка, содержащая дополнительную информацию о заказе (необязательный параметр).
	func	cancel_two_step_purchase(purchase_id: RuStorePayPurchaseId): Отмена покупки. Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара. ◆ purchase_id — Идентификатор покупки.
	func	update_acknowledgement_state(purchase_id: RuStorePayPurchaseId, state: ERuStorePayAcknowledgementState.Item, developer_payload: RuStorePayDeveloperPayload = null): Обновление состояния подтверждения покупки. ◆ purchase_id — Идентификатор покупки. ◆ state — Новое состояние подтверждения покупки. ◆ developer_payload — Строка, содержащая дополнительную информацию о заказе (необязательный параметр).
	func	get_billing_subscriptions(): Получение списка подписок, оформленных в SDK Billing Client.

Signals

	signal	on_get_user_authorization_status_success Действие, выполняемое при успешном завершении операции get_user_authorization_status.
	signal	on_get_user_authorization_status_failure Действие, выполняемое в случае ошибки get_user_authorization_status.
	signal	on_get_purchase_availability_success Действие, выполняемое при успешном завершении операции get_purchase_availability.
	signal	on_get_purchase_availability_failure Действие, выполняемое в случае ошибки get_purchase_availability.
	signal	on_get_products_success Действие, выполняемое при успешном завершении операции get_products.
	signal	on_get_products_failure Действие, выполняемое в случае ошибки get_products.
	signal	on_get_purchases_success Действие, выполняемое при успешном завершении операции get_purchases.
	signal	on_get_purchases_failure Действие, выполняемое в случае ошибки get_purchases.
	signal	on_get_purchase_success Действие, выполняемое при успешном завершении операции get_purchase.
	signal	on_get_purchase_failure Действие, выполняемое в случае ошибки get_purchase.
	signal	on_purchase_success Действие, выполняемое при успешном завершении операции purchase.
	signal	on_purchase_failure Действие, выполняемое в случае ошибки purchase.
	signal	on_purchase_two_step_success Действие, выполняемое при успешном завершении операции purchase_two_step.
	signal	on_purchase_two_step_failure Действие, выполняемое в случае ошибки purchase_two_step.
	signal	on_confirm_two_step_purchase_success Действие, выполняемое при успешном завершении операции confirm_two_step_purchase.
	signal	on_confirm_two_step_purchase_failure Действие, выполняемое в случае ошибки confirm_two_step_purchase.
	signal	on_cancel_two_step_purchase_success Действие, выполняемое при успешном завершении операции cancel_two_step_purchas.
	signal	on_cancel_two_step_purchase_failure Действие, выполняемое в случае ошибки cancel_two_step_purchas.
	signal	on_update_acknowledgement_state_success Действие, выполняемое при успешном завершении операции update_acknowledgement_state.
	signal	on_update_acknowledgement_state_failure Действие, выполняемое в случае ошибки update_acknowledgement_state.
	signal	on_get_billing_subscriptions_success Действие, выполняемое при успешном завершении операции get_billing_subscriptions.
	signal	on_get_billing_subscriptions_failure Действие, выполняемое в случае ошибки get_billing_subscriptions.
	signal	on_payment_completed Действие, выполняемое при успешном завершении платежа.
	signal	on_payment_failed Действие, выполняемое при ошибке платежа.
	signal	on_payment_started Действие, выполняемое при начале процесса оплаты.
	signal	on_purchase_cancelled Действие, выполняемое при отмене покупки пользователем.
	signal	on_purchase_created Действие, выполняемое при создании покупки.