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


Public Functions

Name
bool Init()
Initializes the RuStoreAppUpdateManager singleton.
void GetAppUpdateInfo(Action< RuStoreError > onFailure, Action< AppUpdateInfo > onSuccess)
Checks for available updates.
void RegisterListener(IInstallStateUpdateListener listener)
Registers a listener for the update download status.
void UnregisterListener(IInstallStateUpdateListener listener)
If the listener is no longer needed, use the UnregisterListener method to remove the listener by passing the previously registered listener to the method.
void StartUpdateFlow(UpdateType updateType, Action< RuStoreError > onFailure, Action< UpdateFlowResult > onSuccess)
Starts the application update download procedure.
bool IsImmediateUpdateAllowed()
Checks whether immediate update is available.
void CompleteUpdate(UpdateType updateType, Action< RuStoreError > onFailure)
Starts the update installation procedure. Only two types of installation completion can be passed to the method: RuStore.AppUpdate.UpdateType.FLEXIBLE and RuStore.AppUpdate.UpdateType.SILENT.

Public Properties

Name
bool IsInitialized — Returns true if the singleton has been initialized; otherwise, false.
RuStoreAppUpdateManager Instance — Returns the single instance of RuStoreAppUpdateManager (Singleton pattern implementation). If the instance has not yet been created, creates it.

Public Attributes

Name
string PluginVersion — Plugin version.

function Init

bool Init()

Initializes the RuStoreAppUpdateManager singleton.

Return: Returns true if initialization was successful; otherwise, false.


bool isInitialized = RuStoreAppUpdateManager.Instance.Init();

Filename: public_bool_Init.cs

function GetAppUpdateInfo

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

Checks for available updates.

Parameters:

  • onFailure Action to perform on error. Returns a RuStore.RuStoreError object with error information.
  • onSuccess Action to perform on successful completion of the operation. Returns a RuStore.AppUpdate.AppUpdateInfo object with information about whether an update is needed.

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

Filename: public_void_GetAppUpdateInfo.cs

function RegisterListener

void RegisterListener(
    IInstallStateUpdateListener listener
)

Registers a listener for the update download status.

Parameters:

  • listener An object of a class implementing the RuStore.AppUpdate.Internal.IInstallStateUpdateListener interface.

RuStoreAppUpdateManager.Instance.RegisterListener(listener);

Filename: public_void_RegisterListener.cs

function UnregisterListener

void UnregisterListener(
    IInstallStateUpdateListener listener
)

If the listener is no longer needed, use the UnregisterListener method to remove the listener by passing the previously registered listener to the method.

Parameters:

  • listener An object of a class implementing the RuStore.AppUpdate.Internal.IInstallStateUpdateListener interface.

RuStoreAppUpdateManager.Instance.UnregisterListener(listener);

Filename: public_void_UnregisterListener.cs

function StartUpdateFlow

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

Starts the application update download procedure.

Parameters:

  • updateType Type of the update download procedure.
  • onFailure Action to perform on error. Returns a RuStore.RuStoreError object with error information.
  • onSuccess Action to perform on successful completion of the operation. Returns a RuStore.AppUpdate.RuStore.UpdateFlowResult object with information about the update operation result.

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

Filename: public_void_StartUpdateFlow.cs

function IsImmediateUpdateAllowed

bool IsImmediateUpdateAllowed()

Checks whether immediate update is available.

Return: Returns true if immediate update is available; otherwise, false.


bool isAllowed = RuStoreAppUpdateManager.Instance.IsImmediateUpdateAllowed();

Filename: public_bool_IsImmediateUpdateAllowed.cs

function CompleteUpdate

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

Parameters:

  • updateType Type of the update completion procedure.
  • onFailure Action to perform on error. Returns a RuStore.RuStoreError object with error information.

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

Filename: public_void_CompleteUpdate.cs

property IsInitialized

bool IsInitialized;

Returns true if the singleton has been initialized; otherwise, false.

property Instance

static RuStoreAppUpdateManager Instance;

Returns the single instance of RuStoreAppUpdateManager (Singleton pattern implementation). If the instance has not yet been created, creates it.


var instance = RuStoreAppUpdateManager.Instance;

Filename: public_static_RuStoreAppUpdateManager_Instance.cs

variable PluginVersion

static string PluginVersion = "10.5.2";

Plugin version.