rustore / RuStore Unreal Engine AppUpdate
CI/CD
Реестр контейнеров и пакетов

API/Autodoc/Classes/URuStoreAppUpdateManager.md

URuStoreAppUpdateManager

Класс реализует API для трех способов обновлений. В настоящий момент поддерживаются: отложенное, тихое (без UI от RuStore) и принудительное обновление.

#include <URuStoreAppUpdateManager.h>

Inherits from UObject, IRuStoreInstallStateUpdateListenerInterface, RuStoreSDK::RuStoreListenerContainer

Public Functions

Name
bool GetIsInitialized()
Проверка инициализации менеджера.
void SetAllowNativeErrorHandling(bool value)
Обработка ошибок в нативном SDK.
bool Init()
Выполняет инициализацию синглтона URuStoreAppUpdateManager.
void Dispose()
Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.
void ConditionalBeginDestroy()
long GetAppUpdateInfo(TFunction< void(long, TSharedPtr< FURuStoreAppUpdateInfo, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Выполняет проверку наличия обновлений.
long StartUpdateFlow(EURuStoreAppUpdateOptions appUpdateOptions, TFunction< void(long, EURuStoreUpdateFlowResult)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Запускает процедуру скачивания обновления приложения.
long CompleteUpdate(EURuStoreAppUpdateOptions appUpdateOptions, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Запускает процедуру установки обновления.
bool CheckIsImmediateUpdateAllowed()
Выполняет проверку доступности принудительного обновления.
int64 RegisterListener(TScriptInterface< IRuStoreInstallStateUpdateListenerInterface > stateListener)
Выполняет регистрацию слушателя статуса скачивания обновления.
bool UnregisterListener(TScriptInterface< IRuStoreInstallStateUpdateListenerInterface > stateListener)
Если необходимости в слушателе больше нет, воспользуйтесь методом удаления слушателя UnregisterListener(), передав в метод ранее зарегистрированный слушатель.
void GetAppUpdateInfo(int64 & requestId)
void StartUpdateFlow(int64 & requestId, EURuStoreAppUpdateOptions appUpdateOptions)
void CompleteUpdate(int64 & requestId, EURuStoreAppUpdateOptions appUpdateOptions)
void OnStateUpdated_Implementation(int64 listenerId, FURuStoreInstallState & state) override
URuStoreAppUpdateManager * Instance()
Получить экземпляр URuStoreAppUpdateManager.

Public Attributes

Name
const FString PluginVersion — Версия плагина.
FRuStoreGetAppUpdateInfoErrorDelegate OnGetAppUpdateInfoError
FRuStoreGetAppUpdateInfoResponseDelegate OnGetAppUpdateInfoResponse
FRuStoreStartUpdateFlowErrorDelegate OnStartUpdateFlowError
FRuStoreStartUpdateFlowResponseDelegate OnStartUpdateFlowResponse
FRuStoreCompleteUpdateErrorDelegate OnCompleteUpdateError
FRuStoreOnStateUpdatedInstanceDelegate OnStateUpdatedInstanceEvent

Additional inherited members

Public Functions inherited from IRuStoreInstallStateUpdateListenerInterface

Name
void OnStateUpdated(int64 listenerId, FURuStoreInstallState & state)
 Обработчик колбэка установки обновления.

Public Functions inherited from RuStoreSDK::RuStoreListenerContainer

Name
TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > ListenerBind(RuStoreListener * item)
void ListenerUnbind(long id)
void ListenerUnbind(RuStoreListener * item)
void ListenerUnbind(TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > item)
void ListenerRemoveAll()

function GetIsInitialized

bool GetIsInitialized()

Проверка инициализации менеджера.

Return: Возвращает true, если синглтон инициализирован, в противном случае — false.

function SetAllowNativeErrorHandling

void SetAllowNativeErrorHandling(
    bool value
)

Обработка ошибок в нативном SDK.

Parameters:

  • value true — разрешает обработку ошибок, false — запрещает.

function Init

bool Init()

Выполняет инициализацию синглтона URuStoreAppUpdateManager.

Return: Возвращает true, если инициализация была успешно выполнена, в противном случае — false.

function Dispose

void Dispose()

Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function GetAppUpdateInfo

long GetAppUpdateInfo(
    TFunction< void(long, TSharedPtr< FURuStoreAppUpdateInfo, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Выполняет проверку наличия обновлений.

Parameters:

  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStoreAppUpdateInfo с информцаией о необходимости обновления.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function StartUpdateFlow

long StartUpdateFlow(
    EURuStoreAppUpdateOptions appUpdateOptions,
    TFunction< void(long, EURuStoreUpdateFlowResult)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Запускает процедуру скачивания обновления приложения.

Parameters:

  • appUpdateOptions Тип процедуры скачивания обновления.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект EURuStoreUpdateFlowResult с информацией о результате операции обновления.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function CompleteUpdate

long CompleteUpdate(
    EURuStoreAppUpdateOptions appUpdateOptions,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Запускает процедуру установки обновления.

Parameters:

  • appUpdateOptions Тип процедуры завершения обновления.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function CheckIsImmediateUpdateAllowed

bool CheckIsImmediateUpdateAllowed()

Выполняет проверку доступности принудительного обновления.

Return: Возвращает true, если принудительное обновление доступно, в противном случае — false.

function RegisterListener

int64 RegisterListener(
    TScriptInterface< IRuStoreInstallStateUpdateListenerInterface > stateListener
)

Выполняет регистрацию слушателя статуса скачивания обновления.

Parameters:

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function UnregisterListener

bool UnregisterListener(
    TScriptInterface< IRuStoreInstallStateUpdateListenerInterface > stateListener
)

Если необходимости в слушателе больше нет, воспользуйтесь методом удаления слушателя UnregisterListener(), передав в метод ранее зарегистрированный слушатель.

Parameters:

Return: Возвращает true, если переданный слушатель найден в списке слушателей и удалён, в противном случае — false.

function GetAppUpdateInfo

void GetAppUpdateInfo(
    int64 & requestId
)

function StartUpdateFlow

void StartUpdateFlow(
    int64 & requestId,
    EURuStoreAppUpdateOptions appUpdateOptions
)

function CompleteUpdate

void CompleteUpdate(
    int64 & requestId,
    EURuStoreAppUpdateOptions appUpdateOptions
)

function OnStateUpdated_Implementation

void OnStateUpdated_Implementation(
    int64 listenerId,
    FURuStoreInstallState & state
) override

function Instance

static URuStoreAppUpdateManager * Instance()

Получить экземпляр URuStoreAppUpdateManager.

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

variable PluginVersion

static const FString PluginVersion = "10.5.0";

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

variable OnGetAppUpdateInfoError

FRuStoreGetAppUpdateInfoErrorDelegate OnGetAppUpdateInfoError;

variable OnGetAppUpdateInfoResponse

FRuStoreGetAppUpdateInfoResponseDelegate OnGetAppUpdateInfoResponse;

variable OnStartUpdateFlowError

FRuStoreStartUpdateFlowErrorDelegate OnStartUpdateFlowError;

variable OnStartUpdateFlowResponse

FRuStoreStartUpdateFlowResponseDelegate OnStartUpdateFlowResponse;

variable OnCompleteUpdateError

FRuStoreCompleteUpdateErrorDelegate OnCompleteUpdateError;

variable OnStateUpdatedInstanceEvent

FRuStoreOnStateUpdatedInstanceDelegate OnStateUpdatedInstanceEvent;
Назад