From 536d6b16e4bf7e929b07699749a02d44d784e79b Mon Sep 17 00:00:00 2001 From: zhongjianfei Date: Wed, 21 Dec 2022 14:06:13 +0800 Subject: [PATCH] fix docs bugs Signed-off-by: zhongjianfei Change-Id: Iceb781ed85f2b3c5dc1a1f7f63c0305f28c34450 --- .../js-apis-inner-ability-abilityResult.md | 2 +- .../reference/apis/js-apis-notification.md | 759 +++++++++--------- .../apis/js-apis-notificationManager.md | 2 +- 3 files changed, 382 insertions(+), 381 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md index 851a272546..e0472d5cc1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-abilityResult.md @@ -10,6 +10,6 @@ | 名称 | 可读 | 可写 | 类型 | 必填 | 说明 | | ----------- | -------- |-------- | -------------------- | ---- | ------------------------------------------------------------ | -| resultCode | 是 | 否 | number | 否 | 表示ability拉起、销毁之后返回的结果码。 | +| resultCode | 是 | 否 | number | 是 | 表示ability拉起、销毁之后返回的结果码。 | | want | 是 | 否 | [Want](./js-apis-app-ability-want.md) | 否 | 表示ability销毁之后返回的数据。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-notification.md b/zh-cn/application-dev/reference/apis/js-apis-notification.md index 6d53569527..0d772942b0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -2,11 +2,11 @@ 本模块提供通知管理的能力，包括发布、取消发布通知，创建、获取、移除通知通道，订阅、取消订阅通知，获取通知的使能状态、角标使能状态，获取通知的相关信息等。 -一般情况下，只有系统应用具有通知订阅和取消订阅的权限。 - > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> 通知订阅和取消订阅仅对系统应用开放。 ## 导入模块 @@ -26,13 +26,13 @@ publish(request: NotificationRequest, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | ------------------------------------------- | -| request | [NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | +| request | [NotificationRequest](#notificationrequest) | 是 | 用于设置要发布通知的内容和相关配置信息。 | +| callback | AsyncCallback\ | 是 | 发布通知的回调方法。 | **示例：** ```js -//publish回调 +// publish回调 function publishCallback(err) { if (err.code) { console.info("publish failed " + JSON.stringify(err)); @@ -40,7 +40,7 @@ function publishCallback(err) { console.info("publish success"); } } -//通知Request对象 +// 通知Request对象 var notificationRequest = { id: 1, content: { @@ -69,12 +69,12 @@ publish(request: NotificationRequest): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | ------------------------------------------- | -| request | [NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | +| request | [NotificationRequest](#notificationrequest) | 是 | 用于设置要发布通知的内容和相关配置信息。 | **示例：** ```js -//通知Request对象 +// 通知Request对象 var notificationRequest = { notificationId: 1, content: { @@ -87,7 +87,7 @@ var notificationRequest = { } } Notification.publish(notificationRequest).then(() => { - console.info("publish sucess"); + console.info("publish success"); }); ``` @@ -96,7 +96,7 @@ Notification.publish(notificationRequest).then(() => { publish(request: NotificationRequest, userId: number, callback: AsyncCallback\): void -发布通知（callback形式）。 +发布通知给指定的用户（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -108,14 +108,14 @@ publish(request: NotificationRequest, userId: number, callback: AsyncCallback\ | 是 | 被指定的回调方法。 | **示例：** ```js -//publish回调 +// publish回调 function publishCallback(err) { if (err.code) { console.info("publish failed " + JSON.stringify(err)); @@ -123,9 +123,9 @@ function publishCallback(err) { console.info("publish success"); } } -// 接收通知的用户ID +// 用户ID var userId = 1 -//通知Request对象 +// 通知Request对象 var notificationRequest = { id: 1, content: { @@ -144,7 +144,7 @@ Notification.publish(notificationRequest, userId, publishCallback); publish(request: NotificationRequest, userId: number): Promise\ -发布通知（Promise形式）。 +发布通知给指定的用户（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -156,8 +156,8 @@ publish(request: NotificationRequest, userId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------- | ---- | ------------------------------------------- | -| request | [NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | -| userId | number | 是 | 接收通知用户的Id。 | +| request | [NotificationRequest](#notificationrequest) | 是 | 用于设置要发布通知的内容和相关配置信息。 | +| userId | number | 是 | 用户ID。 | **示例：** @@ -177,7 +177,7 @@ var notificationRequest = { var userId = 1 Notification.publish(notificationRequest, userId).then(() => { - console.info("publish sucess"); + console.info("publish success"); }); ``` @@ -186,7 +186,7 @@ Notification.publish(notificationRequest, userId).then(() => { cancel(id: number, label: string, callback: AsyncCallback\): void -取消与指定id和label相匹配的已发布通知（callback形式）。 +通过通知ID和通知标签取消已发布的通知（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -201,7 +201,7 @@ cancel(id: number, label: string, callback: AsyncCallback\): void **示例：** ```js -//cancel回调 +// cancel回调 function cancelCallback(err) { if (err.code) { console.info("cancel failed " + JSON.stringify(err)); @@ -218,7 +218,7 @@ Notification.cancel(0, "label", cancelCallback) cancel(id: number, label?: string): Promise\ -取消与指定id相匹配的已发布通知，label可以指定也可以不指定（Promise形式）。 +取消与指定通知ID相匹配的已发布通知，label可以指定也可以不指定（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -233,7 +233,7 @@ cancel(id: number, label?: string): Promise\ ```js Notification.cancel(0).then(() => { - console.info("cancel sucess"); + console.info("cancel success"); }); ``` @@ -243,7 +243,7 @@ Notification.cancel(0).then(() => { cancel(id: number, callback: AsyncCallback\): void -取消与指定id相匹配的已发布通知（callback形式）。 +取消与指定通知ID相匹配的已发布通知（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -257,7 +257,7 @@ cancel(id: number, callback: AsyncCallback\): void **示例：** ```js -//cancel回调 +// cancel回调 function cancelCallback(err) { if (err.code) { console.info("cancel failed " + JSON.stringify(err)); @@ -287,7 +287,7 @@ cancelAll(callback: AsyncCallback\): void **示例：** ```js -//cancel回调 +// cancel回调 function cancelAllCallback(err) { if (err.code) { console.info("cancelAll failed " + JSON.stringify(err)); @@ -312,7 +312,7 @@ cancelAll(): Promise\ ```js Notification.cancelAll().then(() => { - console.info("cancelAll sucess"); + console.info("cancelAll success"); }); ``` @@ -340,7 +340,7 @@ addSlot(slot: NotificationSlot, callback: AsyncCallback\): void **示例：** ```js -//addslot回调 +// addslot回调 function addSlotCallBack(err) { if (err.code) { console.info("addSlot failed " + JSON.stringify(err)); @@ -348,7 +348,7 @@ function addSlotCallBack(err) { console.info("addSlot success"); } } -//通知slot对象 +// 通知slot对象 var notificationSlot = { type: Notification.SlotType.SOCIAL_COMMUNICATION } @@ -378,12 +378,12 @@ addSlot(slot: NotificationSlot): Promise\ **示例：** ```js -//通知slot对象 +// 通知slot对象 var notificationSlot = { type: Notification.SlotType.SOCIAL_COMMUNICATION } Notification.addSlot(notificationSlot).then(() => { - console.info("addSlot sucess"); + console.info("addSlot success"); }); ``` @@ -393,7 +393,7 @@ Notification.addSlot(notificationSlot).then(() => { addSlot(type: SlotType, callback: AsyncCallback\): void -创建通知通道（callback形式）。 +创建指定类型的通知通道（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -407,7 +407,7 @@ addSlot(type: SlotType, callback: AsyncCallback\): void **示例：** ```js -//addslot回调 +// addslot回调 function addSlotCallBack(err) { if (err.code) { console.info("addSlot failed " + JSON.stringify(err)); @@ -424,7 +424,7 @@ Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack addSlot(type: SlotType): Promise\ -创建通知通道（Promise形式）。 +创建指定类型的通知通道（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -438,7 +438,7 @@ addSlot(type: SlotType): Promise\ ```js Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => { - console.info("addSlot sucess"); + console.info("addSlot success"); }); ``` @@ -466,7 +466,7 @@ addSlots(slots: Array\, callback: AsyncCallback\): voi **示例：** ```js -//addSlots回调 +// addSlots回调 function addSlotsCallBack(err) { if (err.code) { console.info("addSlots failed " + JSON.stringify(err)); @@ -474,11 +474,11 @@ function addSlotsCallBack(err) { console.info("addSlots success"); } } -//通知slot对象 +// 通知slot对象 var notificationSlot = { type: Notification.SlotType.SOCIAL_COMMUNICATION } -//通知slot array 对象 +// 通知slot array 对象 var notificationSlotArray = new Array(); notificationSlotArray[0] = notificationSlot; @@ -508,16 +508,16 @@ addSlots(slots: Array\): Promise\ **示例：** ```js -//通知slot对象 +// 通知slot对象 var notificationSlot = { type: Notification.SlotType.SOCIAL_COMMUNICATION } -//通知slot array 对象 +// 通知slot array 对象 var notificationSlotArray = new Array(); notificationSlotArray[0] = notificationSlot; Notification.addSlots(notificationSlotArray).then(() => { - console.info("addSlots sucess"); + console.info("addSlots success"); }); ``` @@ -527,7 +527,7 @@ Notification.addSlots(notificationSlotArray).then(() => { getSlot(slotType: SlotType, callback: AsyncCallback\): void -获取一个通知通道（callback形式）。 +获取一个指定类型的通知通道（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -535,14 +535,14 @@ getSlot(slotType: SlotType, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | ----------------------------------------------------------- | -| slotType | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | +| slotType | [SlotType](#slottype) | 是 | 通知渠道类型，目前分为社交通信、服务提醒、内容咨询和其他类型。 | | callback | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是 | 表示被指定的回调方法。 | **示例：** ```js -//getSlot回调 -function getSlotCallback(err,data) { +// getSlot回调 +function getSlotCallback(err, data) { if (err.code) { console.info("getSlot failed " + JSON.stringify(err)); } else { @@ -559,7 +559,7 @@ Notification.getSlot(slotType, getSlotCallback) getSlot(slotType: SlotType): Promise\ -获取一个通知通道（Promise形式）。 +获取一个指定类型的通知通道（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -567,7 +567,7 @@ getSlot(slotType: SlotType): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | ---- | ----------------------------------------------------------- | -| slotType | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | +| slotType | [SlotType](#slottype) | 是 | 通知渠道类型，目前分为社交通信、服务提醒、内容咨询和其他类型。 | **返回值：** @@ -580,7 +580,7 @@ getSlot(slotType: SlotType): Promise\ ```js var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; Notification.getSlot(slotType).then((data) => { - console.info("getSlot sucess, data: " + JSON.stringify(data)); + console.info("getSlot success, data: " + JSON.stringify(data)); }); ``` @@ -598,13 +598,13 @@ getSlots(callback: AsyncCallback>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | -------------------- | -| callback | AsyncCallback\\> | 是 | 表示被指定的回调方法。 | +| callback | AsyncCallback\\> | 是 | 以callback形式返回获取此应用程序的所有通知通道的结果。 | **示例：** ```js -//getSlots回调 -function getSlotsCallback(err,data) { +// getSlots回调 +function getSlotsCallback(err, data) { if (err.code) { console.info("getSlots failed " + JSON.stringify(err)); } else { @@ -634,7 +634,7 @@ getSlots(): Promise\> ```js Notification.getSlots().then((data) => { - console.info("getSlots sucess, data: " + JSON.stringify(data)); + console.info("getSlots success, data: " + JSON.stringify(data)); }); ``` @@ -644,7 +644,7 @@ Notification.getSlots().then((data) => { removeSlot(slotType: SlotType, callback: AsyncCallback\): void -根据通知通道类型删除创建的通知通道（callback形式）。 +删除指定类型的通知通道（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -658,7 +658,7 @@ removeSlot(slotType: SlotType, callback: AsyncCallback\): void **示例：** ```js -//removeSlot回调 +// removeSlot回调 function removeSlotCallback(err) { if (err.code) { console.info("removeSlot failed " + JSON.stringify(err)); @@ -676,7 +676,7 @@ Notification.removeSlot(slotType,removeSlotCallback) removeSlot(slotType: SlotType): Promise\ -根据通知通道类型删除创建的通知通道（Promise形式）。 +删除指定类型的通知通道（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -691,7 +691,7 @@ removeSlot(slotType: SlotType): Promise\ ```js var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; Notification.removeSlot(slotType).then(() => { - console.info("removeSlot sucess"); + console.info("removeSlot success"); }); ``` @@ -738,7 +738,7 @@ removeAllSlots(): Promise\ ```js Notification.removeAllSlots().then(() => { - console.info("removeAllSlots sucess"); + console.info("removeAllSlots success"); }); ``` @@ -761,13 +761,13 @@ subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, c | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ---------------- | | subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | -| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是 | 订阅信息。 | +| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是 | 通知订阅信息。 | | callback | AsyncCallback\ | 是 | 订阅动作回调函数。 | **示例：** ```js -//subscribe回调 +// subscribe回调 function subscribeCallback(err) { if (err.code) { console.info("subscribe failed " + JSON.stringify(err)); @@ -782,7 +782,7 @@ var subscriber = { onConsume: onConsumeCallback } var info = { - bundleNames: ["bundleName1","bundleName2"] + bundleNames: ["bundleName1", "bundleName2"] } Notification.subscribe(subscriber, info, subscribeCallback); ``` @@ -793,7 +793,7 @@ Notification.subscribe(subscriber, info, subscribeCallback); subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\): void -订阅通知并指定订阅信息（callback形式）。 +订阅当前用户下所有应用的通知（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -846,7 +846,7 @@ subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------ | | subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | -| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否 | 订阅信息。 | +| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否 | 通知订阅信息。 | **示例：** @@ -858,7 +858,7 @@ var subscriber = { onConsume: onConsumeCallback }; Notification.subscribe(subscriber).then(() => { - console.info("subscribe sucess"); + console.info("subscribe success"); }); ``` @@ -893,11 +893,11 @@ function unsubscribeCallback(err) { console.info("unsubscribe success"); } } -function onCancelCallback(data) { +function onDisconnectCallback(data) { console.info("Cancel callback: " + JSON.stringify(data)); } var subscriber = { - onCancel: onCancelCallback + onDisconnect: onDisconnectCallback } Notification.unsubscribe(subscriber, unsubscribeCallback); ``` @@ -925,14 +925,14 @@ unsubscribe(subscriber: NotificationSubscriber): Promise\ **示例：** ```js -function onCancelCallback(data) { +function onDisconnectCallback(data) { console.info("Cancel callback: " + JSON.stringify(data)); } var subscriber = { - onCancel: onCancelCallback + onDisconnect: onDisconnectCallback }; Notification.unsubscribe(subscriber).then(() => { - console.info("unsubscribe sucess"); + console.info("unsubscribe success"); }); ``` @@ -942,7 +942,7 @@ Notification.unsubscribe(subscriber).then(() => { enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\): void -设定指定包的通知使能状态（Callback形式）。 +设定指定应用的通知使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -954,7 +954,7 @@ enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallbac | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | -------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | enable | boolean | 是 | 使能状态。 | | callback | AsyncCallback\ | 是 | 设定通知使能回调函数。 | @@ -980,7 +980,7 @@ Notification.enableNotification(bundle, false, enableNotificationCallback); enableNotification(bundle: BundleOption, enable: boolean): Promise\ -设定指定包的通知使能状态（Promise形式）。 +设定指定应用的通知使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -992,7 +992,7 @@ enableNotification(bundle: BundleOption, enable: boolean): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | enable | boolean | 是 | 使能状态。 | **示例：** @@ -1002,7 +1002,7 @@ var bundle = { bundle: "bundleName1", } Notification.enableNotification(bundle, false).then(() => { - console.info("enableNotification sucess"); + console.info("enableNotification success"); }); ``` @@ -1012,7 +1012,7 @@ Notification.enableNotification(bundle, false).then(() => { isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\): void -获取指定包的通知使能状态（Callback形式）。 +获取指定应用的通知使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1024,7 +1024,7 @@ isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ------------------------ | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | callback | AsyncCallback\ | 是 | 获取通知使能状态回调函数。 | **示例：** @@ -1049,7 +1049,7 @@ Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback); isNotificationEnabled(bundle: BundleOption): Promise\ -获取指定包的通知使能状态（Promise形式）。 +获取指定应用的通知使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1061,13 +1061,13 @@ isNotificationEnabled(bundle: BundleOption): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取指定包的通知使能状态的结果。 | +| 类型 | 说明 | +| ------------------ | --------------------------------------------------- | +| Promise\ | 以Promise形式返回获取指定应用的通知使能状态的结果。 | **示例：** @@ -1076,7 +1076,7 @@ var bundle = { bundle: "bundleName1", } Notification.isNotificationEnabled(bundle).then((data) => { - console.info("isNotificationEnabled sucess, data: " + JSON.stringify(data)); + console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1132,7 +1132,7 @@ isNotificationEnabled(): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | **返回值：** @@ -1144,7 +1144,7 @@ isNotificationEnabled(): Promise\ ```js Notification.isNotificationEnabled().then((data) => { - console.info("isNotificationEnabled sucess, data: " + JSON.stringify(data)); + console.info("isNotificationEnabled success, data: " + JSON.stringify(data)); }); ``` @@ -1154,7 +1154,7 @@ Notification.isNotificationEnabled().then((data) => { displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\): void -设定指定包的角标使能状态（Callback形式）。 +设定指定应用的角标使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1166,7 +1166,7 @@ displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\ | 是 | 设定角标使能回调函数。 | @@ -1192,7 +1192,7 @@ Notification.displayBadge(bundle, false, displayBadgeCallback); displayBadge(bundle: BundleOption, enable: boolean): Promise\ -设定指定包的角标使能状态（Promise形式）。 +设定指定应用的角标使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1204,7 +1204,7 @@ displayBadge(bundle: BundleOption, enable: boolean): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | enable | boolean | 是 | 使能状态。 | **示例：** @@ -1214,7 +1214,7 @@ var bundle = { bundle: "bundleName1", } Notification.displayBadge(bundle, false).then(() => { - console.info("displayBadge sucess"); + console.info("displayBadge success"); }); ``` @@ -1224,7 +1224,7 @@ Notification.displayBadge(bundle, false).then(() => { isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\): void -获取指定包的角标使能状态（Callback形式）。 +获取指定应用的角标使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1236,7 +1236,7 @@ isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ------------------------ | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | callback | AsyncCallback\ | 是 | 获取角标使能状态回调函数。 | **示例：** @@ -1261,7 +1261,7 @@ Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); isBadgeDisplayed(bundle: BundleOption): Promise\ -获取指定包的角标使能状态（Promise形式）。 +获取指定应用的角标使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1273,13 +1273,13 @@ isBadgeDisplayed(bundle: BundleOption): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | **返回值：** | 类型 | 说明 | | ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取指定包的角标使能状态。 | +| Promise\ | 以Promise形式返回获取指定应用的角标使能状态。 | **示例：** @@ -1288,7 +1288,7 @@ var bundle = { bundle: "bundleName1", } Notification.isBadgeDisplayed(bundle).then((data) => { - console.info("isBadgeDisplayed sucess, data: " + JSON.stringify(data)); + console.info("isBadgeDisplayed success, data: " + JSON.stringify(data)); }); ``` @@ -1298,7 +1298,7 @@ Notification.isBadgeDisplayed(bundle).then((data) => { setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\): void -设定指定包的通知通道状态（Callback形式）。 +设定指定应用的通知通道（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1310,7 +1310,7 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCal | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | -------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | slot | [NotificationSlot](#notificationslot) | 是 | 通知通道。 | | callback | AsyncCallback\ | 是 | 设定通知通道回调函数。 | @@ -1339,7 +1339,7 @@ Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\ -设定指定包的通知通道状态（Promise形式）。 +设定指定应用的通知通道（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1351,8 +1351,8 @@ setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| slot | [NotificationSlot](#notificationslot) | 是 | 使能状态。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | +| slot | [NotificationSlot](#notificationslot) | 是 | 通知通道。 | **示例：** @@ -1364,7 +1364,7 @@ var notificationSlot = { type: Notification.SlotType.SOCIAL_COMMUNICATION } Notification.setSlotByBundle(bundle, notificationSlot).then(() => { - console.info("setSlotByBundle sucess"); + console.info("setSlotByBundle success"); }); ``` @@ -1374,7 +1374,7 @@ Notification.setSlotByBundle(bundle, notificationSlot).then(() => { getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback>): void -获取指定包的通知通道（Callback形式）。 +获取指定应用的所有通知通道（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1386,7 +1386,7 @@ getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback> | 是 | 获取通知通道回调函数。 | **示例：** @@ -1411,7 +1411,7 @@ Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback); getSlotsByBundle(bundle: BundleOption): Promise> -获取指定包的通知通道（Promise形式）。 +获取指定应用的所有通知通道（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1423,13 +1423,13 @@ getSlotsByBundle(bundle: BundleOption): Promise> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | **返回值：** | 类型 | 说明 | | ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise> | 以Promise形式返回获取指定包的通知通道。 | +| Promise> | 以Promise形式返回获取指定应用的通知通道。 | **示例：** @@ -1438,7 +1438,7 @@ var bundle = { bundle: "bundleName1", } Notification.getSlotsByBundle(bundle).then((data) => { - console.info("getSlotsByBundle sucess, data: " + JSON.stringify(data)); + console.info("getSlotsByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1448,7 +1448,7 @@ Notification.getSlotsByBundle(bundle).then((data) => { getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\): void -获取指定包的通知通道数（Callback形式）。 +获取指定应用的通知通道数量（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1460,8 +1460,8 @@ getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| callback | AsyncCallback\ | 是 | 获取通知通道数回调函数。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | +| callback | AsyncCallback\ | 是 | 获取通知通道数量回调函数。 | **示例：** @@ -1485,7 +1485,7 @@ Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); getSlotNumByBundle(bundle: BundleOption): Promise\ -获取指定包的通知通道数（Promise形式）。 +获取指定应用的通知通道数量（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1497,13 +1497,13 @@ getSlotNumByBundle(bundle: BundleOption): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | **返回值：** | 类型 | 说明 | | ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取指定包的通知通道数。 | +| Promise\ | 以Promise形式返回获取指定应用的通知通道数量。 | **示例：** @@ -1512,7 +1512,7 @@ var bundle = { bundle: "bundleName1", } Notification.getSlotNumByBundle(bundle).then((data) => { - console.info("getSlotNumByBundle sucess, data: " + JSON.stringify(data)); + console.info("getSlotNumByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -1534,7 +1534,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | 参数名 | 类型 | 必填 | 说明 | | --------------- | ----------------------------------| ---- | -------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | @@ -1578,7 +1578,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | 参数名 | 类型 | 必填 | 说明 | | --------------- | --------------- | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | @@ -1594,7 +1594,7 @@ var notificationKey = { } var reason = Notification.RemoveReason.CLICK_REASON_REMOVE; Notification.remove(bundle, notificationKey, reason).then(() => { - console.info("remove sucess"); + console.info("remove success"); }); ``` @@ -1616,7 +1616,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | -------------------- | -| hashCode | string | 是 | 通知唯一ID。 | +| hashCode | string | 是 | 通知唯一ID。可以通过[onConsume](#onconsume)回调的入参[SubscribeCallbackData](#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 | | reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | @@ -1663,7 +1663,7 @@ remove(hashCode: string, reason: RemoveReason): Promise\ var hashCode = 'hashCode' var reason = Notification.RemoveReason.CLICK_REASON_REMOVE; Notification.remove(hashCode, reason).then(() => { - console.info("remove sucess"); + console.info("remove success"); }); ``` @@ -1673,7 +1673,7 @@ Notification.remove(hashCode, reason).then(() => { removeAll(bundle: BundleOption, callback: AsyncCallback\): void -删除指定包的所有通知（Callback形式）。 +删除指定应用的所有通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1685,8 +1685,8 @@ removeAll(bundle: BundleOption, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ---------------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| callback | AsyncCallback\ | 是 | 删除指定包的所有通知回调函数。 | +| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | +| callback | AsyncCallback\ | 是 | 删除指定应用的所有通知回调函数。 | **示例：** @@ -1744,7 +1744,7 @@ Notification.removeAll(removeAllCallback); removeAll(bundle?: BundleOption): Promise\ -删除所有通知（Promise形式）。 +删除指定应用的所有通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1756,13 +1756,14 @@ removeAll(bundle?: BundleOption): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 否 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 否 | 指定应用的包信息。 | **示例：** ```js +// 不指定应用时，删除所有通知 Notification.removeAll().then(() => { - console.info("removeAll sucess"); + console.info("removeAll success"); }); ``` @@ -1770,7 +1771,7 @@ Notification.removeAll().then(() => { removeAll(userId: number, callback: AsyncCallback\): void -删除所有通知（callback形式）。 +删除指定用户下的所有通知（callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1782,8 +1783,8 @@ removeAll(userId: number, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| userId | number | 是 | 接收通知用户的Id。 | -| callback | AsyncCallback\ | 是 | 删除所有通知回调函数。 | +| userId | number | 是 | 用户ID。 | +| callback | AsyncCallback\ | 是 | 删除指定用户所有通知回调函数。 | **示例：** @@ -1797,7 +1798,6 @@ function removeAllCallback(err) { } var userId = 1 - Notification.removeAll(userId, removeAllCallback); ``` @@ -1805,7 +1805,7 @@ Notification.removeAll(userId, removeAllCallback); removeAll(userId: number): Promise\ -删除所有通知（Promise形式）。 +删除指定用户下的所有通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1817,22 +1817,15 @@ removeAll(userId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| userId | number | 是 | 接收通知用户的Id。 | +| userId | number | 是 | 用户ID。 | **示例：** ```js -function removeAllCallback(err) { - if (err.code) { - console.info("removeAll failed " + JSON.stringify(err)); - } else { - console.info("removeAll success"); - } -} - var userId = 1 - -Notification.removeAll(userId, removeAllCallback); +Notification.removeAll(userId).then(() => { + console.info("removeAll success"); +}); ``` @@ -1840,7 +1833,7 @@ Notification.removeAll(userId, removeAllCallback); getAllActiveNotifications(callback: AsyncCallback>): void -获取活动通知（Callback形式）。 +获取当前未删除的所有通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1874,7 +1867,7 @@ Notification.getAllActiveNotifications(getAllActiveNotificationsCallback); getAllActiveNotifications(): Promise\\> -获取活动通知（Promise形式）。 +获取当前未删除的所有通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1892,7 +1885,7 @@ getAllActiveNotifications(): Promise\ { - console.info("getAllActiveNotifications sucess, data: " + JSON.stringify(data)); + console.info("getAllActiveNotifications success, data: " + JSON.stringify(data)); }); ``` @@ -1902,7 +1895,7 @@ Notification.getAllActiveNotifications().then((data) => { getActiveNotificationCount(callback: AsyncCallback\): void -获取当前应用的活动通知数（Callback形式）。 +获取当前应用未删除的通知数（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1910,7 +1903,7 @@ getActiveNotificationCount(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------- | -| callback | AsyncCallback\ | 是 | 获取活动通知数回调函数。 | +| callback | AsyncCallback\ | 是 | 获取未删除通知数回调函数。 | **示例：** @@ -1932,21 +1925,21 @@ Notification.getActiveNotificationCount(getActiveNotificationCountCallback); getActiveNotificationCount(): Promise\ -获取当前应用的活动通知数（Promise形式）。 +获取当前应用未删除的通知数（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取当前应用的活动通知数。 | +| 类型 | 说明 | +| ----------------- | ------------------------------------------- | +| Promise\ | 以Promise形式返回获取当前应用未删除通知数。 | **示例：** ```js Notification.getActiveNotificationCount().then((data) => { - console.info("getActiveNotificationCount sucess, data: " + JSON.stringify(data)); + console.info("getActiveNotificationCount success, data: " + JSON.stringify(data)); }); ``` @@ -1956,7 +1949,7 @@ Notification.getActiveNotificationCount().then((data) => { getActiveNotifications(callback: AsyncCallback>): void -获取当前应用的活动通知（Callback形式）。 +获取当前应用未删除的通知列表（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -1964,7 +1957,7 @@ getActiveNotifications(callback: AsyncCallback>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------ | -| callback | AsyncCallback> | 是 | 获取当前应用的活动通知回调函数。 | +| callback | AsyncCallback> | 是 | 获取当前应用通知列表回调函数。 | **示例：** @@ -1986,21 +1979,21 @@ Notification.getActiveNotifications(getActiveNotificationsCallback); getActiveNotifications(): Promise\\> -获取当前应用的活动通知（Promise形式）。 +获取当前应用未删除的通知列表（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\\> | 以Promise形式返回获取当前应用的活动通知。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | --------------------------------------- | +| Promise\\> | 以Promise形式返回获取当前应用通知列表。 | **示例：** ```js Notification.getActiveNotifications().then((data) => { - console.info("removeGroupByBundle sucess, data: " + JSON.stringify(data)); + console.info("removeGroupByBundle success, data: " + JSON.stringify(data)); }); ``` @@ -2010,7 +2003,7 @@ Notification.getActiveNotifications().then((data) => { cancelGroup(groupName: string, callback: AsyncCallback\): void -取消本应用指定组通知（Callback形式）。 +取消本应用指定组下的通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2018,8 +2011,8 @@ cancelGroup(groupName: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | --------- | --------------------- | ---- | ---------------------------- | -| groupName | string | 是 | 指定通知组名称。 | -| callback | AsyncCallback\ | 是 | 取消本应用指定组通知回调函数。 | +| groupName | string | 是 | 通知组名称，此名称需要在发布通知时通过[NotificationRequest](#notificationrequest)对象指定。 | +| callback | AsyncCallback\ | 是 | 取消本应用指定组下通知的回调函数。 | **示例：** @@ -2043,7 +2036,7 @@ Notification.cancelGroup(groupName, cancelGroupCallback); cancelGroup(groupName: string): Promise\ -取消本应用指定组通知（Promise形式）。 +取消本应用指定组下的通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2051,14 +2044,14 @@ cancelGroup(groupName: string): Promise\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | -------------- | -| groupName | string | 是 | 指定通知组名称。 | +| groupName | string | 是 | 通知组名称。 | **示例：** ```js var groupName = "GroupName"; Notification.cancelGroup(groupName).then(() => { - console.info("cancelGroup sucess"); + console.info("cancelGroup success"); }); ``` @@ -2068,7 +2061,7 @@ Notification.cancelGroup(groupName).then(() => { removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\): void -删除指定应用指定组通知（Callback形式）。 +删除指定应用的指定组下的通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2080,9 +2073,9 @@ removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | --------- | --------------------- | ---- | ---------------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| groupName | string | 是 | 指定通知组名称。 | -| callback | AsyncCallback\ | 是 | 删除本应用指定组通知回调函数。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | +| groupName | string | 是 | 通知组名称。 | +| callback | AsyncCallback\ | 是 | 删除指定应用指定组下通知的回调函数。 | **示例：** @@ -2107,7 +2100,7 @@ Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCal removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\ -删除指定应用指定组通知（Promise形式）。 +删除指定应用的指定组下的通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2119,8 +2112,8 @@ removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------ | ---- | -------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| groupName | string | 是 | 指定通知组名称。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | +| groupName | string | 是 | 通知组名称。 | **示例：** @@ -2128,7 +2121,7 @@ removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\ var bundleOption = {bundle: "Bundle"}; var groupName = "GroupName"; Notification.removeGroupByBundle(bundleOption, groupName).then(() => { - console.info("removeGroupByBundle sucess"); + console.info("removeGroupByBundle success"); }); ``` @@ -2179,7 +2172,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); setDoNotDisturbDate(date: DoNotDisturbDate): Promise\ -设置免打扰时间接口（Promise形式）。 +设置免打扰时间（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2202,7 +2195,7 @@ var doNotDisturbDate = { end: new Date(2021, 11, 15, 18, 0) } Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => { - console.info("setDoNotDisturbDate sucess"); + console.info("setDoNotDisturbDate success"); }); ``` @@ -2224,7 +2217,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallb | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ---------------------- | | date | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | -| userId | number | 是 | 设置免打扰事件的用户ID。 | +| userId | number | 是 | 设置免打扰时间的用户ID。 | | callback | AsyncCallback\ | 是 | 设置免打扰时间回调函数。 | **示例：** @@ -2245,7 +2238,6 @@ var doNotDisturbDate = { } var userId = 1 - Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback); ``` @@ -2255,7 +2247,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCa setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\ -指定用户设置免打扰时间接口（Promise形式）。 +指定用户设置免打扰时间（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2268,7 +2260,7 @@ setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ---------------- | ---- | -------------- | | date | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | -| userId | number | 是 | 设置免打扰事件的用户ID。 | +| userId | number | 是 | 设置免打扰时间的用户ID。 | **示例：** @@ -2282,7 +2274,7 @@ var doNotDisturbDate = { var userId = 1 Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => { - console.info("setDoNotDisturbDate sucess"); + console.info("setDoNotDisturbDate success"); }); ``` @@ -2291,7 +2283,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => { getDoNotDisturbDate(callback: AsyncCallback\): void -查询免打扰时间接口（Callback形式）。 +查询免打扰时间（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2308,7 +2300,7 @@ getDoNotDisturbDate(callback: AsyncCallback\): void **示例：** ```js -function getDoNotDisturbDateCallback(err,data) { +function getDoNotDisturbDateCallback(err, data) { if (err.code) { console.info("getDoNotDisturbDate failed " + JSON.stringify(err)); } else { @@ -2325,7 +2317,7 @@ Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback); getDoNotDisturbDate(): Promise\ -查询免打扰时间接口（Promise形式）。 +查询免打扰时间（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2335,15 +2327,15 @@ getDoNotDisturbDate(): Promise\ **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 | +| 类型 | 说明 | +| ------------------------------------------------- | ----------------------------------------- | +| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询到的免打扰时间。 | **示例：** ```js Notification.getDoNotDisturbDate().then((data) => { - console.info("getDoNotDisturbDate sucess, data: " + JSON.stringify(data)); + console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2352,7 +2344,7 @@ Notification.getDoNotDisturbDate().then((data) => { getDoNotDisturbDate(userId: number, callback: AsyncCallback\): void -指定用户查询免打扰时间接口（Callback形式）。 +查询指定用户的免打扰时间（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2365,7 +2357,7 @@ getDoNotDisturbDate(userId: number, callback: AsyncCallback\) | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | ---------------------- | | callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是 | 查询免打扰时间回调函数。 | -| userId | number | 是 | 设置免打扰事件的用户ID。 | +| userId | number | 是 | 用户ID。 | **示例：** @@ -2389,7 +2381,7 @@ Notification.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback); getDoNotDisturbDate(userId: number): Promise\ -指定用户查询免打扰时间接口（Promise形式）。 +查询指定用户的免打扰时间（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2401,13 +2393,13 @@ getDoNotDisturbDate(userId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | ---------------------- | -| userId | number | 是 | 设置免打扰事件的用户ID。 | +| userId | number | 是 | 用户ID。 | **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 | +| 类型 | 说明 | +| ------------------------------------------------- | ----------------------------------------- | +| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询到的免打扰时间。 | **示例：** @@ -2415,7 +2407,7 @@ getDoNotDisturbDate(userId: number): Promise\ var userId = 1 Notification.getDoNotDisturbDate(userId).then((data) => { - console.info("getDoNotDisturbDate sucess, data: " + JSON.stringify(data)); + console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data)); }); ``` @@ -2424,7 +2416,7 @@ Notification.getDoNotDisturbDate(userId).then((data) => { supportDoNotDisturbMode(callback: AsyncCallback\): void -查询是否支持勿扰模式功能（Callback形式）。 +查询是否支持免打扰功能（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2436,7 +2428,7 @@ supportDoNotDisturbMode(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | -------------------------------- | -| callback | AsyncCallback\ | 是 | 查询是否支持勿扰模式功能回调函数。 | +| callback | AsyncCallback\ | 是 | 查询是否支持免打扰功能回调函数。 | **示例：** @@ -2458,7 +2450,7 @@ Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback); supportDoNotDisturbMode(): Promise\ -查询是否支持勿扰模式功能（Promise形式）。 +查询是否支持免打扰功能（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2470,13 +2462,13 @@ supportDoNotDisturbMode(): Promise\ | 类型 | 说明 | | ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取是否支持勿扰模式功能的结果。 | +| Promise\ | 以Promise形式返回获取是否支持免打扰功能的结果。 | **示例：** ```js Notification.supportDoNotDisturbMode().then((data) => { - console.info("supportDoNotDisturbMode sucess, data: " + JSON.stringify(data)); + console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data)); }); ``` @@ -2567,7 +2559,7 @@ function requestEnableNotificationCallback(err) { if (err.code) { console.info("requestEnableNotification failed " + JSON.stringify(err)); } else { - + console.info("requestEnableNotification success"); } }; @@ -2587,10 +2579,9 @@ requestEnableNotification(): Promise\ **示例：** ```javascript -Notification.requestEnableNotification() - .then(() => { - console.info("requestEnableNotification sucess"); - }); +Notification.requestEnableNotification().then(() => { + console.info("requestEnableNotification success"); +}); ``` @@ -2610,7 +2601,7 @@ enableDistributed(enable: boolean, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | -------------------------- | -| enable | boolean | 是 | 是否支持。
true 支持。
false 不支持。| +| enable | boolean | 是 | 是否支持。 | | callback | AsyncCallback\ | 是 | 设置设备是否支持分布式通知的回调函数。 | **示例：** @@ -2647,17 +2638,15 @@ enableDistributed(enable: boolean): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | -------------------------- | -| enable | boolean | 是 | 是否支持。
true 支持。
false 不支持。| +| enable | boolean | 是 | 是否支持。 | **示例：** ```javascript var enable = true - -Notification.enableDistributed(enable) - .then(() => { - console.info("enableDistributed sucess"); - }); +Notification.enableDistributed(enable).then(() => { + console.info("enableDistributed success"); +}); ``` @@ -2665,7 +2654,7 @@ Notification.enableDistributed(enable) isDistributedEnabled(callback: AsyncCallback\): void -获取设备是否支持分布式通知（Callback形式）。 +查询设备是否支持分布式通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2695,23 +2684,22 @@ Notification.isDistributedEnabled(isDistributedEnabledCallback); isDistributedEnabled(): Promise\ -获取设备是否支持分布式通知（Promise形式）。 +查询设备是否支持分布式通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification **返回值：** -| 类型 | 说明 | -| ------------------ | --------------- | -| Promise\ | Promise方式返回设备是否支持分布式通知的结果。
true 支持。
false 不支持。 | +| 类型 | 说明 | +| ------------------ | --------------------------------------------- | +| Promise\ | Promise方式返回设备是否支持分布式通知的结果。 | **示例：** ```javascript -Notification.isDistributedEnabled() - .then((data) => { - console.info("isDistributedEnabled sucess, data: " + JSON.stringify(data)); - }); +Notification.isDistributedEnabled().then((data) => { + console.info("isDistributedEnabled success, data: " + JSON.stringify(data)); +}); ``` @@ -2719,7 +2707,7 @@ Notification.isDistributedEnabled() enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback\): void -根据应用的包设置应用程序是否支持分布式通知（Callback形式）。 +设置指定应用是否支持分布式通知（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2731,7 +2719,7 @@ enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: Async | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | -------------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 应用的包。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | | enable | boolean | 是 | 是否支持。 | | callback | AsyncCallback\ | 是 | 应用程序是否支持分布式通知的回调函数。 | @@ -2761,7 +2749,7 @@ Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundle enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\ -根据应用的包设置应用程序是否支持分布式通知（Promise形式）。 +设置指定应用是否支持分布式通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2784,11 +2772,9 @@ var bundle = { } var enable = true - -Notification.enableDistributedByBundle(bundle, enable) - .then(() => { - console.info("enableDistributedByBundle sucess"); - }); +Notification.enableDistributedByBundle(bundle, enable).then(() => { + console.info("enableDistributedByBundle success"); +}); ``` ## Notification.isDistributedEnabledByBundle8+ @@ -2808,7 +2794,7 @@ isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\ | 是 | 应用程序是否支持分布式通知的回调函数。 | +| callback | AsyncCallback\ | 是 | 查询指定应用是否支持分布式通知的回调函数。 | **示例：** @@ -2834,7 +2820,7 @@ Notification.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCa isDistributedEnabledByBundle(bundle: BundleOption): Promise\ -根据应用的包获取应用程序是否支持分布式通知（Promise形式）。 +查询指定应用是否支持分布式通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -2850,9 +2836,9 @@ isDistributedEnabledByBundle(bundle: BundleOption): Promise\ **返回值：** -| 类型 | 说明 | -| ------------------ | --------------- | -| Promise\ | Promise方式返回应用程序是否支持分布式通知的结果。
true 支持。
false 不支持。 | +| 类型 | 说明 | +| ------------------ | ------------------------------------------------- | +| Promise\ | Promise方式返回指定应用是否支持分布式通知的结果。 | **示例：** @@ -2861,10 +2847,9 @@ var bundle = { bundle: "bundleName1", } -Notification.isDistributedEnabledByBundle(bundle) - .then((data) => { - console.info("isDistributedEnabledByBundle sucess, data: " + JSON.stringify(data)); - }); +Notification.isDistributedEnabledByBundle(bundle).then((data) => { + console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data)); +}); ``` @@ -2884,7 +2869,7 @@ getDeviceRemindType(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | -------------------------- | -| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype8)\> | 是 | 获取通知的提醒方式的回调函数。 | +| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype8)\> | 是 | 获取通知提醒方式的回调函数。 | **示例：** @@ -2918,15 +2903,14 @@ getDeviceRemindType(): Promise\ | 类型 | 说明 | | ------------------ | --------------- | -| Promise\<[DeviceRemindType](#deviceremindtype8)\> | Promise方式返回通知的提醒方式的结果。 | +| Promise\<[DeviceRemindType](#deviceremindtype8)\> | Promise方式返回获取通知提醒方式的结果。 | **示例：** ```javascript -Notification.getDeviceRemindType() - .then((data) => { - console.info("getDeviceRemindType sucess, data: " + JSON.stringify(data)); - }); +Notification.getDeviceRemindType().then((data) => { + console.info("getDeviceRemindType success, data: " + JSON.stringify(data)); +}); ``` @@ -2944,18 +2928,18 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- | -| request | [NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | -| representativeBundle | string | 是 | 被代理应用的包名。 | -| userId | number | 是 | 接收通知用户的Id。 | -| callback | AsyncCallback | 是 | 发布代理通知的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------------- | ------------------------------------------- | ---- | ---------------------------------------- | +| request | [NotificationRequest](#notificationrequest) | 是 | 用于设置要发布通知的内容和相关配置信息。 | +| representativeBundle | string | 是 | 被代理应用的包名。 | +| userId | number | 是 | 用户ID。 | +| callback | AsyncCallback | 是 | 发布代理通知的回调方法。 | **示例：** ```js -//publishAsBundle回调 -function publishAsBundleCallback(err) { +// publishAsBundle回调 +function callback(err) { if (err.code) { console.info("publishAsBundle failed " + JSON.stringify(err)); } else { @@ -2964,10 +2948,10 @@ function publishAsBundleCallback(err) { } // 被代理应用的包名 let representativeBundle = "com.example.demo" -// 接收通知的用户ID +// 用户ID let userId = 100 -//通知Request对象 -let notificationRequest = { +// NotificationRequest对象 +let request = { id: 1, content: { contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -2979,7 +2963,7 @@ let notificationRequest = { } } -Notification.publishAsBundle(notificationRequest, representativeBundle, userId, publishAsBundleCallback); +Notification.publishAsBundle(request, representativeBundle, userId, callback); ``` ## Notification.publishAsBundle9+ @@ -2999,19 +2983,19 @@ publishAsBundle(request: NotificationRequest, representativeBundle: string, user | 参数名 | 类型 | 必填 | 说明 | | -------------------- | ------------------------------------------- | ---- | --------------------------------------------- | -| request | [NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | +| request | [NotificationRequest](#notificationrequest) | 是 | 用于设置要发布通知的内容和相关配置信息。 | | representativeBundle | string | 是 | 被代理应用的包名。 | -| userId | number | 是 | 接收通知用户的Id。 | +| userId | number | 是 | 用户ID。 | **示例：** ```js // 被代理应用的包名 let representativeBundle = "com.example.demo" -// 接收通知的用户ID +// 用户ID let userId = 100 -//通知Request对象 -var notificationRequest = { +// NotificationRequest对象 +var request = { id: 1, content: { contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, @@ -3023,8 +3007,8 @@ var notificationRequest = { } } -Notification.publishAsBundle(notificationRequest, representativeBundle, userId).then(() => { - console.info("publishAsBundle sucess"); +Notification.publishAsBundle(request, representativeBundle, userId).then(() => { + console.info("publishAsBundle success"); }); ``` @@ -3048,13 +3032,13 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number, callbac | -------------------- | ------------- | ---- | ------------------------ | | id | number | 是 | 通知ID。 | | representativeBundle | string | 是 | 被代理应用的包名。 | -| userId | number | 是 | 接收通知用户的Id。 | +| userId | number | 是 | 用户ID。 | | callback | AsyncCallback | 是 | 取消代理通知的回调方法。 | **示例：** ```js -//cancelAsBundle +// cancelAsBundle function cancelAsBundleCallback(err) { if (err.code) { console.info("cancelAsBundle failed " + JSON.stringify(err)); @@ -3064,7 +3048,7 @@ function cancelAsBundleCallback(err) { } // 被代理应用的包名 let representativeBundle = "com.example.demo" -// 接收通知的用户ID +// 用户ID let userId = 100 Notification.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback); @@ -3074,7 +3058,7 @@ Notification.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallb cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise\ -发布代理通知（Promise形式）。 +代理通知（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -3090,14 +3074,14 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number): Promis | -------------------- | ------ | ---- | ------------------ | | id | number | 是 | 通知ID。 | | representativeBundle | string | 是 | 被代理应用的包名。 | -| userId | number | 是 | 接收通知用户的Id。 | +| userId | number | 是 | 用户ID。 | **示例：** ```js // 被代理应用的包名 let representativeBundle = "com.example.demo" -// 接收通知的用户ID +// 用户ID let userId = 100 Notification.cancelAsBundle(0, representativeBundle, userId).then(() => { @@ -3109,7 +3093,7 @@ Notification.cancelAsBundle(0, representativeBundle, userId).then(() => { enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback\): void -设定指定类型的渠道使能状态（Callback形式）。 +设置指定应用的指定渠道类型的使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -3121,15 +3105,15 @@ enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, ca | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | ---------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | | type | [SlotType](#slottype) | 是 | 指定渠道类型。 | | enable | boolean | 是 | 使能状态。 | -| callback | AsyncCallback\ | 是 | 设定渠道使能回调函数。 | +| callback | AsyncCallback\ | 是 | 设置渠道使能回调函数。 | **示例：** ```js -//enableNotificationSlot +// enableNotificationSlot function enableSlotCallback(err) { if (err.code) { console.info("enableNotificationSlot failed " + JSON.stringify(err)); @@ -3149,7 +3133,7 @@ Notification.enableNotificationSlot( enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise\ -设定指定类型的渠道使能状态（Promise形式）。 +设置指定应用的指定渠道类型的使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -3161,27 +3145,25 @@ enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): P | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------- | ---- | -------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| type | [SlotType](#slottype) | 是 | 指定渠道类型。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | +| type | [SlotType](#slottype) | 是 | 渠道类型。 | | enable | boolean | 是 | 使能状态。 | **示例：** ```js -//enableNotificationSlot -Notification.enableNotificationSlot( - { bundle: "ohos.samples.notification", }, - Notification.SlotType.SOCIAL_COMMUNICATION, - true).then(() => { - console.info("enableNotificationSlot sucess"); - }); +// enableNotificationSlot +Notification.enableNotificationSlot({ bundle: "ohos.samples.notification", }, + Notification.SlotType.SOCIAL_COMMUNICATION,true).then(() => { + console.info("enableNotificationSlot success"); +}); ``` ## Notification.isNotificationSlotEnabled 9+ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback\): void -获取指定类型的渠道使能状态（Callback形式）。 +获取指定应用的指定渠道类型的使能状态（Callback形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -3193,14 +3175,14 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncC | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | ---------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定包信息。 | -| type | [SlotType](#slottype) | 是 | 指定渠道类型。 | -| callback | AsyncCallback\ | 是 | 设定渠道使能回调函数。 | +| bundle | [BundleOption](#bundleoption) | 是 | 应用的包信息。 | +| type | [SlotType](#slottype) | 是 | 渠道类型。 | +| callback | AsyncCallback\ | 是 | 获取渠道使能状态回调函数。 | **示例：** ```js -//isNotificationSlotEnabled +// isNotificationSlotEnabled function getEnableSlotCallback(err, data) { if (err.code) { console.info("isNotificationSlotEnabled failed " + JSON.stringify(err)); @@ -3219,7 +3201,7 @@ Notification.isNotificationSlotEnabled( isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\ -获取指定类型的渠道使能状态（Promise形式）。 +获取指定应用的指定渠道类型的使能状态（Promise形式）。 **系统能力**：SystemCapability.Notification.Notification @@ -3231,25 +3213,23 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\ | 以Promise形式返回指定类型的渠道使能状态。 | +| 类型 | 说明 | +| ------------------ | ------------------------------- | +| Promise\ | 以Promise形式返回渠道使能状态。 | **示例：** ```js -//isNotificationSlotEnabled -Notification.isNotificationSlotEnabled( - { bundle: "ohos.samples.notification", }, - Notification.SlotType.SOCIAL_COMMUNICATION - ).then((data) => { - console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data)); - }); +// isNotificationSlotEnabled +Notification.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", }, + Notification.SlotType.SOCIAL_COMMUNICATION).then((data) => { + console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data)); +}); ``` @@ -3269,8 +3249,8 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------- | ---- | -------------- | -| userId | number | 是 | 用户Id。 | -| enable | boolean | 是 | 是否启用。
true：启用。
false：禁用。 | +| userId | number | 是 | 用户ID。 | +| enable | boolean | 是 | 是否启用。 | | callback | AsyncCallback\ | 是 | 设置是否将通知同步到未安装应用程序的设备的回调函数。 | **示例：** @@ -3279,7 +3259,7 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: let userId = 100; let enable = true; -function setSyncNotificationEnabledWithoutAppCallback(err) { +function callback(err) { if (err.code) { console.info("setSyncNotificationEnabledWithoutApp failed " + JSON.stringify(err)); } else { @@ -3287,7 +3267,7 @@ function setSyncNotificationEnabledWithoutAppCallback(err) { } } -Notification.setSyncNotificationEnabledWithoutApp(userId, enable, setSyncNotificationEnabledWithoutAppCallback); +Notification.setSyncNotificationEnabledWithoutApp(userId, enable, callback); ``` @@ -3307,8 +3287,8 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise\< | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------- | ---- | -------------- | -| userId | number | 是 | 用户Id。 | -| enable | boolean | 是 | 是否启用。
true：启用。
false：禁用。 | +| userId | number | 是 | 用户ID。 | +| enable | boolean | 是 | 是否启用。 | **返回值：** @@ -3322,13 +3302,11 @@ setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise\< let userId = 100; let enable = true; -Notification.setSyncNotificationEnabledWithoutApp(userId, enable) - .then(() => { - console.info('setSyncNotificationEnabledWithoutApp'); - }) - .catch((err) => { - console.info('setSyncNotificationEnabledWithoutApp, err:', err); - }); +Notification.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => { + console.info('setSyncNotificationEnabledWithoutApp success'); +}).catch((err) => { + console.info('setSyncNotificationEnabledWithoutApp, err:' + JSON.stringify(err)); +}); ``` @@ -3336,7 +3314,7 @@ Notification.setSyncNotificationEnabledWithoutApp(userId, enable) getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\): void -获取是否同步通知到未安装应用程序的设备(callback形式)。 +获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。 **系统能力**：SystemCapability.Notification.Notification @@ -3348,19 +3326,19 @@ getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\ | 是 | 设置是否将通知同步到未安装应用程序的设备的回调函数。
true: 是。
false: 否。 | +| userId | number | 是 | 用户ID。 | +| callback | AsyncCallback\ | 是 | 获取同步通知到未安装应用程序设备的开关是否开启的回调函数。 | **示例：** ```js let userId = 100; -function getSyncNotificationEnabledWithoutAppCallback(data, err) { +function getSyncNotificationEnabledWithoutAppCallback(err, data) { if (err) { - console.info('getSyncNotificationEnabledWithoutAppCallback, err' + err); + console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err); } else { - console.info('getSyncNotificationEnabledWithoutAppCallback, data' + data); + console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data); } } @@ -3372,7 +3350,7 @@ Notification.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEna getSyncNotificationEnabledWithoutApp(userId: number): Promise\ -获取是否同步通知到未安装应用程序的设备(Promise形式)。 +获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。 **系统能力**：SystemCapability.Notification.Notification @@ -3384,33 +3362,30 @@ getSyncNotificationEnabledWithoutApp(userId: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------------- | ---- | -------------- | -| userId | number | 是 | 用户Id。 | +| userId | number | 是 | 用户ID。 | **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取是否同步通知到未安装应用程序的设备的结果。
true: 是。
false: 否。 | +| 类型 | 说明 | +| ------------------ | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 | **示例：** ```js let userId = 100; - -Notification.getSyncNotificationEnabledWithoutApp(userId) - .then((data) => { - console.info('getSyncNotificationEnabledWithoutApp, data:', data); - }) - .catch((err) => { - console.info('getSyncNotificationEnabledWithoutApp, err:', err); - }); +Notification.getSyncNotificationEnabledWithoutApp(userId).then((data) => { + console.info('getSyncNotificationEnabledWithoutApp, data:' + data); +}).catch((err) => { + console.info('getSyncNotificationEnabledWithoutApp, err:' + err); +}); ``` ## NotificationSubscriber -提供订阅者接收到新通知或取消通知时的回调方法。 +作为订阅通知接口[subscribe](#notificationsubscribe)的入参，提供订阅者接收到新通知、取消通知等的回调方法。 **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -3418,7 +3393,7 @@ Notification.getSyncNotificationEnabledWithoutApp(userId) onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void -接收通知回调函数。 +接收到新通知的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3428,7 +3403,7 @@ onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 回调返回接收到的通知信息。 | +| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 新接收到的通知信息。 | **示例：** @@ -3442,7 +3417,6 @@ function subscribeCallback(err) { }; function onConsumeCallback(data) { - console.info('===> onConsume in test'); let req = data.request; console.info('===> onConsume callback req.id:' + req.id); }; @@ -3458,7 +3432,7 @@ Notification.subscribe(subscriber, subscribeCallback); onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void -删除通知回调函数。 +取消通知的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3468,7 +3442,7 @@ onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 回调返回接收到的通知信息。 | +| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 需要取消的通知信息。 | **示例：** @@ -3482,7 +3456,6 @@ function subscribeCallback(err) { }; function onCancelCallback(data) { - console.info('===> onCancel in test'); let req = data.request; console.info('===> onCancel callback req.id:' + req.id); } @@ -3498,7 +3471,7 @@ Notification.subscribe(subscriber, subscribeCallback); onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void -更新通知排序回调函数。 +更新通知排序的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3508,7 +3481,7 @@ onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 回调返回接收到的通知信息。 | +| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 最新的通知排序列表。 | **示例：** @@ -3521,8 +3494,8 @@ function subscribeCallback(err) { } }; -function onUpdateCallback() { - console.info('===> onUpdate in test'); +function onUpdateCallback(map) { + console.info('===> onUpdateCallback map:' + JSON.stringify(map)); } var subscriber = { @@ -3536,7 +3509,7 @@ Notification.subscribe(subscriber, subscribeCallback); onConnect?:() => void -注册订阅回调函数。 +订阅完成的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3568,7 +3541,7 @@ Notification.subscribe(subscriber, subscribeCallback); onDisconnect?:() => void -取消订阅回调函数。 +取消订阅的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3584,16 +3557,30 @@ function subscribeCallback(err) { console.info("subscribeCallback"); } }; +function unsubscribeCallback(err) { + if (err.code) { + console.info("unsubscribe failed " + JSON.stringify(err)); + } else { + console.info("unsubscribeCallback"); + } +}; +function onConnectCallback() { + console.info('===> onConnect in test'); +} function onDisconnectCallback() { console.info('===> onDisconnect in test'); } var subscriber = { + onConnect: onConnectCallback, onDisconnect: onDisconnectCallback }; +// 订阅通知后会收到onConnect回调 Notification.subscribe(subscriber, subscribeCallback); +// 取消订阅后会收到onDisconnect回调 +Notification.unsubscribe(subscriber, unsubscribeCallback); ``` ### onDestroy @@ -3632,7 +3619,7 @@ Notification.subscribe(subscriber, subscribeCallback); onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate](#donotdisturbdate8)) => void -免打扰时间选项变更回调函数。 +免打扰时间选项发生变更时的回调函数。 **系统能力**：SystemCapability.Notification.Notification @@ -3654,15 +3641,24 @@ function subscribeCallback(err) { } }; -function onDoNotDisturbDateChangeCallback() { - console.info('===> onDoNotDisturbDateChange in test'); +function onDoNotDisturbDateChangeCallback(mode) { + console.info('===> onDoNotDisturbDateChange:' + mode); } var subscriber = { onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback }; - Notification.subscribe(subscriber, subscribeCallback); + +var doNotDisturbDate = { + type: Notification.DoNotDisturbType.TYPE_ONCE, + begin: new Date(), + end: new Date(2021, 11, 15, 18, 0) +} +// 设置一个新的免打扰时间选项时触发onDoNotDisturbDateChange回调 +Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => { + console.info("setDoNotDisturbDate sucess"); +}); ``` @@ -3694,16 +3690,23 @@ function subscribeCallback(err) { }; function onEnabledNotificationChangedCallback(callbackData) { - console.info("bundle: ", callbackData.bundle); - console.info("uid: ", callbackData.uid); - console.info("enable: ", callbackData.enable); + console.info("bundle: " + callbackData.bundle); + console.info("uid: " + callbackData.uid); + console.info("enable: " + callbackData.enable); }; var subscriber = { onEnabledNotificationChanged: onEnabledNotificationChangedCallback }; - Notification.subscribe(subscriber, subscribeCallback); + +var bundle = { + bundle: "bundleName1", +} +// 设置指定应用通知使能状态触发onEnabledNotificationChanged回调 +Notification.enableNotification(bundle, false).then(() => { + console.info("enableNotification sucess"); +}); ``` ## SubscribeCallbackData @@ -3715,7 +3718,7 @@ Notification.subscribe(subscriber, subscribeCallback); | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | ------------------------------------------------- | ---- | --- | -------- | | request | [NotificationRequest](#notificationrequest) | 是 | 否 | 通知内容。 | -| sortingMap | [NotificationSortingMap](#notificationsortingmap) | 是 | 否 | 排序信息。 | +| sortingMap | [NotificationSortingMap](#notificationsortingmap) | 是 | 否 | 通知排序信息。 | | reason | number | 是 | 否 | 删除原因。 | | sound | string | 是 | 否 | 通知声音。 | | vibrationValues | Array\ | 是 | 否 | 通知震动。 | @@ -3740,13 +3743,11 @@ Notification.subscribe(subscriber, subscribeCallback); **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----- ------------------------------------- || ---- | --- | ------------------------ | -| type | [DoNotDisturbType](#donotdisturbtype8) | 是 | 否 | 指定免打扰设置的时间类型。 | -| begin | Date | 是 | 否 | 指定免打扰设置的起点时间。 | -| end | Date | 是 | 否 | 指定免打扰设置的终点时间。 | - - +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----- | -------------------------------------- | ---- | ---- | ---------------------- | +| type | [DoNotDisturbType](#donotdisturbtype8) | 是 | 是 | 免打扰设置的时间类型。 | +| begin | Date | 是 | 是 | 免打扰设置的起点时间。 | +| end | Date | 是 | 是 | 免打扰设置的终点时间。 | ## DoNotDisturbType8+ @@ -3793,8 +3794,8 @@ Notification.subscribe(subscriber, subscribeCallback); | 名称 | 类型 | 可读 | 可写 | 说明 | | ------ | ------ |---- | --- | ------ | -| bundle | string | 是 | 是 | 包名。 | -| uid | number | 是 | 是 | 用户id。 | +| bundle | string | 是 | 是 | 应用的包信息。 | +| uid | number | 是 | 是 | 用户ID。 | @@ -3830,7 +3831,7 @@ Notification.subscribe(subscriber, subscribeCallback); | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | ----------------------------------------------- | --- | ---- | ------------------------- | | title | string | 是 | 是 | 按钮标题。 | -| wantAgent | WantAgent | 是 | 是 | 点击按钮时触发的WantAgent。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | 点击按钮时触发的WantAgent。 | | extras | { [key: string]: any } | 是 | 是 | 按钮扩展信息。 | | userInput8+ | [NotificationUserInput](#notificationuserinput8) | 是 | 是 | 用户输入对象实例。 | @@ -3845,7 +3846,7 @@ Notification.subscribe(subscriber, subscribeCallback); | -------------- | ------ | ---- | ---- | ---------------------------------- | | title | string | 是 | 是 | 通知标题。 | | text | string | 是 | 是 | 通知内容。 | -| additionalText | string | 是 | 是 | 通知次要内容，是对通知内容的补充。 | +| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 | ## NotificationLongTextContent @@ -3858,7 +3859,7 @@ Notification.subscribe(subscriber, subscribeCallback); | -------------- | ------ | ---- | --- | -------------------------------- | | title | string | 是 | 是 | 通知标题。 | | text | string | 是 | 是 | 通知内容。 | -| additionalText | string | 是 | 是 | 通知次要内容，是对通知内容的补充。 | +| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 | | longText | string | 是 | 是 | 通知的长文本。 | | briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 | | expandedTitle | string | 是 | 是 | 通知展开时的标题。 | @@ -3874,7 +3875,7 @@ Notification.subscribe(subscriber, subscribeCallback); | -------------- | --------------- | --- | --- | -------------------------------- | | title | string | 是 | 是 | 通知标题。 | | text | string | 是 | 是 | 通知内容。 | -| additionalText | string | 是 | 是 | 通知次要内容，是对通知内容的补充。 | +| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 | | briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 | | longTitle | string | 是 | 是 | 通知展开时的标题。 | | lines | Array\ | 是 | 是 | 通知的多行文本。 | @@ -3890,10 +3891,10 @@ Notification.subscribe(subscriber, subscribeCallback); | -------------- | -------------- | ---- | --- | -------------------------------- | | title | string | 是 | 是 | 通知标题。 | | text | string | 是 | 是 | 通知内容。 | -| additionalText | string | 是 | 是 | 通知次要内容，是对通知内容的补充。 | +| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 | | briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 | | expandedTitle | string | 是 | 是 | 通知展开时的标题。 | -| picture | image.PixelMap | 是 | 是 | 通知的图片内容。 | +| picture | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知的图片内容。 | ## NotificationContent @@ -3934,8 +3935,8 @@ Notification.subscribe(subscriber, subscribeCallback); | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------- | ---------------------- | ---- | ---- | --------------------------------- | -| soundEnabled | NotificationFlagStatus | 是 | 否 | 是否启用声音提示。 | -| vibrationEnabled | NotificationFlagStatus | 是 | 否 | 是否启用振动提醒功能。 | +| soundEnabled | [NotificationFlagStatus](#notificationflagstatus8) | 是 | 否 | 是否启用声音提示。 | +| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus8) | 是 | 否 | 是否启用振动提醒功能。 | ## NotificationRequest @@ -3954,11 +3955,11 @@ Notification.subscribe(subscriber, subscribeCallback); | deliveryTime | number | 是 | 是 | 通知发送时间。 | | tapDismissed | boolean | 是 | 是 | 通知是否自动清除。 | | autoDeletedTime | number | 是 | 是 | 自动清除的时间。 | -| wantAgent | WantAgent | 是 | 是 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 | | extraInfo | {[key: string]: any} | 是 | 是 | 扩展参数。 | -| color | number | 是 | 是 | 通知背景颜色。暂不支持。 | -| colorEnabled | boolean | 是 | 是 | 通知背景颜色是否使能。暂不支持。 | -| isAlertOnce | boolean | 是 | 是 | 设置是否仅有一次此通知警报。 | +| color | number | 是 | 是 | 通知背景颜色。预留能力，暂未支持。 | +| colorEnabled | boolean | 是 | 是 | 通知背景颜色是否使能。预留能力，暂未支持。 | +| isAlertOnce | boolean | 是 | 是 | 设置是否仅有一次此通知提醒。 | | isStopwatch | boolean | 是 | 是 | 是否显示已用时间。 | | isCountDown | boolean | 是 | 是 | 是否显示倒计时时间。 | | isFloatingIcon | boolean | 是 | 是 | 是否显示状态栏图标。 | @@ -3966,8 +3967,8 @@ Notification.subscribe(subscriber, subscribeCallback); | badgeIconStyle | number | 是 | 是 | 通知角标类型。 | | showDeliveryTime | boolean | 是 | 是 | 是否显示分发时间。 | | actionButtons | Array\<[NotificationActionButton](#notificationactionbutton)\> | 是 | 是 | 通知按钮，最多两个按钮。 | -| smallIcon | PixelMap | 是 | 是 | 通知小图标。（可选字段，大小不超过30KB） | -| largeIcon | PixelMap | 是 | 是 | 通知大图标。（可选字段，大小不超过30KB） | +| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知小图标。可选字段，大小不超过30KB。 | +| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知大图标。可选字段，大小不超过30KB。 | | creatorBundleName | string | 是 | 否 | 创建通知的包名。 | | creatorUid | number | 是 | 否 | 创建通知的UID。 | | creatorPid | number | 是 | 否 | 创建通知的PID。 | @@ -3981,7 +3982,7 @@ Notification.subscribe(subscriber, subscribeCallback); | distributedOption8+ | [DistributedOptions](#distributedoptions8) | 是 | 是 | 分布式通知的选项。 | | deviceId8+ | string | 是 | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | notificationFlags8+ | [NotificationFlags](#notificationflags8) | 是 | 否 | 获取NotificationFlags。 | -| removalWantAgent9+ | WantAgent | 是 | 是 | 当移除通知时，通知将被重定向到的WantAgent实例。 | +| removalWantAgent9+ | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | 当移除通知时，通知将被重定向到的WantAgent实例。 | | badgeNumber9+ | number | 是 | 是 | 应用程序图标上显示的通知数。 | ## DistributedOptions8+ @@ -3993,8 +3994,8 @@ Notification.subscribe(subscriber, subscribeCallback); | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------------- | -------------- | ---- | ---- | ---------------------------------- | | isDistributed | boolean | 是 | 是 | 是否为分布式通知。 | -| supportDisplayDevices | Array\ | 是 | 是 | 可以同步通知到的设备类型。 | -| supportOperateDevices | Array\ | 是 | 是 | 可以打开通知的设备。 | +| supportDisplayDevices | Array\ | 是 | 是 | 可以同步通知到的设备列表。 | +| supportOperateDevices | Array\ | 是 | 是 | 可以打开通知的设备列表。 | | remindType | number | 是 | 否 | 通知的提醒方式。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md index 91aea9501f..ec4eea276e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md @@ -3589,7 +3589,7 @@ getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\