ModuleInstall

概述

描述AppGallery kit提供按需分发能力。

起始版本： 5.0.3(15)

汇总

[h2]文件

[h2]类型定义

[h2]枚举

[h2]函数

类型定义说明

[h2]ModuleInstall_InstalledModule

typedef struct ModuleInstall_InstalledModule ModuleInstall_InstalledModule

描述

安装模块信息。

起始版本： 5.0.3(15)

[h2]ModuleInstall_FetchModulesResult

typedef struct ModuleInstall_FetchModulesResult ModuleInstall_FetchModulesResult

描述

安装模块结果。

起始版本： 5.0.3(15)

[h2]ModuleInstall_StatusCallback

typedef struct ModuleInstall_StatusCallback ModuleInstall_StatusCallback

描述

模块安装状态回调。

起始版本： 5.0.3(15)

[h2]ModuleInstall_OnStatusCallback

typedef void (*ModuleInstall_OnStatusCallback)(char *bundleName, char *eventInfo)

描述

监听回调函数。

起始版本： 5.0.3(15)

枚举类型说明

[h2]ModuleInstall_ErrCode

enum ModuleInstall_ErrCode

描述

枚举错误码。

起始版本： 5.0.3(15)

[h2]ModuleInstall_InstallStatus

enum ModuleInstall_InstallStatus

描述

枚举安装状态。

起始版本： 5.0.3(15)

[h2]ModuleInstall_RequestCode

enum ModuleInstall_RequestCode

描述

枚举按需下载模块请求码。

起始版本： 5.0.3(15)

[h2]ModuleInstall_TaskStatus

enum ModuleInstall_TaskStatus

描述

枚举任务状态。

起始版本： 5.0.3(15)

函数说明

[h2]HMS_ModuleInstall_GetInstalledModule

ModuleInstall_ErrCode HMS_ModuleInstall_GetInstalledModule(const char *moduleName, unsigned int length,
    ModuleInstall_InstalledModule **installedModule)

描述

查询模块是否安装。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_QUERY_MODULE表示调用包管理模块接口异常。

[h2]HMS_ModuleInstall_GetInstalledModuleName

char *HMS_ModuleInstall_GetInstalledModuleName(const ModuleInstall_InstalledModule *installedModule)

描述

获取模块名。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回模块名。

[h2]HMS_ModuleInstall_GetInstalledModuleType

int HMS_ModuleInstall_GetInstalledModuleType(const ModuleInstall_InstalledModule *installedModule)

描述

获取模块类型。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回模块类型, 取值参考：bundleManager.ModuleType。当ModuleInstall_InstallStatus=1时，默认返回0。

[h2]HMS_ModuleInstall_GetModuleInstallStatus

ModuleInstall_InstallStatus HMS_ModuleInstall_GetModuleInstallStatus(const ModuleInstall_InstalledModule *installedModule)

描述

获取模块安装状态。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

模块安装状态，取值参考：ModuleInstall_InstallStatus。

[h2]HMS_ModuleInstall_FetchModules

ModuleInstall_ErrCode HMS_ModuleInstall_FetchModules(const char *bundleName, unsigned int length, char **moduleNames, unsigned int moduleNamesLength, ModuleInstall_FetchModulesResult **fetchModulesResult)

描述

请求下载模块。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_CONNECT_SA表示服务异常；返回E_CONNECT_SERVICE_EXTENSION表示服务连接失败；返回E_WRITE_PARAM表示参数写入异常；返回E_REQUEST_SERVER表示请求服务异常；返回E_RESPONSE_INVALID表示响应参数无法解析；返回E_INNER_ERROR表示内部错误。

[h2]HMS_ModuleInstall_GetFetchModulesRequestCode

