From 21c4531f7b471097121a24dabf5415695a279916 Mon Sep 17 00:00:00 2001 From: liangZ15 Date: Thu, 30 Jun 2022 20:14:31 +0800 Subject: [PATCH] Signed-off-by: liangZ15 --- .../reference/apis/js-apis-update.md | 72 ++++++++++++++++++- 1 file changed, 70 insertions(+), 2 deletions(-) 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 7854d1b1e7..9694ae2ed8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-update.md +++ b/zh-cn/application-dev/reference/apis/js-apis-update.md @@ -825,6 +825,65 @@ updater.terminateUpgrade().then(value => { }); ``` + +### on +on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void + +注册事件监听,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Update.UpdateService + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| eventClassifyInfo | EventClassifyInfo | 是 | 事件信息 | +| taskCallback | UpgradeTaskCallback | 是 | 事件回调 | + +**示例:** + +``` +var eventClassifyInfo = { + eventClassify: EventClassify.TASK // 订阅升级更新事件 + extraInfo: "" +} + +function onTaskUpdate(eventInfo): void { + console.log("on eventInfo id ", eventInfo.eventId); +} + +localUpdater.on(eventClassifyInfo, onTaskUpdate); +``` + +### off +off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void + +取消注册事件监听,使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Update.UpdateService + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| eventClassifyInfo | EventClassifyInfo | 是 | 事件信息 | +| taskCallback | UpgradeTaskCallback | 否 | 事件回调 | + +**示例:** + +``` +var eventClassifyInfo = { + eventClassify: EventClassify.TASK // 订阅升级更新事件 + extraInfo: "" +} + +function onTaskUpdate(eventInfo): void { + console.log("on eventInfo id ", eventInfo.eventId); +} + +localUpdater.off(eventClassifyInfo, onTaskUpdate); +``` + ## Restorer ### factoryReset @@ -1268,6 +1327,17 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate); | errorCode | number | 是 | 错误码 | | errorMessage | string | 是 | 错误描述 | +## EventClassifyInfo + +事件信息。 + +**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService + +| 名称 | 参数类型 | 必填 | 说明 | +| ------------------- | --------------------------- | ---- | ------- | +| eventClassify | EventClassify | 是 | 事件类型 | +| extraInfo | string | 是 | 额外信息 | + ## UpgradeFile 升级文件。 @@ -1370,8 +1440,6 @@ onTaskUpdate(eventInfo: [EventInfo](#eventInfo)): void | WIFI | 6 | WIFI | | CELLULAR_AND_WIFI | 7 | 数据网络和WIFI | -## UpgradeInfo - ## Order 升级指令。 -- GitLab