Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 69d8e1da 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1031 Update js api notification interface 

Merge pull request !1031 from blackleon/master_1225_docs
上级 c2f2b4b7 a5017c30
显示空白变更内容
内联 并排
Showing with 3218 addition and 1674 deletion
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ 69d8e1da
...@@ -4,74 +4,84 @@ ...@@ -4,74 +4,84 @@
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- |
| Notification.publish(request: NotificationRequest, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.publish(request: NotificationRequest) | 支持 | 支持 | 支持 | 支持 | | Notification.publish(request: NotificationRequest) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, label: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id：number, label？：string） | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id：number, label?：string） | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id: number, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll(callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancelAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll() | 支持 | 支持 | 支持 | 支持 | | Notification.cancelAll() | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(type: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array<NotificationSlot>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlots(slots: Array\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots(callback: AsyncCallback<Array<NotificationSlot>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots() | 支持 | 支持 | 支持 | 支持 | | Notification.getSlots() | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.removeSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(callback: AsyncCallback<void>): void | 支持 | 支持 | 支持 | 支持 | | Notification.removeAllSlots(callback: AsyncCallback\<void\>): void | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(): Promise<void> | 支持 | 支持 | 支持 | 支持 | | Notification.removeAllSlots(): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber) | 支持 | 支持 | 支持 | 支持 | | Notification.unsubscribe(subscriber: NotificationSubscriber) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 | | Notification.enableNotification(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled() | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled() | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 | | Notification.displayBadge(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.isBadgeDisplayed(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 | | Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotsByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotNumByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(hashCode: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(hashCode: string) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle: BundleOption, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle?: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(bundle?: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications() | 支持 | 支持 | 支持 | 支持 | | Notification.getAllActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount(callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount() | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotificationCount() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications() | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo): Promise<WantAgent> | 支持 | 支持 | 支持 | 支持 | | Notification.cancelGroup(groupName: string) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback<string>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent): Promise<string> | 支持 | 支持 | 支持 | 支持 | | Notification.removeGroupByBundle(bundle: BundleOption, groupName: string) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent, callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent): Promise<number> | 支持 | 支持 | 支持 | 支持 | | Notification.setDoNotDisturbDate(date: DoNotDisturbDate) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent, callback: AsyncCallback<Want>) | 支持 | 支持 | 支持 | 支持 | | Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent): Promise<Want> | 支持 | 支持 | 支持 | 支持 | | Notification.getDoNotDisturbDate() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent): Promise<void> | 支持 | 支持 | 支持 | 支持 | | Notification.supportDoNotDisturbMode() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>) | 支持 | 支持 | 支持 | 支持 | | WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean> | 支持 | 支持 | 支持 | 支持 | | WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent): Promise\<string\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent): Promise\<number\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent): Promise\<Want\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | 支持 | 支持 | 支持 | 支持 |
#### 权限列表 #### 权限列表
...@@ -85,7 +95,7 @@ ...@@ -85,7 +95,7 @@
import notify from '@ohos.notification'; import notify from '@ohos.notification';
``` ```
#### Notification.publish(request: NotificationRequest, callback: AsyncCallback<void>) #### Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -95,14 +105,14 @@ import notify from '@ohos.notification'; ...@@ -95,14 +105,14 @@ import notify from '@ohos.notification';
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | ------------------------------------------- | | -------- | -------- | --------------------- | ---- | ------------------------------------------- |
| request | 只读 | NotificationRequest | 是 | 设置要发布通知内容的NotificationRequest对象 | | request | 只读 | NotificationRequest | 是 | 设置要发布通知内容的NotificationRequest对象 |
| callback | 只读 | AsyncCallback<void> | 是 | 被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 被指定的回调方法 |
- NotificationRequest类型说明 - NotificationRequest类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------------- | -------- | ------------------------------- | ---- | -------------------------- | | ----------------- | -------- | --------------------------------- | ---- | -------------------------- |
| content | 读、写 | NotificationContent | 是 | 通知内容 | | content | 读、写 | NotificationContent | 是 | 通知内容 |
| id | 读、写 | number | 否 | 通知ID | | id | 读、写 | number | 否 | 通知ID |
| slotType | 读、写 | SlotType | 否 | 通道类型 | | slotType | 读、写 | SlotType | 否 | 通道类型 |
...@@ -119,11 +129,10 @@ import notify from '@ohos.notification'; ...@@ -119,11 +129,10 @@ import notify from '@ohos.notification';
| isStopwatch | 读、写 | boolean | 否 | 是否显示已用时间 | | isStopwatch | 读、写 | boolean | 否 | 是否显示已用时间 |
| isCountDown | 读、写 | boolean | 否 | 是否显示倒计时时间 | | isCountDown | 读、写 | boolean | 否 | 是否显示倒计时时间 |
| isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 | | isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 |
| isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 |
| label | 读、写 | string | 否 | 通知标签 | | label | 读、写 | string | 否 | 通知标签 |
| badgeIconStyle | 读、写 | number | 否 | 通知角标类型 | | badgeIconStyle | 读、写 | number | 否 | 通知角标类型 |
| showDeliveryTime | 读、写 | boolean | 否 | 是否显示分发时间 | | showDeliveryTime | 读、写 | boolean | 否 | 是否显示分发时间 |
| actionButtons | 读、写 | Array<NotificationActionButton> | 否 | 通知按钮，最多两个按钮 | | actionButtons | 读、写 | Array\<NotificationActionButton\> | 否 | 通知按钮，最多两个按钮 |
| smallIcon | 读、写 | PixelMap | 否 | 通知小图标 | | smallIcon | 读、写 | PixelMap | 否 | 通知小图标 |
| largeIcon | 读、写 | PixelMap | 否 | 通知大图标 | | largeIcon | 读、写 | PixelMap | 否 | 通知大图标 |
| creatorBundleName | 只读 | string | 否 | 创建通知的包名 | | creatorBundleName | 只读 | string | 否 | 创建通知的包名 |
...@@ -131,6 +140,7 @@ import notify from '@ohos.notification'; ...@@ -131,6 +140,7 @@ import notify from '@ohos.notification';
| creatorPid | 只读 | number | 否 | 创建通知的PID | | creatorPid | 只读 | number | 否 | 创建通知的PID |
| hashCode | 只读 | string | 否 | 通知唯一标识 | | hashCode | 只读 | string | 否 | 通知唯一标识 |
| classification | 读、写 | string | 否 | 通知分类 | | classification | 读、写 | string | 否 | 通知分类 |
| groupName | 读、写 | string | 否 | 组通知名称 |
NotificationContent类型说明 NotificationContent类型说明
...@@ -173,13 +183,13 @@ NotificationContent类型说明 ...@@ -173,13 +183,13 @@ NotificationContent类型说明
- NotificationMultiLineContent类型说明 - NotificationMultiLineContent类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------- | ---- | -------------------------------- | | -------------- | -------- | --------------- | ---- | -------------------------------- |
| title | 读、写 | string | 是 | 通知标题 | | title | 读、写 | string | 是 | 通知标题 |
| text | 读、写 | string | 是 | 通知内容 | | text | 读、写 | string | 是 | 通知内容 |
| additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 | | additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 |
| briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 | | briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 |
| longTitle | 读、写 | string | 是 | 通知展开时的标题 | | longTitle | 读、写 | string | 是 | 通知展开时的标题 |
| lines | 读、写 | Array<String> | 是 | 通知的多行文本 | | lines | 读、写 | Array\<String\> | 是 | 通知的多行文本 |
- NotificationPictureContent类型说明 - NotificationPictureContent类型说明
...@@ -195,15 +205,23 @@ NotificationContent类型说明 ...@@ -195,15 +205,23 @@ NotificationContent类型说明
- NotificationActionButton类型说明 - NotificationActionButton类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | -------------- | ---- | ------------------------- | | --------- | -------- | --------------------- | ---- | ------------------------- |
| title | 读、写 | string | 是 | 按钮标题 | | title | 读、写 | string | 是 | 按钮标题 |
| wantAgent | 读、写 | wantAgent | 是 | 点击按钮时触发的WantAgent | | wantAgent | 读、写 | wantAgent | 是 | 点击按钮时触发的WantAgent |
| extras | 读、写 | Array<String> | 否 | 按钮扩展信息 | | extras | 读、写 | Array\<String\> | 否 | 按钮扩展信息 |
| icon | 读、写 | image.PixelMap | 否 | 按钮图标 | | icon | 读、写 | image.PixelMap | 否 | 按钮图标 |
| userInput | 读、写 | NotificationUserInput | 否 | 用户输入对象实例 |
- NotificationUserInput类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------ | ---- | ----------------------------- |
| inputKey | 读、写 | string | 是 | 用户输入时用于标识此输入的key |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -237,7 +255,7 @@ Notification.publish(notificationRequest, publishCallback) ...@@ -237,7 +255,7 @@ Notification.publish(notificationRequest, publishCallback)
- 返回值 - 返回值
返回值为Promise<**void**> Promise\<void\>
- 示例 - 示例
...@@ -262,7 +280,7 @@ Notification.publish(notificationRequest).then((void) => { ...@@ -262,7 +280,7 @@ Notification.publish(notificationRequest).then((void) => {
#### Notification.cancel(id: number, label: string, callback: AsyncCallback<void>) #### Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -270,15 +288,15 @@ Notification.publish(notificationRequest).then((void) => { ...@@ -270,15 +288,15 @@ Notification.publish(notificationRequest).then((void) => {
- cancel参数描述 - cancel参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | | -------- | -------- | --------------------- | ---- | -------------------- |
| id | 只读 | number | 是 | 通知ID | | id | 只读 | number | 是 | 通知ID |
| lable | 只读 | string | 是 | 通知标签 | | lable | 只读 | string | 是 | 通知标签 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -300,14 +318,14 @@ Notification.cancel(0, "label", cancelCallback) ...@@ -300,14 +318,14 @@ Notification.cancel(0, "label", cancelCallback)
- cancel参数描述 - cancel参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------ | ---- | -------- | | ----- | -------- | ------ | ---- | -------- |
| id | 只读 | number | 是 | 通知ID | | id | 只读 | number | 是 | 通知ID |
| lable | 只读 | string | 是 | 通知标签 | | lable | 只读 | string | 是 | 通知标签 |
- 返回值 - 返回值
返回值为Promise<**void**> Promise\<void\>
- 示例 - 示例
...@@ -319,7 +337,7 @@ Notification.cancel(0).then((void) => { ...@@ -319,7 +337,7 @@ Notification.cancel(0).then((void) => {
#### Notification.cancel(id: number, callback: AsyncCallback<void>) #### Notification.cancel(id: number, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -327,14 +345,14 @@ Notification.cancel(0).then((void) => { ...@@ -327,14 +345,14 @@ Notification.cancel(0).then((void) => {
- cancel参数描述 - cancel参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | | -------- | -------- | --------------------- | ---- | -------------------- |
| id | 只读 | number | 是 | 通知ID | | id | 只读 | number | 是 | 通知ID |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -348,7 +366,7 @@ Notification.cancel(0, cancelCallback) ...@@ -348,7 +366,7 @@ Notification.cancel(0, cancelCallback)
#### Notification.cancelAll(callback: AsyncCallback<void>) #### Notification.cancelAll(callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -356,13 +374,13 @@ Notification.cancel(0, cancelCallback) ...@@ -356,13 +374,13 @@ Notification.cancel(0, cancelCallback)
- cancelAll参数描述 - cancelAll参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | | -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -388,7 +406,7 @@ Notification.cancelAll(cancelCallback) ...@@ -388,7 +406,7 @@ Notification.cancelAll(cancelCallback)
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -398,7 +416,89 @@ Notification.cancelAll().then((void) => { ...@@ -398,7 +416,89 @@ Notification.cancelAll().then((void) => {
}); });
``` ```
#### Notification.addSlot(type: SlotType, callback: AsyncCallback<void>)
#### Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>)
- 接口说明
创建通知通道（callback形式)
- addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------------------------ |
| slot | 只读 | NotificationSlot | 是 | 要创建的通知通道，由{NotificationSlot}设置 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- NotificationSlot类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------------- | -------- | --------------- | ---- | ------------------------------------------ |
| type | 读、写 | SlotType | 是 | 通道类型 |
| level | 读、写 | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值 |
| desc | 读、写 | string | 否 | 通知渠道描述信息 |
| badgeFlag | 读、写 | boolean | 否 | 是否显示角标 |
| bypassDnd | 读、写 | boolean | 否 | 置是否在系统中绕过免打扰模式 |
| lockscreenVisibility | 读、写 | boolean | 否 | 在锁定屏幕上显示通知的模式 |
| vibrationEnabled | 读、写 | boolean | 否 | 是否可振动 |
| sound | 读、写 | string | 否 | 通知提示音 |
| lightEnabled | 读、写 | boolean | 否 | 是否闪灯 |
| lightColor | 读、写 | number | 否 | 通知灯颜色 |
| vibrationValues | 读、写 | Array\<number\> | 否 | 通知振动样式 |
* 返回值
void
* 示例
```js
//addslot回调
function addSlotCallBack(err) {
console.info("==========================>addSlotCallBack=======================>");
}
//通知slot对象
var notificationSlot = {
type:SOCIAL_COMMUNICATION
}
Notification.addSlot(notificationSlot, addSlotCallBack)
```
#### Notification.addSlot(slot: NotificationSlot)
- 接口说明
创建通知通道（Promise形式)
- addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ---------------- | ---- | ------------------------------------------ |
| slot | 只读 | NotificationSlot | 是 | 要创建的通知通道，由{NotificationSlot}设置 |
- 返回值
Promise\<void\>
- 示例
```js
//通知slot对象
var notificationSlot = {
notificationId: 0,
type:SOCIAL_COMMUNICATION
}
Notification.addSlot(notificationSlot).then((void) => {
console.info("==========================>addSlotCallback=======================>");
});
```
#### Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -406,10 +506,10 @@ Notification.cancelAll().then((void) => { ...@@ -406,10 +506,10 @@ Notification.cancelAll().then((void) => {
- addSlot参数描述 - addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | ---------------------- | | -------- | -------- | --------------------- | ---- | ---------------------- |
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 | | type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- SlotType类型说明 - SlotType类型说明
...@@ -420,11 +520,11 @@ Notification.cancelAll().then((void) => { ...@@ -420,11 +520,11 @@ Notification.cancelAll().then((void) => {
| CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 | | CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 |
| OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 | | OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 |
* 返回值 - 返回值
返回值为void void
* 示例 - 示例
```js ```js
//addslot回调 //addslot回调
...@@ -444,13 +544,13 @@ Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack) ...@@ -444,13 +544,13 @@ Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack)
- addSlot参数描述 - addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | -------- | ---- | ---------------------- | | ---- | -------- | -------- | ---- | ---------------------- |
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 | | type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
- 返回值 - 返回值
返回值为Promise<**void**> Promise\<void\>
- 示例 - 示例
...@@ -460,7 +560,82 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => { ...@@ -460,7 +560,82 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => {
}); });
``` ```
#### Notification.getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>)
#### Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>)
- 接口说明
创建多个通知通道（callback形式)
- addSlots数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ------------------------------------------ |
| slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道，由{NotificationSlot}设置 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值
void
- 示例
```js
//addSlots回调
function addSlotsCallBack(err) {
console.info("==========================>addSlotsCallBack=======================>");
}
//通知slot对象
var notificationSlot = {
notificationId: 0,
type:SOCIAL_COMMUNICATION
}
//通知slot array 对象
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray, addSlotsCallBack)
```
#### Notification.addSlots(slots: Array\<NotificationSlot\>)
- 接口说明
创建多个通知通道（Promise形式)
- addSlots数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------------------------- | ---- | ------------------------------------------ |
| slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道，由{NotificationSlot}设置 |
- 返回值
Promise\<void\>
- 示例
```js
//通知slot对象
var notificationSlot = {
notificationId: 0,
type:SOCIAL_COMMUNICATION
}
//通知slot array 对象
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray).then((void) => {
console.info("==========================>addSlotCallback=======================>");
});
```
#### Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>)
- 接口说明 - 接口说明
...@@ -468,14 +643,14 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => { ...@@ -468,14 +643,14 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => {
- getSlot参数描述 - getSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------- | ---- | ----------------------------------------------------------- | | -------- | -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
| slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | | slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读 | AsyncCallback<NotificationSlot> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<NotificationSlot\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -496,17 +671,17 @@ Notification.getSlot(slotType, getSlotCallback) ...@@ -496,17 +671,17 @@ Notification.getSlot(slotType, getSlotCallback)
获取一个通知通道（Promise形式) 获取一个通知通道（Promise形式)
* getSlot参数描述 - getSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- | | -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | | slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
* 返回值 - 返回值
返回值为Promise<NotificationSlot> Promise\<NotificationSlot\>
* 示例 - 示例
```js ```js
var slotType = SOCIAL_COMMUNICATION; var slotType = SOCIAL_COMMUNICATION;
...@@ -516,7 +691,7 @@ Notification.getSlot(slotType).then((data) => { ...@@ -516,7 +691,7 @@ Notification.getSlot(slotType).then((data) => {
#### Notification.getSlots(callback: AsyncCallback<Array<NotificationSlot>>) #### Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>)
- 接口说明 - 接口说明
...@@ -524,13 +699,13 @@ Notification.getSlot(slotType).then((data) => { ...@@ -524,13 +699,13 @@ Notification.getSlot(slotType).then((data) => {
- getSlots参数描述 - getSlots参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------- | ---- | -------------------- | | -------- | -------- | --------------------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback<NotificationSlot> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<NotificationSlot\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
返回值为void void
- 示例 - 示例
...@@ -556,7 +731,7 @@ Notification.getSlots(getSlotsCallback) ...@@ -556,7 +731,7 @@ Notification.getSlots(getSlotsCallback)
- 返回值 - 返回值
返回值为Promise<Array<NotificationSlot>> Promise\<Array\<NotificationSlot\>\>
- 示例 - 示例
...@@ -567,7 +742,7 @@ Notification.getSlots().then((data) => { ...@@ -567,7 +742,7 @@ Notification.getSlots().then((data) => {
#### Notification.removeSlot(slotType: SlotType, callback: AsyncCallback<void>) #### Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -575,14 +750,14 @@ Notification.getSlots().then((data) => { ...@@ -575,14 +750,14 @@ Notification.getSlots().then((data) => {
- removeSlot参数描述 - removeSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | ----------------------------------------------------------- | | -------- | -------- | --------------------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | | SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- - 返回值
返回值为void void
- 示例 - 示例
...@@ -605,13 +780,13 @@ Notification.removeSlot(slotType,removeSlotCallback) ...@@ -605,13 +780,13 @@ Notification.removeSlot(slotType,removeSlotCallback)
- removeSlot参数描述 - removeSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- | | -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | | SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
- - 返回值
返回值为Promise<**void**> Promise\<void\>
- 示例 - 示例
...@@ -623,207 +798,1451 @@ Notification.removeSlot(slotType).then((void) => { ...@@ -623,207 +798,1451 @@ Notification.removeSlot(slotType).then((void) => {
#### Notification.removeAllSlots(callback: AsyncCallback<void>) #### Notification.removeAllSlots(callback: AsyncCallback\<void\>)
- 接口说明
删除所有通知通道（callback形式)
- removeAllSlots参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值
void
- 示例
```js
function removeAllCallBack(err) {
console.info("================>removeAllCallBack=======================>");
}
Notification.removeAllSlots(removeAllCallBack)
```
#### Notification.removeAllSlots()
- 接口说明
删除所有通知通道（Promise形式)
- removeAllSlots参数描述
参数无
- 返回值
Promise\<void\>
- 示例
```js
Notification.removeAllSlots().then((void) => {
console.info("==========================>removeAllCallBack=======================>");
});
```
#### Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>)
- 接口说明
订阅通知并指定订阅信息（callback形式)
- subscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------------------- | ---- | ---------------- |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| info | 只读 | NotificationSubscribeInfo | 是 | 订阅信息 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 订阅动作回调函数 |
- NotificationSubscriber类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------------------------------------------------ | -------- | -------- | ---- | -------------------------- |
| onConsume?:(data: SubscribeCallbackData) | 读、写 | function | 否 | 接收通知回调函数 |
| onCancel?:(data: SubscribeCallbackData) | 读、写 | function | 否 | 删除通知回调函数 |
| onUpdate?:(data: NotificationSortingMap) | 读、写 | function | 否 | 更新通知排序回调函数 |
| onConnect?:() | 读、写 | function | 否 | 注册订阅回调函数 |
| onDisconnect?:() | 读、写 | function | 否 | 取消订阅回调函数 |
| onDestroy?:() | 读、写 | function | 否 | 服务失联回调函数 |
| onDisturbModeChange?:(mode: notification.DoNotDisturbMode) | 读、写 | function | 否 | 免打扰模式变更回调函数 |
| onDoNotDisturbDateChange?:(mode: notification.DoNotDisturbDate) | 读、写 | function | 否 | 免打扰时间选项变更回调函数 |
- SubscribeCallbackData 类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | ---------------------- | ---- | -------- |
| request | 只读 | NotificationRequest | 是 | 通知内容 |
| sortingMap | 只读 | NotificationSortingMap | 否 | 排序信息 |
| reason | 只读 | number | 否 | 删除原因 |
| sound | 只读 | string | 否 | 通知声音 |
| vibrationValues | 只读 | Array\<number\> | 否 | 通知震动 |
- NotificationSortingMap类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------------------------------ | ---- | ---------------- |
| sortings | 只读 | {[key: string]: NotificationSorting} | 是 | 通知排序信息数组 |
| sortedHashCode | 只读 | Array\<string\> | 是 | 通知唯一标识数组 |
- NotificationSorting 类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------- | ---- | ------------ |
| slot | 只读 | NotificationSlot | 是 | 通知通道内容 |
| hashCode | 只读 | string | 是 | 通知唯一标识 |
| ranking | 只读 | number | 是 | 通知排序序号 |
- DoNotDisturbMode类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ---------------- | ---- | ---------------------------- |
| ALLOW_ALL | 只读 | DoNotDisturbMode | 否 | 全部绕过免打扰 |
| ALLOW_PRIORITY | 只读 | DoNotDisturbMode | 否 | 指定优先级通知可以绕过免打扰 |
| ALLOW_NONE | 只读 | DoNotDisturbMode | 否 | 全部免打扰 |
| ALLOW_ALARMS | 只读 | DoNotDisturbMode | 否 | 闹钟类型通知可以绕过免打扰 |
- DoNotDisturbType类型说明
| 名称 | 读写属性 | 类型 | 描述 |
| ------------ | -------- | --------------------- | ---------------------------------------- |
| TYPE_NONE | 只读 | enum DoNotDisturbType | 非通知勿扰类型 |
| TYPE_ONCE | 只读 | enum DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰 |
| TYPE_DAILY | 只读 | enum DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰 |
| TYPE_CLEARLY | 只读 | enum DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰 |
- DoNotDisturbDate类型说明
| 名称 | 读写属性 | 类型 | 描述 |
| ----- | -------- | ---------------- | ------------------------ |
| type | 读写 | DoNotDisturbType | 指定免打扰设置的时间类型 |
| begin | 读写 | Date | 指定免打扰设置的起点时间 |
| end | 读写 | Date | 指定免打扰设置的终点时间 |
- NotificationSubscribeInfo类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | --------------- | ---- | ------------------------------- |
| bundleNames | 读、写 | Array\<string\> | 否 | 指定订阅哪些包名的APP发来的通知 |
| userId | 读、写 | number | 否 | 指定订阅哪个用户下发来的通知 |
- 返回值
void
- 示例
```js
//subscribe回调
function subscribeCallback(err) {
console.info("==========================>subscribeCallback=======================>");
}
function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
onConsume:onConsumeCallback;
}
var info = {
bundleNames:["bundleName1","bundleName2"]
}
Notification.subscribe(subscriber, info, subscribeCallback);
```
#### Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
- 接口说明
订阅通知并指定订阅信息（callback形式)
- subscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | ---------------- |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 订阅动作回调函数 |
- 返回值
void
- 示例
```js
function subscribeCallback(err) {
console.info("==========================>subscribeCallback=======================>");
}
function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
onConsume:onConsumeCallback;
}
Notification.subscribe(subscriber, subscribeCallback);
```
#### Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo)
- 接口说明
订阅通知并指定订阅信息（Promise形式)
- subscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------------------- | ---- | ------------ |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| info | 只读 | NotificationSubscribeInfo | 否 | 订阅信息 |
- 返回值
Promise\<void\>
- 示例
```js
function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
onConsume:onConsumeCallback;
};
Notification.subscribe(subscriber).then((void) => {
console.info("==========================>subscribeCallback=======================>");
});
```
#### Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
- 接口说明
取消订阅（callbcak形式)
- unsubscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | -------------------- |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 取消订阅动作回调函数 |
- 返回值
void
- 示例
```js
function unsubscribeCallback(err) {
console.info("==========================>unsubscribeCallback=======================>");
}
function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
onConsume:onConsumeCallback;
}
Notification.unsubscribe(subscriber, unsubscribeCallback);
```
#### Notification.unsubscribe(subscriber: NotificationSubscriber)
- 接口说明
取消订阅（Promise形式)
- unsubscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | ------------ |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
- 返回值
Promise\<void\>
- 示例
```js
function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
onConsume:onConsumeCallback;
};
Notification.unsubscribe(subscriber).then((void) => {
console.info("==========================>unsubscribeCallback=======================>");
});
```
#### Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
- 接口说明
设定指定包的通知使能状态（Callback形式)
- enableNotification参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设定通知使能回调函数 |
- BundleOption类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------ | ---- | ------ |
| bundle | 读/写 | string | 是 | 包名 |
| uid | 读/写 | number | 否 | 用户id |
- 返回值
void
- 示例
```js
function enableNotificationCallback(err) {
console.info("==========================>enableNotificationCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.enableNotification(bundle, false, enableNotificationCallback);
```
#### Notification.enableNotification(bundle: BundleOption, enable: boolean)
- 接口说明
设定指定包的通知使能状态（Promise形式)
- enableNotification参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
- 返回值
Promise\<void\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.enableNotification(bundle, false).then((void) => {
console.info("==========================>enableNotificationCallback=======================>");
});
```
#### Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
- 接口说明
获取指定包的通知使能状态（Callback形式)
- isNotificationEnabled参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数 |
- 返回值
void
- 示例
```js
function isNotificationEnabledCallback(err, data) {
console.info("==========================>isNotificationEnabledCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```
#### Notification.isNotificationEnabled(bundle: BundleOption)
- 接口说明
获取指定包的通知使能状态（Promise形式)
- isNotificationEnabled参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 返回值
Promise\<boolean\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.isNotificationEnabled(bundle).then((data) => {
console.info("==========================>isNotificationEnabledCallback=======================>");
});
```
#### Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>)
- 接口说明
获取通知使能状态（Callback形式)
- isNotificationEnabled参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| callback | 只读 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数 |
- 返回值
void
- 示例
```js
function isNotificationEnabledCallback(err, data) {
console.info("==========================>isNotificationEnabledCallback=======================>");
}
Notification.isNotificationEnabled(isNotificationEnabledCallback);
```
#### Notification.isNotificationEnabled()
- 接口说明
获取通知使能状态（Promise形式)
- isNotificationEnabled参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 返回值
Promise\<boolean\>
- 示例
```js
Notification.isNotificationEnabled().then((data) => {
console.info("==========================>isNotificationEnabledCallback=======================>");
});
```
#### Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
- 接口说明
设定指定包的角标使能状态（Callback形式)
- displayBadge参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设定角标使能回调函数 |
- 返回值
void
- 示例
```js
function displayBadgeCallback(err) {
console.info("==========================>displayBadgeCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.displayBadge(bundle, false, displayBadgeCallback);
```
#### Notification.displayBadge(bundle: BundleOption, enable: boolean)
- 接口说明
设定指定包的角标使能状态（Promise形式)
- displayBadge参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
- 返回值
Promise\<void\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.displayBadge(bundle, false).then((void) => {
console.info("==========================>displayBadgeCallback=======================>");
});
```
#### Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
- 接口说明
获取指定包的角标使能状态（Callback形式)
- isBadgeDisplayed参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 获取角标使能状态回调函数 |
- 返回值
void
- 示例
```js
function isBadgeDisplayedCallback(err, data) {
console.info("==========================>isBadgeDisplayedCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
```
#### Notification.isBadgeDisplayed(bundle: BundleOption)
- 接口说明
获取指定包的角标使能状态（Promise形式)
- isBadgeDisplayed参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 返回值
Promise\<boolean\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.isBadgeDisplayed(bundle).then((data) => {
console.info("==========================>isBadgeDisplayedCallback=======================>");
});
```
#### Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>)
- 接口说明
设定指定包的通知通道状态（Callback形式)
- setSlotByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| slot | 只读 | NotificationSlot | 是 | 通知通道 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设定通知通道回调函数 |
- 返回值
void
- 示例
```js
function setSlotByBundleCallback(err) {
console.info("==========================>setSlotByBundleCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
var notificationSlot = {
type:SOCIAL_COMMUNICATION
}
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```
#### Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot)
- 接口说明
设定指定包的角标使能状态（Promise形式)
- setSlotByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
- 返回值
Promise\<void\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
var notificationSlot = {
type:SOCIAL_COMMUNICATION
}
Notification.displayBadge(bundle, notificationSlot).then((void) => {
console.info("==========================>setSlotByBundleCallback=======================>");
});
```
#### Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>)
- 接口说明
获取指定包的通知通道（Callback形式)
- getSlotsByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback<Array\<NotificationSlot\>> | 是 | 获取通知通道回调函数 |
- 返回值
void
- 示例
```js
function getSlotsByBundleCallback(err, data) {
console.info("==========================>getSlotsByBundleCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```
#### Notification.getSlotsByBundle(bundle: BundleOption)
- 接口说明
获取指定包的通知通道（Promise形式)
- getSlotsByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 返回值
Promise<Array\<NotificationSlot\>>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.getSlotsByBundle(bundle).then((data) => {
console.info("==========================>getSlotsByBundleCallback=======================>");
});
```
#### Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>)
- 接口说明
获取指定包的通知通道数（Callback形式)
- getSlotNumByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ---------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback\<number\> | 是 | 获取通知通道数回调函数 |
- 返回值
void
- 示例
```js
function getSlotNumByBundle(err, data) {
console.info("==========================>getSlotNumByBundleCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```
#### Notification.getSlotNumByBundle(bundle: BundleOption)
- 接口说明
获取指定包的通知通道数（Promise形式)
- getSlotNumByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 返回值
Promise\<number\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
Notification.getSlotNumByBundle(bundle).then((data) => {
console.info("==========================>getSlotNumByBundleCallback=======================>");
});
```
#### Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>)
- 接口说明
删除指定通知（Callback形式)
- remove参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | --------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| notificationKey | 只读 | NotificationKey | 是 | 通知键值 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数 |
- NotificationKey类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------ | ---- | -------- |
| id | 读、写 | number | 是 | 通知ID |
| label | 读、写 | string | 否 | 通知标签 |
- 返回值
void
- 示例
```js
function removeCallback(err) {
console.info("==========================>removeCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
var notificationKey = {
id:0;
label:"label";
}
Notification.remove(bundle, notificationKey, removeCallback);
```
#### Notification.remove(bundle: BundleOption, notificationKey: NotificationKey)
- 接口说明
删除指定通知（Promise形式)
- remove参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | --------------- | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| notificationKey | 只读 | NotificationKey | 是 | 通知键值 |
- 返回值
Promise\<void\>
- 示例
```js
var bundle = {
bundle:"bundleName1";
}
var notificationKey = {
id:0;
label:"label";
}
Notification.remove(bundle, notificationKey).then((void) => {
console.info("==========================>removeCallback=======================>");
});
```
#### Notification.remove(hashCode: string, callback: AsyncCallback\<void\>)
- 接口说明
删除指定通知（Callback形式)
- remove参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| hashCode | 只读 | string | 是 | 通知唯一ID |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数 |
- 返回值
void
- 示例
```js
function removeCallback(err) {
console.info("==========================>removeCallback=======================>");
}
Notification.remove(hashCode, removeCallback);
```
#### Notification.remove(hashCode: string)
- 接口说明
删除指定通知（Promise形式)
- remove参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------- | ---- | ---------- |
| hashCode | 只读 | string | 是 | 通知唯一ID |
- 返回值
Promise\<void\>
- 示例
```js
Notification.remove(hashCode).then((void) => {
console.info("==========================>removeCallback=======================>");
});
```
#### Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>)
- 接口说明
删除指定包的所有通知（Callback形式)
- removeAll参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ---------------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定包的所有通知回调函数 |
- 返回值
void
- 示例
```js
function removeAllCallback(err) {
console.info("==========================>removeAllCallback=======================>");
}
var bundle = {
bundle:"bundleName1";
}
Notification.removeAll(bundle, removeAllCallback);
```
#### Notification.removeAll(callback: AsyncCallback\<void\>)
- 接口说明
删除所有通知（Callback形式)
- removeAll参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除所有通知回调函数 |
- 返回值
void
- 示例
```js
function removeAllCallback(err) {
console.info("==========================>removeAllCallback=======================>");
}
Notification.removeAll(removeAllCallback);
```
#### Notification.removeAll(bundle?: BundleOption)
- 接口说明
删除所有通知（Promise形式)
- removeAll参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 否 | 指定包信息 |
- 返回值
Promise\<void\>
- 示例
```js
Notification.removeAll().then((void) => {
console.info("==========================>removeAllCallback=======================>");
});
```
#### Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
- 接口说明
获取活动通知（Callback形式)
- getAllActiveNotifications参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback<Array\<NotificationRequest\>> | 是 | 获取活动通知回调函数 |
- 返回值
void
- 示例
```js
function getAllActiveNotificationsCallback(err, data) {
console.info("==========================>getAllActiveNotificationsCallback=======================>");
}
Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
```
#### Notification.getAllActiveNotifications()
- 接口说明
获取活动通知（Promise形式)
- getAllActiveNotifications参数描述
无
- 返回值
Promise\<Array\<NotificationRequest\>\>
- 示例
```js
Notification.getAllActiveNotifications().then((data) => {
console.info("==========================>getAllActiveNotificationsCallback=======================>");
});
```
#### Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>)
- 接口说明
获取当前应用的活动通知数（Callback形式)
- getActiveNotificationCount参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback\<number\> | 是 | 获取活动通知数回调函数 |
- 返回值
void
- 示例
```js
function getActiveNotificationCountCallback(err, data) {
console.info("==========================>getActiveNotificationCountCallback=======================>");
}
Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
```
#### Notification.getActiveNotificationCount()
- 接口说明
获取当前应用的活动通知数（Promise形式)
- getActiveNotificationCount参数描述
无
- 返回值
返回值为Promise\<number\>
- 示例
```js
Notification.getActiveNotificationCount().then((data) => {
console.info("==========================>getActiveNotificationCountCallback=======================>");
});
```
#### Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
- 接口说明
获取当前应用的活动通知（Callback形式)
- getActiveNotifications参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------------------- | ---- | ------------------------------ |
| callback | 只读 | AsyncCallback<Array\<NotificationRequest\>> | 是 | 获取当前应用的活动通知回调函数 |
- 返回值
void
- 示例
```js
function getActiveNotificationsCallback(err, data) {
console.info("==========================>getActiveNotificationsCallback=======================>");
}
Notification.getActiveNotifications(getActiveNotificationsCallback);
```
#### Notification.getActiveNotifications()
- 接口说明
获取当前应用的活动通知（Promise形式)
- getActiveNotifications参数描述
无
- 返回值
Promise\<Array\<NotificationRequest\>\>
- 示例
```js
Notification.getActiveNotifications().then((data) => {
console.info("==========================>getActiveNotificationsCallback=======================>");
});
```
#### Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>)
- 接口说明
取消本应用指定组通知（Callback形式)
- cancelGroup参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ---------------------------- |
| groupName | 只读 | string | 是 | 指定通知组名称 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 取消本应用指定组通知回调函数 |
- 返回值
void
- 示例
```js
function cancelGroupCallback(err) {
console.info("==========================>cancelGroupCallback=======================>");
}
var groupName = "GroupName";
Notification.cancelGroup(groupName, cancelGroupCallback);
```
#### Notification.cancelGroup(groupName: string)
- 接口说明
取消本应用指定组通知（Promise形式)
- cancelGroup参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------ | ---- | -------------- |
| groupName | 只读 | string | 是 | 指定通知组名称 |
- 返回值
Promise\<void\>
- 示例
```js
var groupName = "GroupName";
Notification.cancelGroup(groupName).then(() => {
console.info("==========================>cancelGroupPromise=======================>");
});
```
#### Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
删除所有通知通道（callback形式) 删除指定应用指定组通知（Callback形式)
- removeAllSlots参数描述 - removeGroupByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | | --------- | -------- | --------------------- | ---- | ---------------------------- |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | bundle | 只读 | BundleOption | 是 | 指定包信息 |
| groupName | 只读 | string | 是 | 指定通知组名称 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除本应用指定组通知回调函数 |
- - 返回值
返回值为void void
- 示例 - 示例
```js ```js
function removeAllCallBack(err) { function removeGroupByBundleCallback(err) {
console.info("================>removeAllCallBack=======================>"); console.info("==========================>removeGroupByBundleCallback=======================>");
} }
Notification.removeAllSlots(removeAllCallBack)
var bundleOption = {bundle:"Bundle"};
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
``` ```
#### Notification.removeAllSlots() #### Notification.removeGroupByBundle(bundle: BundleOption, groupName: string)
- 接口说明 - 接口说明
删除所有通知通道（Promise形式) 删除指定应用指定组通知（Promise形式)
- removeAllSlots参数描述 - removeGroupByBundle参数描述
参数无 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------ | ---- | -------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| groupName | 只读 | string | 是 | 指定通知组名称 |
- - 返回值
返回值为Promise<**void**> Promise\<void\>
- 示例 - 示例
```js ```js
var bundleOption = {bundle:"Bundle"};
Notification.removeAllSlots().then((void) => { var groupName = "GroupName";
console.info("==========================>removeAllCallBack=======================>"); Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("==========================>removeGroupByBundlePromise=======================>");
}); });
``` ```
#### Notification.getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>)
#### Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
获取活动通知（Callback形式) 设置免打扰时间（Callback形式)
- getAllActiveNotifications参数描述 - setDoNotDisturbDate参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------------------------- | ---- | -------------------- | | -------- | -------- | --------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback<Array<NotificationRequest>> | 是 | 获取活动通知回调函数 | | date | 只读 | DoNotDisturbDate | 是 | 免打扰时间选项 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设置免打扰时间回调函数 |
- - 返回值
返回值为void void
- 示例 - 示例
```js ```js
function getAllActiveNotificationsCallback(err, data) { function setDoNotDisturbDateCallback(err) {
console.info("==========================>getAllActiveNotificationsCallback=======================>"); console.info("==========================>setDoNotDisturbDateCallback=======================>");
} }
Notification.getAllActiveNotifications(getAllActiveNotificationsCallback); var doNotDisturbDate = {
type : notification.DoNotDisturbType.TYPE_ONCE,
begin : new Date(),
end : new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
``` ```
#### Notification.getAllActiveNotifications() #### Notification.setDoNotDisturbDate(date: DoNotDisturbDate)
- 接口说明 - 接口说明
获取活动通知（Promise形式) 设置免打扰时间接口（Promise形式)
- getAllActiveNotifications参数描述 - setDoNotDisturbDate参数描述
无 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ---------------- | ---- | -------------- |
| date | 只读 | DoNotDisturbDate | 是 | 免打扰时间选项 |
- - 返回值
返回值为Promise<Array<NotificationRequest>> Promise\<void\>
- 示例 - 示例
```js ```js
Notification.getAllActiveNotifications().then((data) => { var doNotDisturbDate = {
console.info("==========================>getAllActiveNotificationsCallback=======================>"); type : notification.DoNotDisturbType.TYPE_ONCE,
begin : new Date(),
end : new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("==========================>setDoNotDisturbDatePromise=======================>");
}); });
``` ```
#### Notification.getActiveNotificationCount(callback: AsyncCallback<**number**>) #### Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>)
- 接口说明 - 接口说明
获取当前应用的活动通知数（Callback形式) 查询免打扰时间接口（Callback形式)
- getActiveNotificationCount参数描述 - getDoNotDisturbDate参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ---------------------- | | -------- | -------- | --------------------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback<**number**> | 是 | 获取活动通知数回调函数 | | callback | 只读 | AsyncCallback\<DoNotDisturbDate\> | 是 | 查询免打扰时间回调函数 |
- - 返回值
返回值为void void
- 示例 - 示例
```js ```js
function getActiveNotificationCountCallback(err, data) { function getDoNotDisturbDateCallback(err,data) {
console.info("==========================>getActiveNotificationCountCallback=======================>"); console.info("==========================>getDoNotDisturbDateCallback=======================>");
} }
Notification.getActiveNotificationCount(getActiveNotificationCountCallback); Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
``` ```
#### Notification.getActiveNotificationCount() #### Notification.getDoNotDisturbDate()
- 接口说明 - 接口说明
获取当前应用的活动通知数（Promise形式) 查询免打扰时间接口（Promise形式)
- getActiveNotificationCount参数描述 - getDoNotDisturbDate参数描述
无 无
- - 返回值
返回值为Promise<**number**> Promise\<DoNotDisturbDate\>
- 示例 - 示例
```js ```js
Notification.getActiveNotificationCount().then((data) => { Notification.getDoNotDisturbDate().then((data) => {
console.info("==========================>getActiveNotificationCountCallback=======================>"); console.info("==========================>getDoNotDisturbDatePromise=======================>");
}); });
``` ```
#### Notification.getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) #### Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
获取当前应用的活动通知（Callback形式) 查询是否支持勿扰模式功能（Callback形式)
- getActiveNotifications参数描述 - supportDoNotDisturbMode参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------------------------- | ---- | ------------------------------ | | -------- | -------- | ------------------------ | ---- | -------------------------------- |
| callback | 只读 | AsyncCallback<Array<NotificationRequest>> | 是 | 获取当前应用的活动通知回调函数 | | callback | 只读 | AsyncCallback\<boolean\> | 是 | 查询是否支持勿扰模式功能回调函数 |
- - 返回值
返回值为void void
- 示例 - 示例
```js ```js
function getActiveNotificationsCallback(err, data) { function supportDoNotDisturbModeCallback(err,data) {
console.info("==========================>getActiveNotificationsCallback=======================>"); console.info("==========================>supportDoNotDisturbModeCallback=======================>");
} }
Notification.getActiveNotifications(getActiveNotificationsCallback); Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
``` ```
#### Notification.getActiveNotifications() #### Notification.supportDoNotDisturbMode()
- 接口说明 - 接口说明
获取当前应用的活动通知（Promise形式) 查询是否支持勿扰模式功能（Promise形式)
- getActiveNotifications参数描述 - supportDoNotDisturbMode参数描述
无 无
- - 返回值
返回值为Promise<Array<NotificationRequest>> Promise\<boolean\>
- 示例 - 示例
```js ```js
Notification.getActiveNotifications().then((data) => { Notification.supportDoNotDisturbMode().then((data) => {
console.info("==========================>getActiveNotificationsCallback=======================>"); console.info("==========================>supportDoNotDisturbModePromise=======================>");
}); });
``` ```
...@@ -837,7 +2256,7 @@ Notification.getActiveNotifications().then((data) => { ...@@ -837,7 +2256,7 @@ Notification.getActiveNotifications().then((data) => {
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
``` ```
#### WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>) #### WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>)
- 接口说明 - 接口说明
...@@ -847,15 +2266,15 @@ import WantAgent from '@ohos.wantAgent'; ...@@ -847,15 +2266,15 @@ import WantAgent from '@ohos.wantAgent';
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------ | ---- | ----------------------- | | -------- | -------- | -------------------------- | ---- | ----------------------- |
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 | | info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
| callback | 只读 | AsyncCallback<WantAgent> | 是 | 创建WantAgent的回调方法 | | callback | 只读 | AsyncCallback\<WantAgent\> | 是 | 创建WantAgent的回调方法 |
- WantAgentInfo类型说明 - WantAgentInfo类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------------------------- | ---- | ---------------------- | | -------------- | -------- | ------------------------------- | ---- | ---------------------- |
| wants | 读、写 | Array<Want> | 是 | 将被执行的动作列表 | | wants | 读、写 | Array\<Want\> | 是 | 将被执行的动作列表 |
| operationType | 读、写 | wantAgent.OperationType | 是 | 动作类型 | | operationType | 读、写 | wantAgent.OperationType | 是 | 动作类型 |
| requestCode | 读、写 | number | 是 | 使用者定义的一个私有值 | | requestCode | 读、写 | number | 是 | 使用者定义的一个私有值 |
| wantAgentFlags | 读、写 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性 | | wantAgentFlags | 读、写 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性 |
...@@ -888,9 +2307,9 @@ import WantAgent from '@ohos.wantAgent'; ...@@ -888,9 +2307,9 @@ import WantAgent from '@ohos.wantAgent';
| START_SERVICE | 只读 | enum | 否 | 开启一个无页面的ability | | START_SERVICE | 只读 | enum | 否 | 开启一个无页面的ability |
| SEND_COMMON_EVENT | 只读 | enum | 否 | 发送一个公共事件 | | SEND_COMMON_EVENT | 只读 | enum | 否 | 发送一个公共事件 |
- - 返回值
返回值为void void
- 示例 - 示例
...@@ -927,7 +2346,7 @@ var wantAgentInfo = { ...@@ -927,7 +2346,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
...@@ -935,7 +2354,7 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) ...@@ -935,7 +2354,7 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
#### WantAgent.getWantAgent(info: WantAgentInfo): Promise<WantAgent> #### WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
- 接口说明 - 接口说明
...@@ -948,9 +2367,9 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) ...@@ -948,9 +2367,9 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
| ---- | -------- | ------------- | ---- | ------------- | | ---- | -------- | ------------- | ---- | ------------- |
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 | | info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
- - 返回值
返回值为Promise<WantAgent> Promise\<WantAgent\>
- 示例 - 示例
...@@ -983,7 +2402,7 @@ var wantAgentInfo = { ...@@ -983,7 +2402,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { wantAgent.getWantAgent(wantAgentInfo).then((data) => {
...@@ -993,7 +2412,7 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -993,7 +2412,7 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => {
#### WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback<string>) #### WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>)
- 接口说明 - 接口说明
...@@ -1003,11 +2422,13 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -1003,11 +2422,13 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | --------------------------------- | | -------- | -------- | ----------------------- | ---- | --------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<string> | 是 | 获取WantAgent实例的包名的回调方法 | | callback | 只读 | AsyncCallback\<string\> | 是 | 获取WantAgent实例的包名的回调方法 |
- 返回值
- 返回值为void void
- 示例 - 示例
...@@ -1052,7 +2473,7 @@ var wantAgentInfo = { ...@@ -1052,7 +2473,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
...@@ -1066,7 +2487,7 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback) ...@@ -1066,7 +2487,7 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback)
#### WantAgent.getBundleName(agent: WantAgent): Promise<string> #### WantAgent.getBundleName(agent: WantAgent): Promise\<string\>
- 接口说明 - 接口说明
...@@ -1079,9 +2500,9 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback) ...@@ -1079,9 +2500,9 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback)
| ----- | -------- | --------- | ---- | ------------- | | ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
- - 返回值
返回值为Promise<string> Promise\<string\>
- 示例 - 示例
...@@ -1117,7 +2538,7 @@ var wantAgentInfo = { ...@@ -1117,7 +2538,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { wantAgent.getWantAgent(wantAgentInfo).then((data) => {
...@@ -1132,7 +2553,7 @@ wantAgent.getBundleName(WantAgent).then((data) => { ...@@ -1132,7 +2553,7 @@ wantAgent.getBundleName(WantAgent).then((data) => {
#### WantAgent.getUid(agent: WantAgent, callback: AsyncCallback<number>) #### WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>)
- 接口说明 - 接口说明
...@@ -1142,11 +2563,13 @@ wantAgent.getBundleName(WantAgent).then((data) => { ...@@ -1142,11 +2563,13 @@ wantAgent.getBundleName(WantAgent).then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ----------------------------------- | | -------- | -------- | ----------------------- | ---- | ----------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<number> | 是 | 获取WantAgent实例的用户ID的回调方法 | | callback | 只读 | AsyncCallback\<number\> | 是 | 获取WantAgent实例的用户ID的回调方法 |
- 返回值
- 返回值为void void
- 示例 - 示例
...@@ -1191,7 +2614,7 @@ var wantAgentInfo = { ...@@ -1191,7 +2614,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
...@@ -1205,7 +2628,7 @@ wantAgent.getUid(WantAgent, getUidCallback) ...@@ -1205,7 +2628,7 @@ wantAgent.getUid(WantAgent, getUidCallback)
#### WantAgent.getUid(agent: WantAgent): Promise<number> #### WantAgent.getUid(agent: WantAgent): Promise\<number\>
- 接口说明 - 接口说明
...@@ -1218,9 +2641,9 @@ wantAgent.getUid(WantAgent, getUidCallback) ...@@ -1218,9 +2641,9 @@ wantAgent.getUid(WantAgent, getUidCallback)
| ----- | -------- | --------- | ---- | ------------- | | ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
- - 返回值
返回值为Promise<number> Promise\<number\>
- 示例 - 示例
...@@ -1256,7 +2679,7 @@ var wantAgentInfo = { ...@@ -1256,7 +2679,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { wantAgent.getWantAgent(wantAgentInfo).then((data) => {
...@@ -1271,7 +2694,148 @@ wantAgent.getUid(WantAgent).then((data) => { ...@@ -1271,7 +2694,148 @@ wantAgent.getUid(WantAgent).then((data) => {
#### WantAgent.cancel(agent: WantAgent, callback: AsyncCallback<void>) #### WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>)
- 接口说明
获取WantAgent对象的want（callback形式）
- getWant参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<Want\> | 是 | 获取WantAgent对象want的回调方法 |
- 返回值
void
- 示例
```js
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent';
//wantAgent对象
var WantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
WantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentWantAgentFlags.UPDATE_PRESENT_FLAG]
}
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getWant回调
function getWantCallback(err, data) {
console.info("==========================>getWantCallback=======================>");
}
wantAgent.getWant(WantAgent, getWantCallback)
```
#### WantAgent.getWant(agent: WantAgent): Promise\<Want\>
- 接口说明
获取WantAgent对象的Uid（Promise形式）
- getWant参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<Want\>
- 示例
```js
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent';
//wantAgent对象
var WantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
wantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data;
});
wantAgent.getWant(WantAgent).then((data) => {
console.info("==========================>getWantCallback=======================>");
});
```
#### WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1281,11 +2845,13 @@ wantAgent.getUid(WantAgent).then((data) => { ...@@ -1281,11 +2845,13 @@ wantAgent.getUid(WantAgent).then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | --------------------------- | | -------- | -------- | --------------------- | ---- | --------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<void> | 是 | 取消WantAgent实例的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 取消WantAgent实例的回调方法 |
- 返回值
- 返回值为void void
- 示例 - 示例
...@@ -1330,7 +2896,7 @@ var wantAgentInfo = { ...@@ -1330,7 +2896,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
...@@ -1344,7 +2910,7 @@ wantAgent.cancel(WantAgent, cancelCallback) ...@@ -1344,7 +2910,7 @@ wantAgent.cancel(WantAgent, cancelCallback)
#### WantAgent.cancel(agent: WantAgent): Promise<void> #### WantAgent.cancel(agent: WantAgent): Promise\<void\>
- 接口说明 - 接口说明
...@@ -1357,9 +2923,9 @@ wantAgent.cancel(WantAgent, cancelCallback) ...@@ -1357,9 +2923,9 @@ wantAgent.cancel(WantAgent, cancelCallback)
| ----- | -------- | --------- | ---- | ------------- | | ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
- - 返回值
返回值为Promise<void> Promise\<void\>
- 示例 - 示例
...@@ -1395,7 +2961,7 @@ var wantAgentInfo = { ...@@ -1395,7 +2961,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { wantAgent.getWantAgent(wantAgentInfo).then((data) => {
...@@ -1410,7 +2976,7 @@ wantAgent.cancel(WantAgent).then((data) => { ...@@ -1410,7 +2976,7 @@ wantAgent.cancel(WantAgent).then((data) => {
#### WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>) #### WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>)
- 接口说明 - 接口说明
...@@ -1420,10 +2986,10 @@ wantAgent.cancel(WantAgent).then((data) => { ...@@ -1420,10 +2986,10 @@ wantAgent.cancel(WantAgent).then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | --------------------------- | ---- | ------------------------------- | | ----------- | -------- | ----------------------------- | ---- | ------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| triggerInfo | 只读 | TriggerInfo | 是 | TriggerInfo对象 | | triggerInfo | 只读 | TriggerInfo | 是 | TriggerInfo对象 |
| callback | 只读 | AsyncCallback<CompleteData> | 是 | 主动激发WantAgent实例的回调方法 | | callback | 只读 | AsyncCallback\<CompleteData\> | 是 | 主动激发WantAgent实例的回调方法 |
- TriggerInfo类型说明 - TriggerInfo类型说明
...@@ -1434,7 +3000,10 @@ wantAgent.cancel(WantAgent).then((data) => { ...@@ -1434,7 +3000,10 @@ wantAgent.cancel(WantAgent).then((data) => {
| permission | 读、写 | string | 否 | 权限定义 | | permission | 读、写 | string | 否 | 权限定义 |
| extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 | | extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 |
- 返回值为void - 返回值
void
- 示例 - 示例
```js ```js
...@@ -1478,21 +3047,25 @@ var wantAgentInfo = { ...@@ -1478,21 +3047,25 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调 //trigger回调
function triggerCallback(err, data) { function triggerCallback(err, data) {
console.info("==========================>triggerCallback=======================>"); console.info("==========================>triggerCallback=======================>");
} }
wantAgent.trigger(WantAgent, triggerCallback)
var triggerInfo = {
code:0
}
wantAgent.trigger(WantAgent, triggerInfo, triggerCallback)
``` ```
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>) #### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -1502,12 +3075,14 @@ wantAgent.trigger(WantAgent, triggerCallback) ...@@ -1502,12 +3075,14 @@ wantAgent.trigger(WantAgent, triggerCallback)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | --------------------------------------- | | ---------- | -------- | ------------------------ | ---- | --------------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 | | otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<boolean> | 是 | 判断两个WantAgent实例是否相等的回调方法 | | callback | 只读 | AsyncCallback\<boolean\> | 是 | 判断两个WantAgent实例是否相等的回调方法 |
- 返回值为void - 返回值
void
- 示例 - 示例
...@@ -1554,12 +3129,12 @@ var wantAgentInfo = { ...@@ -1554,12 +3129,12 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调 //equal回调
function equalCallback(err, data) { function equalCallback(err, data) {
console.info("==========================>equalCallback=======================>"); console.info("==========================>equalCallback=======================>");
} }
...@@ -1568,7 +3143,7 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback) ...@@ -1568,7 +3143,7 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback)
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean> #### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
- 接口说明 - 接口说明
...@@ -1582,9 +3157,9 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback) ...@@ -1582,9 +3157,9 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback)
| agent | 只读 | WantAgent | 是 | WantAgent对象 | | agent | 只读 | WantAgent | 是 | WantAgent对象 |
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 | | otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
- - 返回值
返回值为Promise<boolean> Promise\<boolean\>
- 示例 - 示例
...@@ -1621,7 +3196,7 @@ var wantAgentInfo = { ...@@ -1621,7 +3196,7 @@ var wantAgentInfo = {
], ],
operationType: OperationType.START_ABILITIES, operationType: OperationType.START_ABILITIES,
requestCode: 0, requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { wantAgent.getWantAgent(wantAgentInfo).then((data) => {
...@@ -1641,34 +3216,3 @@ wantAgent.equal(WantAgent1, WantAgent2).then((data) => { ...@@ -1641,34 +3216,3 @@ wantAgent.equal(WantAgent1, WantAgent2).then((data) => {
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或