diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index 7add180ca0b27b9d6169963b7ba2761acedfd5b4..b9cf951cc38305576c6d124afaf32bd0c21311e6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -32,7 +32,7 @@ publish(event: string, callback: AsyncCallback\<void>): void **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | -------------------- | ---- | ---------------------- | | event | string | 是 | 表示è¦å‘é€çš„公共事件。 | | callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | @@ -66,7 +66,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示è¦å‘布的公共事件。 | | options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示å‘布公共事件的属性。 | @@ -111,7 +111,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): vo **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | -------------------- | ---- | ---------------------------------- | | event | string | 是 | 表示è¦å‘é€çš„公共事件。 | | userId | number | 是 | 表示指定å‘该用户IDå‘é€æ¤å…¬å…±äº‹ä»¶ã€‚ | @@ -151,7 +151,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示è¦å‘布的公共事件。 | | userId | number | 是 | 表示指定å‘该用户IDå‘é€æ¤å…¬å…±äº‹ä»¶ã€‚ | @@ -197,7 +197,7 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ------------- | ------------------------------------------------------------ | ---- | -------------------------- | | subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信æ¯ã€‚ | | callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 是 | 表示创建订阅者的回调方法。 | @@ -240,7 +240,7 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSu **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ------------- | ----------------------------------------------------- | ---- | -------------- | | subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信æ¯ã€‚ | @@ -281,7 +281,7 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEvent **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ---------------------------------------------------- | ---- | -------------------------------- | | subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | | callback | AsyncCallback\<[CommonEventData](./js-apis-inner-commonEvent-commonEventData.md)> | 是 | 表示接收公共事件数æ®çš„回调函数。 | @@ -334,7 +334,7 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): **å‚数:** -| å称 | 类型 | å¿…å¡« | 说明 | +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ----------------------------------------------- | ---- | ------------------------ | | subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | | callback | AsyncCallback\<void> | å¦ | 表示å–消订阅的回调方法。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index cf0bd2c8e46a4380b6fca1a9087e2538460569f7..789173a32a9908e34fee1956f6a16f7b96b87669 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -547,3 +547,87 @@ CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => { }); ``` +## CommonEventManager.setStaticSubscriberState<sup>10+</sup> + +setStaticSubscriberState(enable: boolean, callback: AsyncCallback\<void>): void; + +方法介ç»ï¼šä¸ºå½“å‰åº”用设置é™æ€è®¢é˜…事件使能或去使能状æ€ã€‚使用callback异æ¥å›žè°ƒã€‚ + +**系统能力:** SystemCapability.Notification.CommonEvent + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**å‚数:** + +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | +| ------ | ------ | ---- | -------------------------- | +| enable | boolean | 是 | 表示é™æ€è®¢é˜…事件使能状æ€ã€‚ true:使能 false:去使能。 | +| callback | AsyncCallback<void> | 是 | 表示设置é™æ€è®¢é˜…事件使能状æ€çš„回调方法。 | + +**错误ç :** + +错误ç 介ç»è¯·å‚考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) + +| 错误ç ID | é”™è¯¯ä¿¡æ¯ | +| -------- | ----------------------------------- | +| 1500007 | error sending message to Common Event Service. | +| 1500008 | Common Event Service does not complete initialization. | + +**示例:** + + +```ts +CommonEventManager.setStaticSubscriberState(true, (err) => { + if (!err) { + console.info(`Set static subscriber state callback failed, err is null.`); + return; + } + if (err.code) { + console.info(`Set static subscriber state callback failed, errCode: ${err.code}, errMes: ${err.message}`); + return; + } + console.info(`Set static subscriber state callback success`); +}); +``` + +## CommonEventManager.setStaticSubscriberState<sup>10+</sup> + +setStaticSubscriberState(enable: boolean): Promise\<void>; + +方法介ç»ï¼šä¸ºå½“å‰åº”用设置é™æ€è®¢é˜…事件使能或去使能状æ€ã€‚使用Promise异æ¥å›žè°ƒã€‚ + +**系统能力:** SystemCapability.Notification.CommonEvent + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**å‚数:** + +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | +| ------ | ------ | ---- | -------------------------- | +| enable | boolean | 是 | 表示é™æ€è®¢é˜…事件使能状æ€ã€‚ true:使能 false:去使能。 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | ---------------------------- | +| Promise\<void> | 表示设置é™æ€è®¢é˜…事件使能状æ€çš„对象。 | + +**错误ç :** + +错误ç 介ç»è¯·å‚考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) + +| 错误ç ID | é”™è¯¯ä¿¡æ¯ | +| -------- | ----------------------------------- | +| 1500007 | error sending message to Common Event Service. | +| 1500008 | Common Event Service does not complete initialization. | + +**示例:** + + +```ts +CommonEventManager.setStaticSubscriberState(false).then(() => { + console.info(`Set static subscriber state promise success`); +}).catch ((err) => { + console.info(`Set static subscriber state promise failed, errCode: ${err.code}, errMes: ${err.message}`); +}); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md index 0f5b5f687a4aec8c51b56e283bef2ed271915c13..a5de149c3a5aa6069af8f5fd22c39e2337951bb3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md @@ -6,6 +6,12 @@ > > 本模å—首批接å£ä»ŽAPI version 7开始支æŒã€‚åŽç»ç‰ˆæœ¬çš„新增接å£ï¼Œé‡‡ç”¨ä¸Šè§’æ ‡å•ç‹¬æ ‡è®°æŽ¥å£çš„起始版本。 +## å¯¼å…¥æ¨¡å— + +```js +import notificationSubscribe from '@ohos.notificationSubscribe'; +``` + **系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ ### onConsume 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 27fc51bbf4580a7d817c4315a577dae936e86099..001fa804788478def8c2c0b0c7215eece24413fe 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -726,7 +726,7 @@ subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, c | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ------------------------- | ---- | ---------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是 | 通知订阅对象。 | | info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是 | 通知订阅信æ¯ã€‚ | | callback | AsyncCallback\<void\> | 是 | 订阅动作回调函数。 | @@ -769,7 +769,7 @@ subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>): | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ---------------------- | ---- | ---------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是 | 通知订阅对象。 | | callback | AsyncCallback\<void\> | 是 | 订阅动作回调函数。 | **示例:** @@ -807,7 +807,7 @@ subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ------------------------- | ---- | ------------ | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是 | 通知订阅对象。 | | info | [NotificationSubscribeInfo](#notificationsubscribeinfo) | å¦ | 通知订阅信æ¯ã€‚ | **示例:** @@ -840,7 +840,7 @@ unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ---------------------- | ---- | -------------------- | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是 | 通知订阅对象。 | | callback | AsyncCallback\<void\> | 是 | å–消订阅动作回调函数。 | **示例:** @@ -878,7 +878,7 @@ unsubscribe(subscriber: NotificationSubscriber): Promise\<void\> | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | ---------- | ---------------------- | ---- | ------------ | -| subscriber | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | +| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是 | 通知订阅对象。 | **示例:** @@ -1459,7 +1459,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | --------------- | ----------------------------------| ---- | -------------------- | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信æ¯ã€‚ | -| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | +| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason9) | 是 | é€šçŸ¥åˆ é™¤åŽŸå› ã€‚ | | callback | AsyncCallback\<void\> | 是 | åˆ é™¤æŒ‡å®šé€šçŸ¥å›žè°ƒå‡½æ•°ã€‚ | @@ -1501,7 +1501,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | --------------- | --------------- | ---- | ---------- | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信æ¯ã€‚ | -| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | +| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason9) | 是 | é€šçŸ¥åˆ é™¤åŽŸå› ã€‚ | **示例:** @@ -1536,7 +1536,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\<void\>): | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | --------------------- | ---- | -------------------- | -| hashCode | string | 是 | 通知唯一ID。å¯ä»¥é€šè¿‡[onConsume](#onconsume)回调的入å‚[SubscribeCallbackData](#subscribecallbackdata)获å–其内部[NotificationRequest](#notificationrequest)对象ä¸çš„hashCode。 | +| hashCode | string | 是 | 通知唯一ID。å¯ä»¥é€šè¿‡[onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume)回调的入å‚[SubscribeCallbackData](#subscribecallbackdata)获å–其内部[NotificationRequest](#notificationrequest)对象ä¸çš„hashCode。 | | reason | [RemoveReason](#removereason9) | 是 | é€šçŸ¥åˆ é™¤åŽŸå› ã€‚ | | callback | AsyncCallback\<void\> | 是 | åˆ é™¤æŒ‡å®šé€šçŸ¥å›žè°ƒå‡½æ•°ã€‚ | @@ -2777,332 +2777,6 @@ Notification.getDeviceRemindType().then((data) => { }); ``` -## NotificationSubscriber - -作为订阅通知接å£[subscribe](#notificationsubscribe)çš„å…¥å‚,æ供订阅者接收到新通知ã€å–消通知ç‰çš„回调方法。 - -**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -### onConsume - -onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void - -接收到新通知的回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统接å£**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**å‚数:** - -| å‚æ•°å | 类型 | å¿…å¡« | 说明 | -| ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 新接收到的通知信æ¯ã€‚ | - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onConsumeCallback(data) { - let req = data.request; - console.info('===> onConsume callback req.id:' + req.id); -}; - -let subscriber = { - onConsume: onConsumeCallback -}; - -Notification.subscribe(subscriber, subscribeCallback); -``` - -### onCancel - -onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void - -å–消通知的回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**å‚数:** - -| å‚æ•°å | 类型 | å¿…å¡« | 说明 | -| ------------ | ------------------------ | ---- | -------------------------- | -| data | [SubscribeCallbackData](#subscribecallbackdata) | 是 | 需è¦å–消的通知信æ¯ã€‚ | - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onCancelCallback(data) { - let req = data.request; - console.info('===> onCancel callback req.id:' + req.id); -} - -let subscriber = { - onCancel: onCancelCallback -}; - -Notification.subscribe(subscriber, subscribeCallback); -``` - -### onUpdate - -onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void - -更新通知排åºçš„回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**å‚数:** - -| å‚æ•°å | 类型 | å¿…å¡« | 说明 | -| ------------ | ------------------------ | ---- | -------------------------- | -| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 最新的通知排åºåˆ—表。 | - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onUpdateCallback(map) { - console.info('===> onUpdateCallback map:' + JSON.stringify(map)); -} - -let subscriber = { - onUpdate: onUpdateCallback -}; - -Notification.subscribe(subscriber, subscribeCallback); -``` - -### onConnect - -onConnect?:() => void - -订阅完æˆçš„回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onConnectCallback() { - console.info('===> onConnect in test'); -} - -let subscriber = { - onConnect: onConnectCallback -}; - -Notification.subscribe(subscriber, subscribeCallback); -``` - -### onDisconnect - -onDisconnect?:() => void - -å–消订阅的回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - 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'); -} - -let subscriber = { - onConnect: onConnectCallback, - onDisconnect: onDisconnectCallback -}; - -// 订阅通知åŽä¼šæ”¶åˆ°onConnect回调 -Notification.subscribe(subscriber, subscribeCallback); -// å–消订阅åŽä¼šæ”¶åˆ°onDisconnect回调 -Notification.unsubscribe(subscriber, unsubscribeCallback); -``` - -### onDestroy - -onDestroy?:() => void - -æœåŠ¡å¤±è”回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onDestroyCallback() { - console.info('===> onDestroy in test'); -} - -let subscriber = { - onDestroy: onDestroyCallback -}; - -Notification.subscribe(subscriber, subscribeCallback); -``` - -### onDoNotDisturbDateChange<sup>8+</sup> - -onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate](#donotdisturbdate8)) => void - -å…打扰时间选项å‘生å˜æ›´æ—¶çš„回调函数。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**å‚数:** - -| å‚æ•°å | 类型 | å¿…å¡« | 说明 | -| ------------ | ------------------------ | ---- | -------------------------- | -| mode | notification.[DoNotDisturbDate](#donotdisturbdate8) | 是 | 回调返回å…打扰时间选项å˜æ›´ã€‚ | - -**示例:** -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onDoNotDisturbDateChangeCallback(mode) { - console.info('===> onDoNotDisturbDateChange:' + mode); -} - -let subscriber = { - onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback -}; -Notification.subscribe(subscriber, subscribeCallback); - -let 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"); -}); -``` - - -### onEnabledNotificationChanged<sup>8+</sup> - -onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) => void - -监å¬åº”用通知使能å˜åŒ–。 - -**系统能力**:SystemCapability.Notification.Notification - -**系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ - -**å‚数:** - -| å‚æ•°å | 类型 | å¿…å¡« | 说明 | -| ------------ | ------------------------ | ---- | -------------------------- | -| callback | AsyncCallback\<[EnabledNotificationCallbackData](#enablednotificationcallbackdata8)\> | 是 | 回调返回监å¬åˆ°çš„应用信æ¯ã€‚ | - -**示例:** - -```javascript -function subscribeCallback(err) { - if (err.code) { - console.info("subscribe failed " + JSON.stringify(err)); - } else { - console.info("subscribeCallback"); - } -}; - -function onEnabledNotificationChangedCallback(callbackData) { - console.info("bundle: " + callbackData.bundle); - console.info("uid: " + callbackData.uid); - console.info("enable: " + callbackData.enable); -}; - -let subscriber = { - onEnabledNotificationChanged: onEnabledNotificationChangedCallback -}; -Notification.subscribe(subscriber, subscribeCallback); - -let bundle = { - bundle: "bundleName1", -} -// 设置指定应用通知使能状æ€è§¦å‘onEnabledNotificationChanged回调 -Notification.enableNotification(bundle, false).then(() => { - console.info("enableNotification sucess"); -}); -``` - ## SubscribeCallbackData **系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification @@ -3131,10 +2805,13 @@ Notification.enableNotification(bundle, false).then(() => { | enable | boolean | 是 | å¦ | 应用通知使能状æ€ã€‚ | -## DoNotDisturbDate<sup>8+</sup> +## DoNotDisturbDate<sup>8+</sup> <sup>deprecated</sup> **系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification +> **说明:** +> 从 API version 8开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.DoNotDisturbDate](js-apis-notificationManager.md#donotdisturbdate)替代 + **系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ | å称 | 类型 | å¯è¯» | å¯å†™ | 说明 | @@ -3143,10 +2820,13 @@ Notification.enableNotification(bundle, false).then(() => { | begin | Date | 是 | 是 | å…打扰设置的起点时间。 | | end | Date | 是 | 是 | å…打扰设置的终点时间。 | -## DoNotDisturbType<sup>8+</sup> +## DoNotDisturbType<sup>8+</sup> <sup>deprecated</sup> **系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification +> **说明:** +> 从 API version 8开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.DoNotDisturbType](js-apis-notificationManager.md#donotdisturbtype)替代 + **系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ | å称 | 值 | 说明 | @@ -3182,19 +2862,25 @@ Notification.enableNotification(bundle, false).then(() => { | LEVEL_HIGH | 4 | 表示通知功能已å¯ç”¨ï¼ŒçŠ¶æ€æ ä¸æ˜¾ç¤ºé€šçŸ¥å›¾æ ‡ï¼Œæœ‰æ¨ªå¹…å’Œæ示音。 | -## BundleOption +## BundleOption<sup>deprecated</sup> **系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification -| å称 | 类型 | å¯è¯» | å¯å†™ | 说明 | +> **说明:** +> 从 API version 7开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption)替代 + +| å称 | 类型 | åªè¯» | å¿…å¡« | 说明 | | ------ | ------ |---- | --- | ------ | -| bundle | string | 是 | 是 | 应用的包信æ¯ã€‚ | -| uid | number | 是 | 是 | 用户ID。 | +| bundle | string | å¦ | 是 | 应用的包信æ¯ã€‚ | +| uid | number | å¦ | å¦ | 用户ID。 | -## NotificationKey +## NotificationKey<sup>deprecated</sup> **系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification +> **说明:** +> 从 API version 7开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.NotificationKey](js-apis-notificationSubscribe.md#notificationkey)替代 + | å称 | 类型 | å¯è¯» | å¯å†™ | 说明 | | ----- | ------ | ---- | --- | -------- | | id | number | 是 | 是 | 通知ID。 | @@ -3479,12 +3165,15 @@ Notification.enableNotification(bundle, false).then(() => { | inputKey | string | 是 | 是 | ç”¨æˆ·è¾“å…¥æ—¶ç”¨äºŽæ ‡è¯†æ¤è¾“入的key。 | -## DeviceRemindType<sup>8+</sup> +## DeviceRemindType<sup>8+</sup> <sup>deprecated</sup> **系统能力**:SystemCapability.Notification.Notification **系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ +> **说明:** +> 从 API version 8开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.DeviceRemindType](js-apis-notificationManager.md#deviceremindtype)替代 + | å称 | 值 | 说明 | | -------------------- | --- | --------------------------------- | | IDLE_DONOT_REMIND | 0 | è®¾å¤‡æœªè¢«ä½¿ç”¨ï¼Œæ— éœ€æ醒。 | @@ -3493,24 +3182,30 @@ Notification.enableNotification(bundle, false).then(() => { | ACTIVE_REMIND | 3 | æ醒设备æ£åœ¨ä½¿ç”¨ã€‚ | -## SourceType<sup>8+</sup> +## SourceType<sup>8+</sup> <sup>deprecated</sup> **系统能力**:SystemCapability.Notification.Notification **系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ +> **说明:** +> 从 API version 8开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.SourceType](js-apis-notificationManager.md#sourcetype)替代 + | å称 | 值 | 说明 | | -------------------- | --- | -------------------- | | TYPE_NORMAL | 0 | 一般通知。 | | TYPE_CONTINUOUS | 1 | è¿žç»é€šçŸ¥ã€‚ | | TYPE_TIMER | 2 | 计划通知。 | -## RemoveReason<sup>9+</sup> +## RemoveReason<sup>9+</sup> <sup>deprecated</sup> **系统能力**:SystemCapability.Notification.Notification **系统API**: æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ +> **说明:** +> 从 API version 9开始支æŒï¼Œä»ŽAPI version 9开始废弃。建议使用[notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason)替代 + | å称 | 值 | 说明 | | -------------------- | --- | -------------------- | | CLICK_REASON_REMOVE<sup>9+</sup> | 1 | 点击通知åŽåˆ 除通知。 | 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 a045903dfb7b15933fc319b9263455b4931abaa4..1ed7bb6c6da08d79ee7515a2f4475657e40bcb3d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md @@ -3859,6 +3859,87 @@ notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => }); ``` +## notificationManager.on<sup>10+</sup> + +on(type: 'checkNotification', callback: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void; + +注册通知监å¬å›žè°ƒã€‚通知æœåŠ¡å°†é€šçŸ¥ä¿¡æ¯å›žè°ƒç»™æ ¡éªŒç¨‹åºï¼Œæ ¡éªŒç¨‹åºè¿”å›žæ ¡éªŒç»“æžœå†³å®šè¯¥é€šçŸ¥æ˜¯å¦å‘布,如è¥é”€ç±»é€šçŸ¥å‘布频率控制ç‰ã€‚ + +**系统能力**:SystemCapability.Notification.Notification + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**需è¦æƒé™**:ohos.permission.NOTIFICATION_CONTROLLER å’Œ ohos.permission.NOTIFICATION_AGENT_CONTROLLER + +**å‚数:** + +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| type | string | 是 | 回调函数类型å,固定为'checkNotification'。 | +| callback | (checkInfo: [NotificationCheckInfo]) => [NotificationCheckResult] | 是 | 消æ¯éªŒè¯å‡½æ•°æŒ‡é’ˆã€‚ | + +**错误ç :** + +错误ç 详细介ç»è¯·å‚考[errcode-notification](../errorcodes/errorcode-notification.md)。 + +| 错误ç ID | é”™è¯¯ä¿¡æ¯ | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | + +**示例:** + +```ts +try{ + notificationManager.on("checkNotification", OnCheckNotification); +} catch (error){ + console.info(`notificationManager.on error: ${JSON.stringify(error)}`); +} +function OnCheckNotification(info : notificationManager.NotificationCheckInfo) { + console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`); + if(info.notificationId == 1){ + return { code: 1, message: "testMsg1"} + } else { + return { code: 0, message: "testMsg0"} + } +} +``` + +## notificationManager.off<sup>10+</sup> + +off(type: 'checkNotification', callback?: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void; + +å–消通知监å¬å›žè°ƒã€‚ + +**系统能力**:SystemCapability.Notification.Notification + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**需è¦æƒé™**:ohos.permission.NOTIFICATION_CONTROLLER å’Œ ohos.permission.NOTIFICATION_AGENT_CONTROLLER + +**å‚数:** + +| å‚æ•°å | 类型 | å¿…å¡« | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| type | string | 是 | 回调函数类型å,固定为'checkNotification'。 | +| callback | (checkInfo: [NotificationCheckInfo]) => [NotificationCheckResult] | 是 | 消æ¯éªŒè¯å‡½æ•°æŒ‡é’ˆã€‚ | + +**错误ç :** + +错误ç 详细介ç»è¯·å‚考[errcode-notification](../errorcodes/errorcode-notification.md)。 + +| 错误ç ID | é”™è¯¯ä¿¡æ¯ | +| -------- | ----------------------------------- | +| 1600001 | Internal error. | + +**示例:** + +```ts +try{ + notificationManager.off("checkNotification"); +} catch (error){ + console.info(`notificationManager.off error: ${JSON.stringify(error)}`); +} +``` ## DoNotDisturbDate @@ -3866,11 +3947,11 @@ notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => **系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ -| å称 | 类型 | å¯è¯» | å¯å†™ | 说明 | +| å称 | 类型 | åªè¯» | å¿…å¡« | 说明 | | ----- | ------------------------------------- | ---- | ---- | ---------------------- | -| type | [DoNotDisturbType](#donotdisturbtype) | 是 | 是 | å…打扰设置的时间类型。 | -| begin | Date | 是 | 是 | å…打扰设置的起点时间。 | -| end | Date | 是 | 是 | å…打扰设置的终点时间。 | +| type | [DoNotDisturbType](#donotdisturbtype) | å¦ | 是 | å…打扰设置的时间类型。 | +| begin | Date | å¦ | 是 | å…打扰设置的起点时间。 | +| end | Date | å¦ | 是 | å…打扰设置的终点时间。 | ## DoNotDisturbType @@ -3951,3 +4032,30 @@ notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => | TYPE_NORMAL | 0 | 一般通知。 | | TYPE_CONTINUOUS | 1 | è¿žç»é€šçŸ¥ã€‚ | | TYPE_TIMER | 2 | 计划通知。 | + +## NotificationCheckInfo<sup>10+</sup> + +**系统能力**:SystemCapability.Notification.Notification + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**需è¦æƒé™**:ohos.permission.NOTIFICATION_CONTROLLER å’Œ ohos.permission.NOTIFICATION_AGENT_CONTROLLER + +| å称 | 类型 | åªè¯» | å¿…å¡« | 说明 | +| ----- | ------------------------------------- | ---- | ---- | ---------------------- | +| bundleName | string | å¦ | 是 | bundleå称。 | +| notificationId | number | å¦ | 是 | 通知Id。 | +| contentType | [ContentType](#contenttype) | å¦ | 是 | 通知类型。 | + +## NotificationCheckResult<sup>10+</sup> + +**系统能力**:SystemCapability.Notification.Notification + +**系统API**:æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**需è¦æƒé™**:ohos.permission.NOTIFICATION_CONTROLLER å’Œ ohos.permission.NOTIFICATION_AGENT_CONTROLLER + +| å称 | 类型 | åªè¯» | å¿…å¡« | 说明 | +| ----- | ------------------------------------- | ---- | ---- | ---------------------- | +| code | number | å¦ | 是 | 0-display, 1-no display。 | +| message | string | å¦ | 是 | 结果信æ¯ã€‚ | 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 b1f00680221450e5dd876066b1226cd5d199cec0..d9fa2020c727d956af5bf05d9ed9a1c4683f3ce2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md @@ -272,7 +272,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | --------------- | ----------------------------------| ---- | -------------------- | | bundle | [BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是 | 指定应用的包信æ¯ã€‚ | -| notificationKey | [NotificationKey](js-apis-notification.md#notificationkey) | 是 | 通知键值。 | +| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason) | 是 | é€šçŸ¥åˆ é™¤åŽŸå› ã€‚ | | callback | AsyncCallback\<void\> | 是 | åˆ é™¤æŒ‡å®šé€šçŸ¥å›žè°ƒå‡½æ•°ã€‚ | @@ -328,7 +328,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | --------------- | --------------- | ---- | ---------- | | bundle | [BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是 | 指定应用的包信æ¯ã€‚ | -| notificationKey | [NotificationKey]((js-apis-notification.md#notificationkey)) | 是 | 通知键值。 | +| notificationKey | [NotificationKey](#notificationkey) | 是 | 通知键值。 | | reason | [RemoveReason](#removereason) | 是 | é€šçŸ¥åˆ é™¤åŽŸå› ã€‚ | **错误ç :** @@ -618,7 +618,7 @@ let userId = 1; notificationSubscribe.removeAll(userId, removeAllCallback); ``` -## Notification.removeAll +## NotificationSubscribe.removeAll removeAll(userId: number): Promise\<void> @@ -663,6 +663,15 @@ let userId = 1; notificationSubscribe.removeAll(userId, removeAllCallback); ``` +## NotificationKey + +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.Notification.Notification + +| å称 | 类型 | åªè¯» | å¿…å¡« | 说明 | +| ----- | ------ | ---- | --- | -------- | +| id | number | å¦ | 是 | 通知ID。 | +| label | string | å¦ | å¦ | é€šçŸ¥æ ‡ç¾ã€‚ | + ## RemoveReason **系统能力**:SystemCapability.Notification.Notification