Товары и покупки
RockRimStore
Класс RockRimStore предоставляет API для работы с магазином проекта: получение товаров, управление покупками и израсходование приобретённых товаров.
Методы
GetItems
Возвращает список всех доступных товаров магазина.
public static void GetItems(
Action<List<StoreItem>> onComplete,
Action<Error> onError
)
Параметры
| Имя | Тип | Описание |
|---|---|---|
onComplete | Action<List> | Вызывается при успешном получении списка товаров |
onError | Action<Error> | Вызывается при возникновении ошибки |
GetPurchases
Возвращает список покупок пользователя.
public static void GetPurchases(
Action<List<PurchaseInfo>> onComplete,
Action<Error> onError,
PurchaseFilter purchasesFilter = PurchaseFilter.IsNotConsumed
)
Параметры
| Имя | Тип | Описание |
|---|---|---|
onComplete | Action<List<PurchaseInfo>> | Вызывается при успешном получении списка покупок |
onError | Action<Error> | Вызывается при возникновении ошибки |
purchasesFilter | PurchaseFilter | Фильтр покупок |
Purchase
Запускает процесс покупки товара.
public static void Purchase(
string itemName,
Action<PurchaseCheckout> onComplete,
Action<Error> onError
)
Примечание
При вызове метода из редактора Unity покупка не выполняется реально, а эмулируется, после чего сразу вызывается колбэк onComplete.
Параметры
| Имя | Тип | Описание |
|---|---|---|
itemName | string | Уникальное название товара |
onComplete | Action<PurchaseCheckout> | Вызывается при успешной оплате товара |
onError | Action<Error> | Вызывается при возникновении ошибки |
Consume
Израсходует ранее приобретённый товар.
public static void Consume(
string itemName,
Action<PurchaseInfo> onComplete,
Action<Error> onError
)
Параметры
| Имя | Тип | Описание |
|---|---|---|
itemName | string | Уникальное название товара |
onComplete | Action<PurchaseCheckout> | Вызывается при успешной оплате товара |
onError | Action<Error> | Вызывается при возникновении ошибки |
Примечание
При вызове метода из редактора Unity израсходование не выполняется реально, а эмулируется, после чего сразу вызывается колбэк onComplete.
Классы
StoreItem
Класс StoreItem описывает элемент магазина (товар), содержащий базовую информацию о продукте: идентификатор, название, цену и тип. Используется как неизменяемая (read-only) структура данных после создания экземпляра.
Описание полей
| Поле | Тип | Описание |
|---|---|---|
Id | string | Уникальный идентификатор товара |
Name | string | Уникальное название товара |
DisplayName | string | Отображаемое название товара |
Description | string | Описание товара |
Price | int | Стоимость товара |
PurchaseInfo
Класс PurchaseInfo содержит информацию о покупке товара и используется для хранения и передачи данных о транзакции, полученных от магазина или платёжного провайдера. Объект является неизменяемым после создания.
Описание полей
| Поле | Тип | Описание |
|---|---|---|
Id | string | Уникальный идентификатор покупки |
ItemId | string | Уникальный идентификатор приобретённого товара |
ItemName | string | Уникальное название приобретённого товара |
CreatedAt | string | Дата и время создания покупки |
IsConsumed | bool | Признак того, что покупка была израсходована |
Provider | string | Платёжный провайдер |
Source | string | Источник покупки |
Status | string | Текущий статус покупки |
UpdatedAt | string | Дата и время последнего обновления статуса покупки |
PurchaseCheckout
Класс PurchaseCheckout представляет краткую информацию о результате оформления покупки (checkout). Используется для передачи итогового статуса покупки после завершения процесса оплаты.
Описание полей
| Поле | Тип | Описание |
|---|---|---|
PurchaseId | string | Идентификатор созданной покупки |
ItemName | string | Уникальное название приобретённого товара |
Status | string | Итоговый статус оформления покупки |
Error
Класс Error описывает структуру ошибки, возвращаемой SDK при выполнении операций.
Описание полей
| Поле | Тип | Описание |
|---|---|---|
StatusCode | string | Код ошибки или статус ответа. |
ErrorMessage | string | Текстовое описание ошибки. |
ErrorType | ErrorType | Тип ошибки. |