diff --git a/zh-cn/application-dev/reference/apis/js-apis-update.md b/zh-cn/application-dev/reference/apis/js-apis-update.md index e17db771480936f57e74f3203b06a5d578b4738f..39f4bbae6e22be12858d3e882f70aaecdef7185c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-update.md +++ b/zh-cn/application-dev/reference/apis/js-apis-update.md @@ -211,6 +211,88 @@ updater.getNewVersionInfo().then(info => { }); ``` +### getNewVersionDescription + +getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions, callback: AsyncCallback\>): void + +获取新版本描述文件。使用callback异步回调。 + +**系统能力**:SystemCapability.Update.UpdateService + +**需要权限**:ohos.permission.UPDATE_SYSTEM,该权限为系统权限 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| versionDigestInfo | [VersionDigestInfo](#versionDigestInfo) | 是 | 版本摘要信息 | +| descriptionOptions | [DescriptionOptions](#descriptionOptions) | 是 | 描述文件选项 | +| callback | AsyncCallback\>) | 是 | 回调函数,返回新版本描述文件 | + +**示例:** + +``` +// 版本摘要信息 +var versionDigestInfo = { + versionDigest: "versionDigest" // 检测结果中的版本摘要信息 +} + +// 描述文件选项 +var descriptionOptions = { + format: DescriptionFormat.STANDARD, // 标准格式 + language: "zh-cn" // 中文 +} + +updater.getNewVersionDescription(versionDigestInfo, descriptionOptions, (err, info) => { + console.log(`getNewVersionDescription info ${JSON.stringify(info)}`); + console.log(`getNewVersionDescription err ${JSON.stringify(err)}`); +}); +``` + +### getNewVersionDescription + +getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions): Promise\>; + +获取新版本描述文件。使用Promise异步回调。 + +**系统能力**:SystemCapability.Update.UpdateService + +**需要权限**:ohos.permission.UPDATE_SYSTEM,该权限为系统权限 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| versionDigestInfo | [VersionDigestInfo](#versionDigestInfo) | 是 | 版本摘要信息 | +| descriptionOptions | [DescriptionOptions](#descriptionOptions) | 是 | 描述文件选项 | + +**返回值:** + +| 类型 | 说明 | +| ---------------------------------------- | ---------------- | +| Promise\> | Promise对象,返回新版本描述文件 | + +**示例:** + +``` +// 版本摘要信息 +var versionDigestInfo = { + versionDigest: "versionDigest" // 检测结果中的版本摘要信息 +} + +// 描述文件选项 +var descriptionOptions = { + format: DescriptionFormat.STANDARD, // 标准格式 + language: "zh-cn" // 中文 +} + +updater.getNewVersionDescription(versionDigestInfo, descriptionOptions).then(info => { + console.log(`getNewVersionDescription promise info ${JSON.stringify(info)}`); +}).catch(err => { + console.log(`getNewVersionDescription promise error ${JSON.stringify(err)}`); +}); +``` + ### getCurrentVersionInfo getCurrentVersionInfo(callback: AsyncCallback\): void @@ -265,9 +347,79 @@ updater.getCurrentVersionInfo().then(info => { }); ``` +### getCurrentVersionDescription + +getCurrentVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions, callback: AsyncCallback\>): void + +获取当前版本描述文件。使用callback异步回调。 + +**系统能力**:SystemCapability.Update.UpdateService + +**需要权限**:ohos.permission.UPDATE_SYSTEM,该权限为系统权限 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| descriptionOptions | [DescriptionOptions](#descriptionOptions) | 是 | 描述文件选项 | +| callback | AsyncCallback\>) | 是 | 回调函数,返回当前版本描述文件 | + +**示例:** + +``` +// 描述文件选项 +var descriptionOptions = { + format: DescriptionFormat.STANDARD, // 标准格式 + language: "zh-cn" // 中文 +} + +updater.getCurrentVersionDescription(descriptionOptions, (err, info) => { + console.log(`getCurrentVersionDescription info ${JSON.stringify(info)}`); + console.log(`getCurrentVersionDescription err ${JSON.stringify(err)}`); +}); +``` + +### getCurrentVersionDescription + +getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: AsyncCallback\>): void; + +获取当前版本描述文件。使用Promise异步回调。 + +**系统能力**:SystemCapability.Update.UpdateService + +**需要权限**:ohos.permission.UPDATE_SYSTEM,该权限为系统权限 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| descriptionOptions | [DescriptionOptions](#descriptionOptions) | 是 | 描述文件选项 | + +**返回值:** + +| 类型 | 说明 | +| ---------------------------------------- | ---------------- | +| Promise\> | Promise对象,返回当前版本描述文件 | + +**示例:** + +``` +// 描述文件选项 +var descriptionOptions = { + format: DescriptionFormat.STANDARD, // 标准格式 + language: "zh-cn" // 中文 +} + +updater.getCurrentVersionDescription(descriptionOptions).then(info => { + console.log(`getCurrentVersionDescription promise info ${JSON.stringify(info)}`); +}).catch(err => { + console.log(`getCurrentVersionDescription promise error ${JSON.stringify(err)}`); +}); +``` + ### getTaskInfo -getTaskInfo(callback: AsyncCallback\): void +getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise>; 获取升级任务信息。使用callback异步回调。 @@ -1227,6 +1379,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); | 名称 | 参数类型 | 必填 | 说明 | | ------------------- | --------------------------- | ---- | ------- | +| componentId | number | 是 | 升级包标识 | | componentType | [ComponentType](#componentyype) | 是 | 组件类型 | | upgradeAction | [UpgradeAction](#upgradeaction) | 是 | 升级方式 | | displayVersion | string | 是 | 显示版本号 | @@ -1235,6 +1388,28 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); | effectiveMode | [EffectiveMode](#effectivemode) | 是 | 生效模式 | | descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 版本描述文件信息 | +## DescriptionOptions + +描述文件选项。 + +**系统能力**:SystemCapability.Update.UpdateService + +| 名称 | 参数类型 | 必填 | 说明 | +| ------------------- | --------------------------- | ---- | ------- | +| format | [DescriptionFormat](#descriptionFormat) | 是 | 描述文件格式 | +| language | string | 是 | 描述文件语言 | + +## ComponentDescription + +升级包描述文件。 + +**系统能力**:SystemCapability.Update.UpdateService + +| 名称 | 参数类型 | 必填 | 说明 | +| ------------------- | --------------------------- | ---- | ------- | +| componentId | string | 是 | 描述文件标识 | +| descriptionInfo | [DescriptionInfo](#descriptionInfo) | 是 | 描述文件信息 | + ## DescriptionInfo 版本描述文件信息。 @@ -1479,6 +1654,17 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); | CONTENT | 0 | 内容 | | URI | 1 | 链接 | +## DescriptionFormat + +描述文件格式。 + +**系统能力**:SystemCapability.Update.UpdateService + +| 参数名 | 默认值 | 说明 | +| ------------------- | ---- | -------- | +| STANDARD | 0 | 标准格式 | +| SIMPLIFIED | 1 | 简易格式 | + ## NetType 网络类型。