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

API/Autodoc/Classes/RuStoreGodotBillingClient.md

RuStoreGodotBillingClient

class_name RuStoreGodotBillingClient extends Object

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

Public Member Functions

static func get_instance() -> RuStoreGodotBillingClient:
Получить экземпляр RuStoreGodotBillingClient.
Возвращает указатель на единственный экземпляр RuStoreGodotBillingClient (реализация паттерна Singleton).
Если экземпляр еще не создан, создает его.
func init(consoleApplicationId: String, deeplinkScheme: String, debugLogs: bool = false):
Выполняет инициализацию синглтона URuStoreBillingClient.
Параметры инициализации задаются объектом типа FURuStoreBillingClientConfig.
◆ consoleApplicationId — Идентификатор приложения из консоли RuStore.
◆ deeplinkScheme — Схема deeplink, необходимая для возврата в ваше приложение после оплаты через стороннее приложение (например, SberPay или СБП).
SDK генерирует свой хост к данной схеме.
◆ debugLogs — Флаг, регулирующий ведение журнала событий.
Укажите значение true, если хотите, чтобы события попадали в журнал.
В ином случае укажите false.
func set_theme(themeCode: int):
SDK поддерживает динамическую смены темы.
Установить тему интерфейса.
◆ themeCode — Новая тема, заданная значением из перечисления EURuStoreTheme.
func check_purchases_availability():
Проверка доступности платежей.
func get_authorization_status():
Проверка статуса авторизации у пользователя.
func is_rustore_installed() -> bool:
Проверка установлен ли на устройстве пользователя RuStore.
Возвращает true, если RuStore установлен, в противном случае — false.
func get_products(productIds: Array):
Получение списка продуктов, добавленных в ваше приложение через RuStore консоль.
◆ productIds — Список идентификаторов продуктов (задаются при создании продукта в консоли разработчика).
Список продуктов имеет ограничение в размере 1000 элементов.
func purchase_product(productId: String, params: Dictionary = {}):
Покупка продукта.
◆ productId — Идентификатор продукта, который был присвоен продукту в RuStore Консоли (обязательный параметр).
◆ params — Опциональные параметры:
- orderId — идентификатор заказа, создаётся на стороне AnyApp. (необязательно — если не указан, то генерируется автоматически);
- quantity — количество продукта (необязательный параметр — если не указывать, будет подставлено значение 1) (необязательно);
- developerPayload — строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки.
func get_purchases():
Получение списка покупок пользователя.
func confirm_purchase(purchase_id: String, developer_payload: String = ""):
Потребление (подтверждение) покупки.
Запрос на потребление (подтверждение) покупки должен сопровождаться выдачей товара.
◆ purchaseId — Идентификатор покупки.
◆ developer_payload — Строка с дополнительной информацией о заказе,
которую вы можете установить при инициализации процесса покупки.
func delete_purchase(purchase_id: String):
Отмена покупки.
◆ purchase_id — Идентификатор покупки.
func get_purchase_info(purchase_id: String):
Получение информации о покупке.
◆ purchaseId — Идентификатор покупки.

Signals

signal on_check_purchases_availability_success
Действие, выполняемое при успешном завершении операции check_purchases_availability.
signal on_check_purchases_availability_failure
Действие, выполняемое в случае ошибки check_purchases_availability.
signal on_get_authorization_status_success
Действие, выполняемое при успешном завершении операции get_authorization_status.
signal on_get_authorization_status_failure
Действие, выполняемое в случае ошибки get_authorization_status.
signal on_get_products_success
Действие, выполняемое при успешном завершении операции get_products.
signal on_get_products_failure
Действие, выполняемое в случае ошибки get_products.
signal on_purchase_product_success
Действие, выполняемое при успешном завершении операции purchase_product.
signal on_purchase_product_failure
Действие, выполняемое в случае ошибки purchase_product.
signal on_get_purchases_success
Действие, выполняемое при успешном завершении операции get_purchases.
signal on_get_purchases_failure
Действие, выполняемое в случае ошибки get_purchases.
signal on_confirm_purchase_success
Действие, выполняемое при успешном завершении операции confirm_purchase.
signal on_confirm_purchase_failure
Действие, выполняемое в случае ошибки confirm_purchase.
signal on_delete_purchase_success
Действие, выполняемое при успешном завершении операции delete_purchase.
signal on_delete_purchase_failure
Действие, выполняемое в случае ошибки delete_purchase.
signal on_get_purchase_info_success
Действие, выполняемое при успешном завершении операции.
signal on_get_purchase_info_failure
Действие, выполняемое в случае ошибки.
signal on_payment_logger_debug
Логирует отладочное сообщение.
Используется для записи логов, которые помогают в процессе отладки приложения.
signal on_payment_logger_error
Логирует сообщение об ошибке.
Используется для записи логов, которые сигнализируют о возникновении ошибок,
требующих вмешательства или исправления.
signal on_payment_logger_info
Логирует информационное сообщение.
Используется для записи стандартных логов, которые помогают отслеживать нормальное выполнение программы.
signal on_payment_logger_verbose
Логирует подробное сообщение.
Используется для записи детализированных логов, которые полезны для отладки.
signal on_payment_logger_warning
Логирует предупреждающее сообщение.
Используется для записи логов, которые сигнализируют о потенциальных проблемах,
которые не мешают выполнению программы, но могут потребовать внимания.
Назад