ModuleInstall_RequestCode HMS_ModuleInstall_GetFetchModulesRequestCode(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载请求码。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

按需下载模块请求码，取值参考: ModuleInstall_RequestCode。

[h2]HMS_ModuleInstall_GetFetchModulesTaskStatus

ModuleInstall_TaskStatus HMS_ModuleInstall_GetFetchModulesTaskStatus(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载任务状态。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

模块下载任务状态，取值参考：ModuleInstall_TaskStatus。

[h2]HMS_ModuleInstall_GetFetchModulesTaskId

char *HMS_ModuleInstall_GetFetchModulesTaskId(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载任务id。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

任务id。

[h2]HMS_ModuleInstall_GetFetchModulesDesc

char *HMS_ModuleInstall_GetFetchModulesDesc(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载描述。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

下载描述。

[h2]HMS_ModuleInstall_GetFetchModules

char* HMS_ModuleInstall_GetFetchModules(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载模块名。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

下载模块名。

[h2]HMS_ModuleInstall_GetFetchModulesTotalSize

int HMS_ModuleInstall_GetFetchModulesTotalSize(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载总大小。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

下载模块总大小。

[h2]HMS_ModuleInstall_GetFetchModulesDownloadedSize

int HMS_ModuleInstall_GetFetchModulesDownloadedSize(const ModuleInstall_FetchModulesResult *fetchModulesResult)

描述

获取模块下载已下载大小。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

已下载模块大小。

[h2]HMS_ModuleInstall_CancelTask

ModuleInstall_ErrCode HMS_ModuleInstall_CancelTask(const char *taskId, unsigned int length, unsigned int cancelResult)

描述

取消下载任务。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_CONNECT_SERVICE_EXTENSION表示服务连接失败；返回E_WRITE_PARAM表示参数写入异常；返回E_REQUEST_SERVER表示请求服务异常；返回E_RESPONSE_INVALID表示响应参数无法解析。

[h2]HMS_ModuleInstall_PauseTask

ModuleInstall_ErrCode HMS_ModuleInstall_PauseTask(const char *taskId)

描述

暂停下载任务。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 26.0.0

参数：

返回：

返回E_NO_ERROR表示成功；返回E_INVALID_TASK_ID表示无效的任务ID；返回E_INTERNAL_COMMUNICATION表示内部通信异常。

[h2]HMS_ModuleInstall_ShowCellularDataConfirmation

ModuleInstall_ErrCode HMS_ModuleInstall_ShowCellularDataConfirmation(const char *taskId, unsigned int length, unsigned int showResult)

描述

展示流量弹窗。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_CONNECT_SERVICE_EXTENSION表示服务连接失败；返回E_WRITE_PARAM表示参数写入异常；返回E_REQUEST_SERVER表示请求服务异常；返回E_RESPONSE_INVALID表示响应参数无法解析。

[h2]HMS_ModuleInstall_CreateStatusCallback

ModuleInstall_StatusCallback *HMS_ModuleInstall_CreateStatusCallback(ModuleInstall_OnStatusCallback *onStatusCallback)

描述

创建下载进度监听回调。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

下载进度监听回调。

[h2]HMS_ModuleInstall_On

ModuleInstall_ErrCode HMS_ModuleInstall_On(const char *bundleName, unsigned int length, unsigned int appIndex, unsigned int period, ModuleInstall_StatusCallback **callback)

描述

下载进度监听。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_REPEATED_CALL表示重复调用接口；返回E_CONNECT_SA表示服务异常。

[h2]HMS_ModuleInstall_ReleaseStatusCallback

void HMS_ModuleInstall_ReleaseStatusCallback(ModuleInstall_StatusCallback *statusCallback)

描述

释放下载进度监听回调。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

[h2]HMS_ModuleInstall_Off

ModuleInstall_ErrCode HMS_ModuleInstall_Off(const char *bundleName, unsigned int length, unsigned int appIndex)

描述

取消下载进度监听。

系统能力： SystemCapability.AppGalleryService.Distribution.OnDemandInstall

起始版本： 5.0.3(15)

参数：

返回：

返回E_NO_ERROR表示成功；返回E_PARAMS表示输入参数错误；返回E_OFF_WITHOUT_ON表示未与监听接口共同使用；返回E_CONNECT_SA表示服务异常。