From 7a9a0d20a4e3643111c102e31533cd889392a788 Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Thu, 9 Mar 2023 16:55:07 +0800 Subject: [PATCH] fix notification error Signed-off-by: yuyaozhi --- .../reference/apis/js-apis-notification.md | 8 +- .../apis/js-apis-notificationSubscribe.md | 150 +++--------------- .../apis/js-apis-system-notification.md | 20 +-- 3 files changed, 40 insertions(+), 138 deletions(-) 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 b9b5f24a3c..8b646e42f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -853,8 +853,8 @@ function unsubscribeCallback(err) { console.info("unsubscribe success"); } } -function onDisconnectCallback(data) { - console.info("Cancel callback: " + JSON.stringify(data)); +function onDisconnectCallback() { + console.info("subscribe disconnect"); } let subscriber = { onDisconnect: onDisconnectCallback @@ -883,8 +883,8 @@ unsubscribe(subscriber: NotificationSubscriber): Promise\ **示例：** ```js -function onDisconnectCallback(data) { - console.info("Cancel callback: " + JSON.stringify(data)); +function onDisconnectCallback() { + console.info("subscribe disconnect"); } let subscriber = { onDisconnect: onDisconnectCallback diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md index 868c70f3f7..c2ce9ae804 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md @@ -30,8 +30,8 @@ subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, c | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ---------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | -| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是 | 通知订阅信息。 | +| subscriber | [NotificationSubscriber](js-apis-notification.md#notificationsubscriber) | 是 | 通知订阅对象。 | +| info | [NotificationSubscribeInfo](js-apis-notification.md#notificationsubscribeinfo) | 是 | 通知订阅信息。 | | callback | AsyncCallback\ | 是 | 订阅动作回调函数。 | **错误码：** @@ -83,7 +83,7 @@ subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------- | ---- | ---------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-notification.md#notificationsubscriber) | 是 | 通知订阅对象。 | | callback | AsyncCallback\ | 是 | 订阅动作回调函数。 | **错误码：** @@ -133,8 +133,8 @@ subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------ | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | -| info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否 | 通知订阅信息。 | +| subscriber | [NotificationSubscriber](js-apis-notification.md#notificationsubscriber) | 是 | 通知订阅对象。 | +| info | [NotificationSubscribeInfo](js-apis-notification.md#notificationsubscribeinfo) | 否 | 通知订阅信息。 | **错误码：** @@ -178,7 +178,7 @@ unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\) | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------- | ---- | -------------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-notification.md#notificationsubscriber) | 是 | 通知订阅对象。 | | callback | AsyncCallback\ | 是 | 取消订阅动作回调函数。 | **错误码：** @@ -201,8 +201,8 @@ function unsubscribeCallback(err) { console.info("unsubscribe success"); } } -function onDisconnectCallback(data) { - console.info("Cancel callback: " + JSON.stringify(data)); +function onDisconnectCallback() { + console.info("subscribe disconnect"); } let subscriber = { onDisconnect: onDisconnectCallback @@ -226,7 +226,7 @@ unsubscribe(subscriber: NotificationSubscriber): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------- | ---- | ------------ | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-notification.md#notificationsubscriber) | 是 | 通知订阅对象。 | **错误码：** @@ -241,8 +241,8 @@ unsubscribe(subscriber: NotificationSubscriber): Promise\ **示例：** ```js -function onDisconnectCallback(data) { - console.info("Cancel callback: " + JSON.stringify(data)); +function onDisconnectCallback() { + console.info("subscribe disconnect"); } let subscriber = { onDisconnect: onDisconnectCallback @@ -268,8 +268,8 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | 参数名 | 类型 | 必填 | 说明 | | --------------- | ----------------------------------| ---- | -------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | -| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | +| bundle | [BundleOption](js-apis-inner-notification-bundleOption.md) | 是 | 指定应用的包信息。 | +| notificationKey | [NotificationKey](js-apis-notification.md#notificationkey) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | @@ -324,8 +324,8 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | 参数名 | 类型 | 必填 | 说明 | | --------------- | --------------- | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | -| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | +| bundle | [BundleOption](js-apis-inner-notification-bundleOption.md) | 是 | 指定应用的包信息。 | +| notificationKey | [NotificationKey]((js-apis-notification.md#notificationkey)) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason) | 是 | 通知删除原因。 | **错误码：** @@ -372,7 +372,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | -------------------- | -| hashCode | string | 是 | 通知唯一ID。可以通过[onConsume](#onconsume)回调的入参[SubscribeCallbackData](#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 | +| hashCode | string | 是 | 通知唯一ID。可以通过[onConsume](#onconsume)回调的入参[SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 | | reason | [RemoveReason](#removereason) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | @@ -459,7 +459,7 @@ removeAll(bundle: BundleOption, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ---------------------------- | -| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | +| bundle | [BundleOption]((js-apis-inner-notification-bundleOption.md)) | 是 | 指定应用的包信息。 | | callback | AsyncCallback\ | 是 | 删除指定应用的所有通知回调函数。 | **错误码：** @@ -547,7 +547,7 @@ removeAll(bundle?: BundleOption): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------ | ---- | ---------- | -| bundle | [BundleOption](#bundleoption) | 否 | 指定应用的包信息。 | +| bundle | [BundleOption]((js-apis-inner-notification-bundleOption.md)) | 否 | 指定应用的包信息。 | **错误码：** @@ -668,7 +668,7 @@ notificationSubscribe.removeAll(userId, removeAllCallback); ### onConsume -onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void +onConsume?: (data: [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata)) => void 接收到新通知的回调函数。 @@ -680,7 +680,7 @@ onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 新接收到的通知信息。 | +| data | [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata) | 是 | 新接收到的通知信息。 | **示例：** @@ -708,7 +708,7 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ### onCancel -onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void +onCancel?:(data: [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata)) => void 取消通知的回调函数。 @@ -720,7 +720,7 @@ onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 需要取消的通知信息。 | +| data | [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata) | 是 | 需要取消的通知信息。 | **示例：** @@ -748,7 +748,7 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ### onUpdate -onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void +onUpdate?:(data: [NotificationSortingMap](js-apis-notification.md#notificationsortingmap)) => void 更新通知排序的回调函数。 @@ -760,7 +760,7 @@ onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 最新的通知排序列表。 | +| data | [NotificationSortingMap](js-apis-notification.md#notificationsortingmap)) | 是 | 最新的通知排序列表。 | **示例：** @@ -935,7 +935,7 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ### onEnabledNotificationChanged -onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata)) => void +onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](js-apis-notification.md#enablednotificationcallbackdata)) => void 监听应用通知使能变化。 @@ -947,7 +947,7 @@ onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](# | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------ | ---- | -------------------------- | -| callback | AsyncCallback\<[EnabledNotificationCallbackData](#enablednotificationcallbackdata)\> | 是 | 回调返回监听到的应用信息。 | +| callback | AsyncCallback\<[EnabledNotificationCallbackData](js-apis-notification.md#enablednotificationcallbackdata)\> | 是 | 回调返回监听到的应用信息。 | **示例：** @@ -1013,104 +1013,6 @@ let subscriber = { notificationSubscribe.subscribe(subscriber, subscribeCallback); ``` -## BundleOption - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------ | ------ |---- | --- | ------ | -| bundle | string | 是 | 是 | 应用的包信息。 | -| uid | number | 是 | 是 | 用户ID。 | - -## NotificationKey - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----- | ------ | ---- | --- | -------- | -| id | number | 是 | 是 | 通知ID。 | -| label | string | 是 | 是 | 通知标签。 | - -## SubscribeCallbackData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -**系统API**：此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------- | ------------------------------------------------- | -------- | -------- | -------- | -| request | [NotificationRequest](js-apis-notificationManager.md#notificationrequest) | 是 | 否 | 通知内容。 | -| sortingMap | [NotificationSortingMap](#notificationsortingmap) | 是 | 否 | 排序信息。 | -| reason | number | 是 | 否 | 删除原因。 | -| sound | string | 是 | 否 | 通知声音。 | -| vibrationValues | Array\ | 是 | 否 | 通知震动。 | - - -## EnabledNotificationCallbackData - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -**系统API**：此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 描述 | -| ------ | ------- | ---------------- | ---------------- | ---------------- | -| bundle | string | 是 | 否 | 应用的包名。 | -| uid | number | 是 | 否 | 应用的uid。 | -| enable | boolean | 是 | 否 | 应用通知使能状态。 | - - -## NotificationSorting - -提供有关活动通知的排序信息。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | ------------------------------------- | ---- | --- | ------------ | -| slot | [NotificationSlot](js-apis-notificationManager.md#notificationslot) | 是 | 否 | 通知通道内容。 | -| hashCode | string | 是 | 否 | 通知唯一标识。 | -| ranking | number | 是 | 否 | 通知排序序号。 | - - -## NotificationSortingMap - -提供关于已订阅的所有通知中活动通知的排序信息 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -**系统API**：此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------------- | ------------------------------------------------------------ | ---- | --- | ---------------- | -| sortings | {[key: string]: [NotificationSorting](#notificationsorting)} | 是 | 否 | 通知排序信息数组。 | -| sortedHashCode | Array\ | 是 | 否 | 通知唯一标识数组。 | - - -## NotificationSubscribeInfo - -设置订阅所需通知的发布者的信息。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------- | --------------- | --- | ---- | ------------------------------- | -| bundleNames | Array\ | 是 | 是 | 指定订阅哪些包名的APP发来的通知。 | -| userId | number | 是 | 是 | 指定订阅哪个用户下发来的通知。 | - - -## NotificationUserInput - -保存用户输入的通知消息。 - -**系统能力**：SystemCapability.Notification.Notification - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | ------ | --- | ---- | ----------------------------- | -| inputKey | string | 是 | 是 | 用户输入时用于标识此输入的key。 | ## RemoveReason diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md index 90e6590261..62de17e20d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-notification.md @@ -17,22 +17,22 @@ import notification from '@system.notification'; **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 可读 | 可写 | 必填 | 描述 | -| ----------- | ---------------------------------------------- | ---- | ------------------------- | ------------------------- | ------------------------- | -| bundleName | string | 是 | 是 | 是 | 单击通知后要重定向到的应用程序的Bundle名。 | -| abilityName | string | 是 | 是 | 是 | 单击通知后要重定向到的应用程序的Ability名称。 | -| uri | string | 是 | 是 | 否 | 要重定向到的页面的uri。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------- | ---------------------------------------------- | ---- | ------------------------- | +| bundleName | string | 是 | 单击通知后要重定向到的应用程序的Bundle名。 | +| abilityName | string | 是 | 单击通知后要重定向到的应用程序的Ability名称。 | +| uri | string | 否 | 要重定向到的页面的uri。 | ## ShowNotificationOptions **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 可读 | 可写 | 必填 | 描述 | -| ------------- | ---------------------------------------------- | ---- | ------------------------- | ------------------------- | ------------------------- | -| contentTitle | string | 是 | 是 | 否 | 通知标题。 | -| contentText | string | 是 | 是 | 否 | 通知内容。 | -| clickAction | ActionResult | 是 | 是 | 否 | 通知被点击后触发的行为。 | +| 名称 | 类型 | 必填 | 说明 | +| ------------- | ---------------------------------------------- | ---- | ------------------------- | +| contentTitle | string | 否 | 通知标题。 | +| contentText | string | 否 | 通知内容。 | +| clickAction | ActionResult | 否 | 通知被点击后触发的行为。 | ## notification.show -- GitLab