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

API/Autodoc/Classes/RuStore.AppUpdate.RuStoreAppUpdateManager.md

Public Functions

Name
bool Init()
Выполняет инициализацию синглтона RuStoreAppUpdateManager.
void GetAppUpdateInfo(Action< RuStoreError > onFailure, Action< AppUpdateInfo > onSuccess)
Выполняет проверку наличия обновлений.
void RegisterListener(IInstallStateUpdateListener listener)
Выполняет регистрацию слушателя статуса скачивания обновления.
void UnregisterListener(IInstallStateUpdateListener listener)
Если необходимости в слушателе больше нет, воспользуйтесь методом удаления слушателя UnregisterListener(), передав в метод ранее зарегистрированный слушатель.
void StartUpdateFlow(UpdateType updateType, Action< RuStoreError > onFailure, Action< UpdateFlowResult > onSuccess)
Запускает процедуру скачивания обновления приложения.
bool IsImmediateUpdateAllowed()
Выполняет проверку доступности принудительного обновления.
void CompleteUpdate(UpdateType updateType, Action< RuStoreError > onFailure)
Запускает процедуру установки обновления. В метод можно передавать только два типа завершения установки RuStore.AppUpdate.UpdateType.FLEXIBLE и RuStore.AppUpdate.UpdateType.SILENT.

Public Properties

Name
bool IsInitialized — Возвращает true, если синглтон был инициализирован, в противном случае — false.
RuStoreAppUpdateManager Instance — Возвращает единственный экземпляр RuStoreAppUpdateManager (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.

Public Attributes

Name
string PluginVersion — Версия плагина.

function Init

bool Init()

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

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


bool isInitialized = RuStoreAppUpdateManager.Instance.Init();

Filename: public_bool_Init.cs

function GetAppUpdateInfo

void GetAppUpdateInfo(
    Action< RuStoreError > onFailure,
    Action< AppUpdateInfo > onSuccess
)

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

Parameters:

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

RuStoreAppUpdateManager.Instance.GetAppUpdateInfo(
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (info) => {
        // Process update info
    }
);

Filename: public_void_GetAppUpdateInfo.cs

function RegisterListener

void RegisterListener(
    IInstallStateUpdateListener listener
)

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

Parameters:

  • listener Объект класса, реализующего интерфейс RuStore.AppUpdate.Internal.IInstallStateUpdateListener.

RuStoreAppUpdateManager.Instance.RegisterListener(listener);

Filename: public_void_RegisterListener.cs

function UnregisterListener

void UnregisterListener(
    IInstallStateUpdateListener listener
)

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

Parameters:

  • listener Объект класса, реализующего интерфейс RuStore.AppUpdate.Internal.IInstallStateUpdateListener.

RuStoreAppUpdateManager.Instance.UnregisterListener(listener);

Filename: public_void_UnregisterListener.cs

function StartUpdateFlow

void StartUpdateFlow(
    UpdateType updateType,
    Action< RuStoreError > onFailure,
    Action< UpdateFlowResult > onSuccess
)

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

Parameters:

  • updateType Тип процедуры скачивания обновления.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает объект RuStore.RuStoreError с информацией об ошибке.
  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает объект RuStore.AppUpdate.RuStore.UpdateFlowResult с информацией о результате операции обновления.

RuStoreAppUpdateManager.Instance.StartUpdateFlow(
    updateType: UpdateType.Flexible,
    onFailure: (error) => {
    },
    onSuccess: (result) => {
    }
);

Filename: public_void_StartUpdateFlow.cs

function IsImmediateUpdateAllowed

bool IsImmediateUpdateAllowed()

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

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


bool isAllowed = RuStoreAppUpdateManager.Instance.IsImmediateUpdateAllowed();

Filename: public_bool_IsImmediateUpdateAllowed.cs

function CompleteUpdate

void CompleteUpdate(
    UpdateType updateType,
    Action< RuStoreError > onFailure
)

Parameters:

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

RuStoreAppUpdateManager.Instance.CompleteUpdate(
    updateType: UpdateType.FLEXIBLE,
    onFailure: (error) => {
        // Process error
    }
);

Filename: public_void_CompleteUpdate.cs

property IsInitialized

bool IsInitialized;

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

property Instance

static RuStoreAppUpdateManager Instance;

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


var instance = RuStoreAppUpdateManager.Instance;

Filename: public_static_RuStoreAppUpdateManager_Instance.cs

variable PluginVersion

static string PluginVersion = "10.5.0";

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

Назад