2.0.0
Общие сведения
RuStore In-app updates SDK поддерживает актуальную версию приложения на устройстве пользователя. Это помогает пользователю увидеть обновления, оценить улучшение производительности и результат исправления ошибок.
Пример пользовательского сценария
Используйте RuStore In-app updates SDK для реализации различных способов обновлений. В настоящий момент поддерживаются: отложенное, тихое (без UI от RuStore) и принудительное обновление.
Ознакомьтесь с приложением-примером чтобы узнать, как правильно интегрировать SDK обновлений.
![img](/help/zh/assets/images/AnyAppupdate1-9bf0332f44b06cec250a8bae0c36f0d0.webp)
![img](/help/zh/assets/images/AnyAppupdate2-e6dc98404024a8c7a0aea829a9f13d13.webp)
![img](/help/zh/assets/images/AnyAppupdate3-a6217dca731da22938cee1be5a7f5897.webp)
![img](/help/zh/assets/images/AnyAppupdate4-8837f322ff5d9a322379a1bd46f7ad40.webp)
Условия корректной работы SDK
Для работы RuStore In-app updates SDK необходимо соблюдение следующих условий.
- ОС Android версии 7.0 или выше.
- Версия RuStore на устройстве пользователя актуальная.
- Пользователь авторизован в RuStore.
- Приложению RuStore разрешена установка приложений.
Подключение в проект
Для подключения выполните следующие шаги.
- Скопируйте проекты плагина из официального репозитория RuStore на GitFlic.
- Откройте в вашей IDE проект Android из папки
godot_plugin_libraries
. - Поместите в папку
godot_plugin_libraries / libs
пакетgodot-lib.xxx.yyy.template_release.aar
, гдеxxx.yyy
версия вашей редакции Godot Engine.
Пакет godot-lib.xxx.yyy.template_release.aar
для вашей версии Godot Engine можно найти на странице разработчика на Sourceforge.net.
- Выполните сборку проекта командой
gradle assemble
.
При успешном выполнении сборки в папке godot_example/android/plugins
будут созданы файлы:
RuStoreGodotAppUpdate.gdap
.RuStoreGodotAppUpdate.aar
.RuStoreGodotCore.gdap
.RuStoreGodotCore.aar
.
Обратите особое внимание, что библиотеки плагинов должны быть собраны под вашу версию Godot Engine.
-
Скопируйте содержимое папки
godot_example / android / plugins
в папкуyour_project / android / plugins
. -
В пресете сборки Android в списке «Плагины» отметьте строки «Ru Store Godot App Update» и «Ru Store Godot Core».
Создание менеджера обновлений
Перед вызовом методов библиотеки необходимо создать менеджер обновлений.
var _appUpdate_client: RuStoreGodotAppUpdateManager = null
func _ready():
_appUpdate_client = RuStoreGodotAppUpdateManager.get_instance();
Проверка наличия обновлений
Прежде чем запрашивать обновление, проверьте, доступно ли обновление для вашего приложения. Для проверки наличия обновлений вызовите методget_app_update_info
. При вызове данного метода проверяются следующие условия.
- На устройстве пользователя установлена актуальная версия RuStore.
- Пользователь и приложение не должны быть заблокированы в RuStore.
- Приложению RuStore разрешена установка приложений.
- Пользователь авторизован в RuStore.
Перед использованием метода необходимо единожды выполнить подписку на события:
on_get_app_update_info_success
;on_get_app_update_info_failure
.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_get_app_update_info_success.connect(_on_get_app_update_info_success)
_appUpdate_client.on_get_app_update_info_failure.connect(_on_get_app_update_info_failure)
func _on_get_app_update_info_success(response: RuStoreAppUpdateInfo):
pass
func _on_get_app_update_info_failure(error: RuStoreError):
pass
_appUpdate_client.get_app_update_info()
on_get_app_update_info_success
возвращает объект, который содержит информацию о необходимости обновления. Запросите информацию заранее, чтобы выполнить запуск скачивания обновления без задержки в удобный для пользователя момент времени.
class_name RuStoreAppUpdateInfo extends Object
var updateAvailability: ERuStoreUpdateAvailability.Item
var installStatus: ERuStoreInstallStatus.Item
var availableVersionCode: int
func _init(json: String = ""):
if json == "":
updateAvailability = ERuStoreUpdateAvailability.Item.UNKNOWN
installStatus = ERuStoreInstallStatus.Item.UNKNOWN
availableVersionCode = 0
else:
var obj = JSON.parse_string(json)
updateAvailability = int(obj["updateAvailability"])
installStatus = int(obj["installStatus"])
availableVersionCode = int(obj["availableVersionCode"])
-
updateAvailability
— доступность обновления:UNKNOWN (int == 0)
— по умолчанию.UPDATE_NOT_AVAILABLE (int == 1)
— обновление не нужно.UPDATE_AVAILABLE (int == 2)
— обновление требуется загрузить или обновление уже загружено на устройство пользователя.DEVELOPER_TRIGGERED_UPDATE_IN_PROGRESS (int == 3)
— обновление уже скачивается или установка уже запущена.
-
installStatus
— статус установки обновления, если пользователь уже устанавливает обновление в текущий момент времени:UNKNOWN (int == 0)
— по умолчанию.DOWNLOADED (int == 1)
— скачано.DOWNLOADING (int == 2)
— скачивается.FAILED (int == 3)
— ошибка.PENDING (int == 5)
— в ожидании.
-
availableVersionCode
— код версии обновления.
Запуск скачивания обно вления возможен только в том случае, если поле updateAvailability
содержит значение UPDATE_AVAILABLE
.
on_get_app_update_info_failure
возвращает объект с информацией об ошибке. Структура ошибки описана в разделе Обработка ошибок.
Скачивание и установка обновлений
Использование слушателя
После подтверждения доступности обновления (RuStoreAppUpdateInfo
) вы можете получать статус скачивания обновления. Для этого необходимо выполнить подписку на событие on_state_updated
и вызовом метода register_listener
запустить слушатель статуса скачивания.
Проверка статуса скачивания обновления
Подписка на событие on_state_updated
выполняется единожды. Прослушивание процесса скачивания активируется с помощью метода register_listener
.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_state_updated.connect(_on_state_updated)
_appUpdate_client.register_listener()
func _on_state_updated(installState: RuStoreInstallState):
pass
Обратный вызов (callback) on_state_updated
возвр ащает объект RuStoreInstallState
с информацией о ходе процесса обновления.
class_name RuStoreInstallState extends Object
var bytesDownloaded: int
var totalBytesToDownload: int
var percentDownloaded: float
var installStatus: ERuStoreInstallStatus.Item
var installErrorCode: ERuStoreInstallErrorCode.Item
func _init(json: String = ""):
if json == "":
bytesDownloaded = 0
totalBytesToDownload = 0
percentDownloaded = 0
installStatus = ERuStoreInstallStatus.Item.UNKNOWN
installErrorCode = ERuStoreInstallErrorCode.Item.ERROR_UNKNOWN
else:
var obj = JSON.parse_string(json)
bytesDownloaded = int(obj["bytesDownloaded"])
totalBytesToDownload = int(obj["totalBytesToDownload"])
installStatus = int(obj["installStatus"])
installErrorCode = int(obj["installErrorCode"])
if totalBytesToDownload > 0:
percentDownloaded = float(bytesDownloaded) / totalBytesToDownload * 100
else:
percentDownloaded = 0
if installStatus == ERuStoreInstallStatus.Item.DOWNLOADED:
percentDownloaded = 100
-
installStatus
— статус установки обновления, если пользователь уже устанавливает обновление в текущий момент времени:UNKNOWN (Int = 0)
— по умолчанию;DOWNLOADED (Int = 1)
— скачано;DOWNLOADING (Int = 2)
— скачивается;FAILED (Int = 3)
— ошибка;PENDING (Int = 5)
— в ожидании;
-
bytesDownloaded
— количество загруженных байт; -
totalBytesToDownload
— общее количество байт, которое необходимо скачать; -
packageName
— имя пакета обновления; -
installErrorCode
— код ошибки во время скачивания. Коды ошибок описаны в разделе Обработка ошибок.
Удаление слушателя
Если необходимости в слушателе больше нет, воспользуйтесь методом удаления слушателя unregisterListener
.
_appUpdate_client.unregister_listener()
Запуск скачивания обновления
Отложенное обновление
Описание сценария отложенного обновления
Обновление с UI от RuStore
![img](/help/zh/assets/images/scenario-delayed-update-8b203cb270ea5fd9d8d310caca47da39.webp)
- Пользователю будет показан диалог с UI от RuStore для подтверждения обновления.
- При нажатии на кнопку «Обновить» покажется диалоговое окно для подтверждения установки обновления.
- После завершения установки приложение закроется.
Запуск сценария обновления
Перед использованием методов запуска сценариев обновления необходимо единожды выполнить подписку на события:
on_start_update_flow_success
.on_start_update_flow_failure
.
Для запуска скачивания обновления приложения используйте метод start_update_flow_delayed
.
Объект RuStoreAppUpdateInfo
после однократного использования становится невалидным. Для повторного вызова метода start_update_flow_delayed
запросите объект RuStoreAppUpdateInfo
повторно, используя метод get_app_update_info
.
См. раздел Проверка наличия обновлений.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_start_update_flow_success.connect(_on_start_update_flow_success)
_appUpdate_client.on_start_update_flow_failure.connect(_on_start_update_flow_failure)
func _on_start_update_flow_success(flowResult: ERuStoreUpdateFlowResult.Item):
pass
func _on_start_update_flow_failure(error: RuStoreError):
pass
_appUpdate_client.start_update_flow_delayed()
Обратный вызов (callback) on_start_update_flow_success
возвращает перечисление ERuStoreUpdateFlowResult.Item
с информацией о результате обновления:
RESULT_OK (int = -1)
— пользователь подтвердил скачивание обновления.RESULT_CANCELED (int = 0)
— пользователь отказался от скачивания обновления.
Обратный вызов (callback) on_start_update_flow_failure
возвращает объект RuStoreError
с информацией об ошибке. Структура ошибки RuStoreError
описана в разделе Обработка ошибок.
После получения статуса ERuStoreUpdateFlowResult.Item.DOWNLOADED
в поле installStatus
объекта RuStoreInstallState
, должен быть вызван метод установки обновлен ия.
Принудительное обновление
Описание сценария принудительного обновления
Обновление с UI от RuStore
![img](/help/zh/assets/images/scenario-forced-update-bdbb37026442d5850c063420e5ecc62a.webp)
- Пользователю будет показан полноэкранный диалог с UI от RuStore для подтверждения обновления. Использование приложения будет заблокировано до тех пор, пока обновление не будет установлено.
- При нажатии на кнопку «Обновить» отобразится диалоговое окно для подтверждения установки обновления.
- Далее при нажатии на кнопку «Установить» появится полноэкранный диалог об установке новой версии приложения.
- После завершения установки приложение перезапустится.
Приложение будет перезапущено, если версия Rustore больше, либо равна 1.37. Если версия Rustore ниже, то приложение закроется для установки обновления и не будет открыто заново, когда закончится обновление.
Запуск сценария обновления
После получения успешного ответа отget_appupdateinfo
можно проверить доступность принудительного обновления, используя метод check_is_immediate_update_allowed
.
# Инициализация _appUpdate_client
var isAvailable: bool = _appUpdate_client.check_is_immediate_update_allowed()
true
— принудительное обновление доступно.false
— принудительное обновление недоступно.
Результат метода check_is_immediate_update_allowed
рекомендуется использовать для принятия решения о запуске принудительного обновления, но данный результат не влияет на возможность запуска сценария. Необходимость запуска сценария обновления может происходить по вашей внутренней логике.
Перед использованием методов запуска сценариев обновления необходимо единожды выполнить подписку на события:
on_start_update_flow_success
.on_start_update_flow_failure
.
Для запуска скачивания обновления приложения используйте метод start_update_flow_immediate
.
Объект RuStoreAppUpdateInfo
после однократного использования становится невалидным. Для повторного вызова метода start_update_flow_immediate
запросите объект RuStoreAppUpdateInfo
повторно, используя метод get_app_update_info
.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_start_update_flow_success.connect(_on_start_update_flow_success)
_appUpdate_client.on_start_update_flow_failure.connect(_on_start_update_flow_failure)
func _on_start_update_flow_success(flowResult: ERuStoreUpdateFlowResult.Item):
pass
func _on_start_update_flow_failure(error: RuStoreError):
pass
_appUpdate_client.start_update_flow_immediate()
Обратный вызов (callback) on_start_update_flow_success
возвращает перечисление ERuStoreUpdateFlowResult.Item
с информацией о результате обновления:
RESULT_OK (int = -1)
— обновление выполнено, код может быть не получен, т.к. приложение в момент обновления завершается.RESULT_CANCELED (int = 0)
— флоу прервано пользователем или произошла ошибка. Предполагается, что при получении этого кода, следует завершить работу приложения.ACTIVITY_NOT_FOUND (int = 2)
— RuStore не установлен, либо установлена версия, которая не поддерживает принудительное обновление (RuStore versionCode
<191
).
Обратный вызов (callback) on_start_update_flow_failure
возвращает объект RuStoreError
с информацией об ошибке. Структура ошибки RuStoreError
описана в разделе Обработка ошибок.
При успешном обновлении дальнейших действий не требуется.
Тихое обновление
Описание сценария тихого обновления
Обновление без UI от RuStore
![img](/help/zh/assets/images/scenario-silent-update-62fe9fe724c2a63e0399cfc7cdaa53ce.webp)
- Пользователю будет показано диалоговое окно для подтверждения установки обновления (обновление будет скачано в фоне).
- После завершения установки приложение закроется.
Запуск сценария обновления
Перед использованием методов запуска сценариев обновления необходимо единожды выполнить подписку на события:
on_start_update_flow_success
.on_start_update_flow_failure
.
Для запуска скачивания обновления приложения используйте метод start_update_flow_silent
.
Объект RuStoreAppUpdateInfo
после однократного использования становится невалидным. Для повторного вызова метода start_update_flow_silent
запросите объект RuStoreAppUpdateInfo
повторно, используя метод get_app_update_info
.
См. раздел Проверка наличия обновлений.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_start_update_flow_success.connect(_on_start_update_flow_success)
_appUpdate_client.on_start_update_flow_failure.connect(_on_start_update_flow_failure)
func _on_start_update_flow_success(flowResult: ERuStoreUpdateFlowResult.Item):
pass
func _on_start_update_flow_failure(error: RuStoreError):
pass
_appUpdate_client.start_update_flow_silent()
Обратный вызов (callback) on_start_update_flow_success
возвращает перечисление ERuStoreUpdateFlowResult.Item
с информацией о результате обновления:
RESULT_OK (int = -1)
— задача на скачивание обновления зарегистрирована.
Обратный вызов (callback) on_start_update_flow_failure
возвращает объект RuStoreError
с информацией об ошибке. Структура ошибки RuStoreError
описана в разделе Обработка ошибок.
Вызовите метод установки обновления после получения статуса ERuStoreUpdateFlowResult.Item.DOWNLOADED
в поле installStatus
объекта RuStoreInstallState
.
Для тихого обновления рекомендуется реализовать свой интерфейс.
Установка обновления
Рекомендуется уведомить пользователя о готовности обновления к установке.
После завершения скачивания файла обновления вы можете запустить установку обновления. Для запуска установки обновления используйте метод complete_update
. Перед использованием метода необходимо единожды выполнить подписку на событие.
on_complete_update_failure
.
func _ready():
# Инициализация _appUpdate_client
_appUpdate_client.on_complete_update_failure.connect(_on_complete_update_failure)
func _on_complete_update_failure(error: RuStoreError):
pass
_appUpdate_client.complete_update()
Обновление происходит через нативный инструмент Android. В случае успешного обновления приложение закроется.
Обратный вызов (callback) on_complete_update_failure
возвращает объект RuStoreError
с информацией об ошибке в параметре error
. Структура ошибки RuStoreError
описана в разделе Обработка ошибок.
Обработка ошибок
При получении любого события *_failure
не рекомендуется самостоятельно отображать ошибку пользователю. Отображение ошибки может негативно повлиять на пользовательский опыт.
class_name RuStoreError extends Object
var description: String
func _init(json: String = ""):
if json == "":
description = ""
else:
var obj = JSON.parse_string(json)
description = obj["detailMessage"]
description
– описание ошибки.
Возможные ошибки
RuStoreNotInstalledException
— на устройстве пользователя не установлен RuStore;RuStoreOutdatedException
— версия RuStore, установленная на устройстве пользователя, не поддерживает данный SDK;RuStoreUserUnauthorizedException
— пользователь не авторизован в RuStore;RuStoreException
— базовая ошибка RuStore, от которой наследуются остальные ошибки;RuStoreInstallException(public val code: Int)
— ошибка скачивания и установки.ERROR_UNKNOWN(Int = 4001)
— неизвестная ошибка.ERROR_DOWNLOAD(Int = 4002)
— ошибка при скачивании.ERROR_BLOCKED(Int = 4003)
— установка заблокированна системой.ERROR_INVALID_APK(Int = 4004)
— некорректный APK обновления.ERROR_CONFLICT(Int = 4005)
— конфликт с те кущей версией приложения.ERROR_STORAGE(Int = 4006)
— недостаточно памяти на устройстве.ERROR_INCOMPATIBLE(Int = 4007)
— несовместимо с устройством.ERROR_APP_NOT_OWNED(Int = 4008)
— приложение не куплено.ERROR_INTERNAL_ERROR(Int = 4009)
— внутренняя ошибка.ERROR_ABORTED(Int = 4010)
— пользователь отказался от установки обновления.ERROR_APK_NOT_FOUND(Int = 4011)
— APK для запуска установки не найден.ERROR_EXTERNAL_SOURCE_DENIED(Int = 4012)
— запуск обновления запрещён. Например, в первом методе вернулся ответ о том, что обновление недоступно, но пользователь вызывает второй метод.ERROR_ACTIVITY_SEND_INTENT(Int = 9901)
— ошибка отправки intent на открытие активити.ERROR_ACTIVITY_UNKNOWN(Int = 9902)
— неизвестная ошибка отрытия активити.