moduleInstallManager (产品特性按需分发)

导入模块

import { moduleInstallManager } from '@kit.StoreKit';

InstalledModule

当前模块的安装信息。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

ModuleInstallSessionState

请求、监听/注销监听接口，接口调用结果。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

InstallStatus

安装结果状态码类型的枚举。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

ReturnCode

添加模块、取消下载、流量提醒弹窗接口，接口调用结果码类型的枚举。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

RequestErrorCode

请求、监听/注销监听接口，接口调用结果码类型的枚举。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

TaskStatus

请求、监听/注销监听接口，接口返回下载任务状态码类型的枚举。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

moduleInstallManager.getInstalledModule

getInstalledModule(moduleName: string): InstalledModule

查询模块安装信息接口。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  const moduleInfo: moduleInstallManager.InstalledModule = moduleInstallManager.getInstalledModule('AModule');
  hilog.info(0, 'TAG', 'Succeeded in getting installedModule moduleInfo' );
} catch (error) {
  hilog.error(0, 'TAG', `getting installedModule onError.code is ${error.code}, message is ${error.message}`);
}

InstallProvider

按需加载controller父类对象。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

InstallRequest

按需加载请求父类对象。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

ModuleInstallProvider

实现按需加载的方法，提供创建按需加载请求对象能力，继承InstallProvider。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

[h2]ModuleInstallProvider.createModuleInstallRequest

createModuleInstallRequest(context: common.UIAbilityContext | common.ExtensionContext): ModuleInstallRequest

创建按需加载请求对象，可通过返回值设置请求参数。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import type { common } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  const myModuleInstallProvider: moduleInstallManager.ModuleInstallProvider =
    new moduleInstallManager.ModuleInstallProvider();
  const context: common.UIAbilityContext | common.ExtensionContext = getContext(this) as common.UIAbilityContext;
  const myModuleInstallRequest: moduleInstallManager.ModuleInstallRequest =
    myModuleInstallProvider.createModuleInstallRequest(context);
} catch (error) {
  hilog.error(0, 'TAG', `createModuleInstallRequest onError.code is ${error.code}, message is ${error.message}`);
}

ModuleInstallRequest

按需下载请求对象，继承InstallRequest。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

[h2]ModuleInstallRequest.addModule

addModule(moduleName: string): ReturnCode

添加要按需加载的模块名。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import type { common } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  const myModuleInstallProvider: moduleInstallManager.ModuleInstallProvider =
    new moduleInstallManager.ModuleInstallProvider();
  const context: common.UIAbilityContext | common.ExtensionContext = getContext(this) as common.UIAbilityContext;
  const myModuleInstallRequest: moduleInstallManager.ModuleInstallRequest =
    myModuleInstallProvider.createModuleInstallRequest(context);
  const aResult: moduleInstallManager.ReturnCode = myModuleInstallRequest.addModule('AModule');
  const bResult: moduleInstallManager.ReturnCode = myModuleInstallRequest.addModule('BModule');
  hilog.info(0, 'TAG', 'Succeeded in getting aResult:' + aResult + ' bResult:' + bResult);
} catch (error) {
  hilog.error(0, 'TAG', `addModule onError.code is ${error.code}, message is ${error.message}`);
}

moduleInstallManager.fetchModules

fetchModules(moduleInstallRequest: ModuleInstallRequest): Promise<ModuleInstallSessionState>

按需加载请求接口，使用Promise方式异步返回结果。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import type { common } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  const myModuleInstallProvider: moduleInstallManager.ModuleInstallProvider =
    new moduleInstallManager.ModuleInstallProvider();
  const context: common.UIAbilityContext | common.ExtensionContext = getContext(this) as common.UIAbilityContext;
  const myModuleInstallRequest: moduleInstallManager.ModuleInstallRequest =
    myModuleInstallProvider.createModuleInstallRequest(context);
  myModuleInstallRequest.addModule('AModule');
  myModuleInstallRequest.addModule('BModule');
  moduleInstallManager.fetchModules(myModuleInstallRequest)
    .then((data: moduleInstallManager.ModuleInstallSessionState) => {
      hilog.info(0, 'TAG', 'Succeeded in fetching modules success data.' );
    })
} catch (error) {
  hilog.error(0, 'TAG', `fetching modules onError.code is ${error.code}, message is ${error.message}`);
}

moduleInstallManager.cancelTask

cancelTask(taskId: string): ReturnCode

取消下载任务接口。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  // taskId 是fetchModules返回结果ModuleInstallSessionState中的taskId字段
  const taskId: string = '********';
  const rtnCode: moduleInstallManager.ReturnCode = moduleInstallManager.cancelTask(taskId);
  hilog.info(0, 'TAG', "Succeeded in getting result:" + rtnCode);
} catch (error) {
  hilog.error(0, 'TAG', `cancelTask onError.code is ${error.code}, message is ${error.message}`);
}

moduleInstallManager.showCellularDataConfirmation

showCellularDataConfirmation(context: common.UIAbilityContext | common.ExtensionContext,taskId: string): ReturnCode

流量提醒弹窗接口。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import type { common } from '@kit.AbilityKit';

try {
  // taskId 是fetchModules返回结果ModuleInstallSessionState中的taskId字段
  const taskId: string = '********';
  const context = getContext(this) as common.UIAbilityContext;
  const rtnCode: moduleInstallManager.ReturnCode =
    moduleInstallManager.showCellularDataConfirmation(context, taskId);
  hilog.info(0, 'TAG', "Succeeded in getting result:" + rtnCode);
} catch (error) {
  hilog.error(0, 'TAG', `showCellularDataConfirmation onError.code is ${error.code}, message is ${error.message}`);
}

moduleInstallManager.on('moduleInstallStatus')

on(type: 'moduleInstallStatus', callback: Callback<ModuleInstallSessionState>, timeout: number): void

监听当前应用下载任务的进度，不支持多线程调用。加载模块时，通过回调函数通知调用者。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  const timeout = 30 * 60;
  moduleInstallManager.on('moduleInstallStatus', (data: moduleInstallManager.ModuleInstallSessionState) => {
    // 注册监听
    hilog.info(0, 'TAG', 'Succeeded in getting moduleInstallManager.on.' );
  }, timeout)
} catch (error) {
  hilog.error(0, 'TAG', `moduleInstallManager.on onError.code is ${error.code}, message is ${error.message}`);
}

moduleInstallManager.off('moduleInstallStatus')

off(type: 'moduleInstallStatus', callback?: Callback<ModuleInstallSessionState>): void

取消监听当前应用下载任务的进度，不支持多线程调用。

模型约束：此接口仅可在Stage模型下使用。

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

起始版本：4.1.0(11)

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { moduleInstallManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

try {
  moduleInstallManager.off('moduleInstallStatus', (data: moduleInstallManager.ModuleInstallSessionState) => {
    // 取消监听
    hilog.info(0, 'TAG', 'Succeeded in getting moduleInstallManager.off.' );
  })
} catch (error) {
  hilog.error(0, 'TAG', `moduleInstallManager.off onError.code is ${error.code}, message is ${error.message}`);
}