js-apis-notification.md 94.7 KB
Newer Older
X
xuchenghua09 已提交
1
# Notification模块
Z
zhaoyuan17 已提交
2

X
xuchenghua09 已提交
3
## 导入模块
Z
zhaoyuan17 已提交
4 5

```js
X
xuchenghua09 已提交
6
import Notification from '@ohos.notification';
Z
zhaoyuan17 已提交
7 8
```

X
xuchenghua09 已提交
9
## Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

- 接口说明

  发布通知(callback形式)

- publish参数描述


| 名称     | 读写属性 | 类型                  | 必填 | 描述                                        |
| -------- | -------- | --------------------- | ---- | ------------------------------------------- |
| request  | 只读     | NotificationRequest   | 是   | 设置要发布通知内容的NotificationRequest对象 |
| callback | 只读     | AsyncCallback\<void\> | 是   | 被指定的回调方法                            |

- NotificationRequest类型说明

Z
zengsiyu 已提交
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
| 名称                  | 读写属性 | 类型                                          | 必填 | 描述                       |
| --------------------- | -------- | --------------------------------------------- | ---- | -------------------------- |
| content               | 读、写   | NotificationContent                           | 是   | 通知内容                   |
| id                    | 读、写   | number                                        | 否   | 通知ID                     |
| slotType              | 读、写   | SlotType                                      | 否   | 通道类型                   |
| isOngoing             | 读、写   | boolean                                       | 否   | 是否进行时通知             |
| isUnremovable         | 读、写   | boolean                                       | 否   | 是否可移除                 |
| deliveryTime          | 读、写   | number                                        | 否   | 通知发送时间               |
| tapDismissed          | 读、写   | boolean                                       | 否   | 通知是否自动清除           |
| autoDeletedTime       | 读、写   | number                                        | 否   | 自动清除的时间             |
| wantAgent             | 读、写   | WantAgent                                     | 否   | 点击跳转的WantAgent        |
| extraInfo             | 读、写   | {[key: string]: any}                          | 否   | 扩展参数                   |
| color                 | 读、写   | number                                        | 否   | 通知背景颜色               |
| colorEnabled          | 读、写   | boolean                                       | 否   | 通知背景颜色是否使能       |
| isAlertOnce           | 读、写   | boolean                                       | 否   | 设置是否仅有一次此通知警报 |
| isStopwatch           | 读、写   | boolean                                       | 否   | 是否显示已用时间           |
| isCountDown           | 读、写   | boolean                                       | 否   | 是否显示倒计时时间         |
| isFloatingIcon        | 读、写   | boolean                                       | 否   | 是否显示状态栏图标         |
| label                 | 读、写   | string                                        | 否   | 通知标签                   |
| badgeIconStyle        | 读、写   | number                                        | 否   | 通知角标类型               |
| showDeliveryTime      | 读、写   | boolean                                       | 否   | 是否显示分发时间           |
| actionButtons         | 读、写   | Array\<NotificationActionButton\>             | 否   | 通知按钮,最多两个按钮     |
| smallIcon             | 读、写   | PixelMap                                      | 否   | 通知小图标                 |
| largeIcon             | 读、写   | PixelMap                                      | 否   | 通知大图标                 |
| creatorBundleName     | 只读     | string                                        | 否   | 创建通知的包名             |
| creatorUid            | 只读     | number                                        | 否   | 创建通知的UID              |
| creatorPid            | 只读     | number                                        | 否   | 创建通知的PID              |
| hashCode              | 只读     | string                                        | 否   | 通知唯一标识               |
| classification        | 读、写   | string                                        | 否   | 通知分类                   |
| groupName             | 读、写   | string                                        | 否   | 组通知名称                 |
| template<sup>8+</sup> | 读、写   | [NotificationTemplate](#notificationtemplate) | 否   | 通知模板                   |
Z
zhaoyuan17 已提交
56 57 58

NotificationContent类型说明

X
xuchenghua09 已提交
59 60 61 62 63 64 65
| 名称        | 读写属性 | 类型                         | 必填 | 描述               |
| ----------- | -------- | ---------------------------- | ---- | ------------------ |
| contentType | 读、写   | ContentType                  | 是   | 通知内容类型       |
| normal      | 读、写   | NotificationBasicContent     | 否   | 基本类型通知内容   |
| longText    | 读、写   | NotificationLongTextContent  | 否   | 长文本类型通知内容 |
| multiLine   | 读、写   | NotificationMultiLineContent | 否   | 多行类型通知内容   |
| picture     | 读、写   | NotificationPictureContent   | 否   | 图片类型通知内容   |
Z
zhaoyuan17 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117

- ContentType类型说明

| 名称                              | 读写属性 | 类型        | 描述             |
| --------------------------------- | -------- | ----------- | ---------------- |
| NOTIFICATION_CONTENT_BASIC_TEXT   | 只读     | ContentType | 普通类型通知     |
| NOTIFICATION_CONTENT_LONG_TEXT    | 只读     | ContentType | 长文本类型通知   |
| NOTIFICATION_CONTENT_PICTURE      | 只读     | ContentType | 图片类型通知     |
| NOTIFICATION_CONTENT_CONVERSATION | 只读     | ContentType | 社交类型通知     |
| NOTIFICATION_CONTENT_MULTILINE    | 只读     | ContentType | 多行文本类型通知 |

- NotificationBasicContent类型说明

| 名称           | 读写属性 | 类型   | 必填 | 描述                             |
| -------------- | -------- | ------ | ---- | -------------------------------- |
| title          | 读、写   | string | 是   | 通知标题                         |
| text           | 读、写   | string | 是   | 通知内容                         |
| additionalText | 读、写   | string | 是   | 通知次要内容,是对通知内容的补充 |

- NotificationLongTextContent类型说明

| 名称           | 读写属性 | 类型   | 必填 | 描述                             |
| -------------- | -------- | ------ | ---- | -------------------------------- |
| title          | 读、写   | string | 是   | 通知标题                         |
| text           | 读、写   | string | 是   | 通知内容                         |
| additionalText | 读、写   | string | 是   | 通知次要内容,是对通知内容的补充 |
| longText       | 读、写   | string | 是   | 通知的长文本                     |
| briefText      | 读、写   | string | 是   | 通知概要内容,是对通知内容的总结 |
| expandedTitle  | 读、写   | string | 是   | 通知展开时的标题                 |

- NotificationMultiLineContent类型说明

| 名称           | 读写属性 | 类型            | 必填 | 描述                             |
| -------------- | -------- | --------------- | ---- | -------------------------------- |
| title          | 读、写   | string          | 是   | 通知标题                         |
| text           | 读、写   | string          | 是   | 通知内容                         |
| additionalText | 读、写   | string          | 是   | 通知次要内容,是对通知内容的补充 |
| briefText      | 读、写   | string          | 是   | 通知概要内容,是对通知内容的总结 |
| longTitle      | 读、写   | string          | 是   | 通知展开时的标题                 |
| lines          | 读、写   | Array\<String\> | 是   | 通知的多行文本                   |

- NotificationPictureContent类型说明

| 名称           | 读写属性 | 类型           | 必填 | 描述                             |
| -------------- | -------- | -------------- | ---- | -------------------------------- |
| title          | 读、写   | string         | 是   | 通知标题                         |
| text           | 读、写   | string         | 是   | 通知内容                         |
| additionalText | 读、写   | string         | 是   | 通知次要内容,是对通知内容的补充 |
| briefText      | 读、写   | string         | 是   | 通知概要内容,是对通知内容的总结 |
| expandedTitle  | 读、写   | string         | 是   | 通知展开时的标题                 |
| picture        | 读、写   | image.PixelMap | 是   | 通知的图片内容                   |

X
xuchenghua09 已提交
118 119 120 121 122 123 124 125 126
- SlotType类型说明

| 名称                 | 读写属性 | 类型     | 必填 | 描述     |
| -------------------- | -------- | -------- | ---- | -------- |
| SOCIAL_COMMUNICATION | 只读     | SlotType | 否   | 社交类型 |
| SERVICE_INFORMATION  | 只读     | SlotType | 否   | 服务类型 |
| CONTENT_INFORMATION  | 只读     | SlotType | 否   | 内容类型 |
| OTHER_TYPES          | 只读     | SlotType | 否   | 其他类型 |

Z
zhaoyuan17 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
- NotificationActionButton类型说明

| 名称      | 读写属性 | 类型                  | 必填 | 描述                      |
| --------- | -------- | --------------------- | ---- | ------------------------- |
| title     | 读、写   | string                | 是   | 按钮标题                  |
| wantAgent | 读、写   | wantAgent             | 是   | 点击按钮时触发的WantAgent |
| extras    | 读、写   | Array\<String\>       | 否   | 按钮扩展信息              |
| icon      | 读、写   | image.PixelMap        | 否   | 按钮图标                  |
| userInput | 读、写   | NotificationUserInput | 否   | 用户输入对象实例          |

- NotificationUserInput类型说明

| 名称     | 读写属性 | 类型   | 必填 | 描述                          |
| -------- | -------- | ------ | ---- | ----------------------------- |
| inputKey | 读、写   | string | 是   | 用户输入时用于标识此输入的key |


- 返回值

  void

- 示例

```js
//publish回调
function publishCallback(err) {
	console.info("==========================>publishCallback=======================>");
}
//通知Request对象
var notificationRequest = {
    id: 1,
    content: {
        contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}
Notification.publish(notificationRequest, publishCallback)
```



X
xuchenghua09 已提交
172
## Notification.publish(request: NotificationRequest)
Z
zhaoyuan17 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

- 接口说明

  发布通知(Promise形式)

- 返回值

  Promise\<void\>

- 示例

```js
//通知Request对象
var notificationRequest = {
    notificationId: 1,
    content: {
        contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}
Notification.publish(notificationRequest).then((void) => {
	console.info("==========================>publishCallback=======================>");
});

```



X
xuchenghua09 已提交
205
## Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
206 207 208 209 210 211 212 213 214 215

- 接口说明

  取消与指定id和label相匹配的已发布通知(callback形式)

- cancel参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| id       | 只读     | number                | 是   | 通知ID               |
X
xuchenghua09 已提交
216
| label    | 只读     | string                | 是   | 通知标签             |
Z
zhaoyuan17 已提交
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法 |

- 返回值

  void

- 示例

```js
//cancel回调
function cancelCallback(err) {
	console.info("==========================>cancelCallback=======================>");
}
Notification.cancel(0, "label", cancelCallback)
```



X
xuchenghua09 已提交
235
## Notification.cancel(id:number, label?:string)
Z
zhaoyuan17 已提交
236 237 238 239 240 241 242 243 244 245

- 接口说明

  取消与指定id相匹配的已发布通知,label可以指定也可以不指定(Promise形式)

- cancel参数描述

| 名称  | 读写属性 | 类型   | 必填 | 描述     |
| ----- | -------- | ------ | ---- | -------- |
| id    | 只读     | number | 是   | 通知ID   |
X
xuchenghua09 已提交
246
| label | 只读     | string | 否   | 通知标签 |
Z
zhaoyuan17 已提交
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

- 返回值

  Promise\<void\>

- 示例

```js
Notification.cancel(0).then((void) => {
	console.info("==========================>cancelCallback=======================>");
});
```



X
xuchenghua09 已提交
262
## Notification.cancel(id: number, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

- 接口说明

  取消与指定id相匹配的已发布通知(callback形式)

- cancel参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| id       | 只读     | number                | 是   | 通知ID               |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法 |

- 返回值

  void

- 示例

```js
//cancel回调
function cancelCallback(err) {
	console.info("==========================>cancelCallback=======================>");
}
Notification.cancel(0, cancelCallback)
```



X
xuchenghua09 已提交
291
## Notification.cancelAll(callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318

- 接口说明

  取消所有已发布的通知(callback形式)

- cancelAll参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法 |

- 返回值

  void

- 示例

```js
//cancel回调
function cancelAllback(err) {
	console.info("==========================>cancelAllback=======================>");
}
Notification.cancelAll(cancelCallback)
```



X
xuchenghua09 已提交
319
## Notification.cancelAll()
Z
zhaoyuan17 已提交
320 321 322

- 接口说明

X
xuchenghua09 已提交
323
  取消所有已发布的通知(Promise形式)
Z
zhaoyuan17 已提交
324 325 326 327 328 329 330

- 参数描述

  无参数

- 返回值

X
xuchenghua09 已提交
331
  Promise\<void\>
Z
zhaoyuan17 已提交
332 333 334 335 336 337 338 339 340 341 342

- 示例

```js
Notification.cancelAll().then((void) => {
	console.info("==========================>cancelAllback=======================>");
});
```



X
xuchenghua09 已提交
343
## Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
344 345 346 347 348 349 350

- 接口说明

  创建通知通道(callback形式)

- addSlot参数描述

X
xuchenghua09 已提交
351 352 353 354
| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| slot     | 只读     | NotificationSlot      | 是   | 要创建的通知通道对象 |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法 |
Z
zhaoyuan17 已提交
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

- 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 = {
X
xuchenghua09 已提交
385
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
386 387 388 389 390 391
}
Notification.addSlot(notificationSlot, addSlotCallBack)
```



X
xuchenghua09 已提交
392
## Notification.addSlot(slot: NotificationSlot)
Z
zhaoyuan17 已提交
393 394 395 396 397 398 399

- 接口说明

  创建通知通道(Promise形式)

- addSlot参数描述

X
xuchenghua09 已提交
400 401 402
| 名称 | 读写属性 | 类型             | 必填 | 描述                 |
| ---- | -------- | ---------------- | ---- | -------------------- |
| slot | 只读     | NotificationSlot | 是   | 要创建的通知通道对象 |
Z
zhaoyuan17 已提交
403 404 405 406 407 408 409 410 411

- 返回值

  Promise\<void\>

- 示例

```js
//通知slot对象
X
xuchenghua09 已提交
412 413 414
var notificationSlot = {
    type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Z
zhaoyuan17 已提交
415 416 417 418 419 420 421
Notification.addSlot(notificationSlot).then((void) => {
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuchenghua09 已提交
422
## Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

- 接口说明

  创建通知通道(callback形式)

- addSlot参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                   |
| -------- | -------- | --------------------- | ---- | ---------------------- |
| type     | 只读     | SlotType              | 是   | 要创建的通知通道的类型 |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法   |

- 返回值

  void

- 示例

```js
//addslot回调
function addSlotCallBack(err) {
	console.info("==========================>addSlotCallBack=======================>");
}
X
xuchenghua09 已提交
446
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack)
Z
zhaoyuan17 已提交
447 448 449 450
```



X
xuchenghua09 已提交
451
## Notification.addSlot(type: SlotType)
Z
zhaoyuan17 已提交
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

- 接口说明

  创建通知通道(Promise形式)

- addSlot参数描述

| 名称 | 读写属性 | 类型     | 必填 | 描述                   |
| ---- | -------- | -------- | ---- | ---------------------- |
| type | 只读     | SlotType | 是   | 要创建的通知通道的类型 |

- 返回值

  Promise\<void\>

- 示例

```js
X
xuchenghua09 已提交
470
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then((void) => {
Z
zhaoyuan17 已提交
471 472 473 474 475 476
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuchenghua09 已提交
477
## Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
478 479 480 481 482 483 484

- 接口说明

  创建多个通知通道(callback形式)

- addSlots数描述

X
xuchenghua09 已提交
485 486 487 488
| 名称     | 读写属性 | 类型                      | 必填 | 描述                     |
| -------- | -------- | ------------------------- | ---- | ------------------------ |
| slots    | 只读     | Array\<NotificationSlot\> | 是   | 要创建的通知通道对象数组 |
| callback | 只读     | AsyncCallback\<void\>     | 是   | 表示被指定的回调方法     |
Z
zhaoyuan17 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502

- 返回值

  void

- 示例

```js
//addSlots回调
function addSlotsCallBack(err) {
	console.info("==========================>addSlotsCallBack=======================>");
}
//通知slot对象
var notificationSlot = {
X
xuchenghua09 已提交
503
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
504 505 506 507 508 509 510 511 512 513
}
//通知slot array 对象
var notificationSlotArray = new Array(); 
notificationSlotArray[0] = notificationSlot; 

Notification.addSlots(notificationSlotArray, addSlotsCallBack)
```



X
xuchenghua09 已提交
514
## Notification.addSlots(slots: Array\<NotificationSlot\>)
Z
zhaoyuan17 已提交
515 516 517 518 519 520 521

- 接口说明

  创建多个通知通道(Promise形式)

- addSlots数描述

X
xuchenghua09 已提交
522 523 524
| 名称  | 读写属性 | 类型                      | 必填 | 描述                     |
| ----- | -------- | ------------------------- | ---- | ------------------------ |
| slots | 只读     | Array\<NotificationSlot\> | 是   | 要创建的通知通道对象数组 |
Z
zhaoyuan17 已提交
525 526 527 528 529 530 531 532 533 534

- 返回值

  Promise\<void\>

- 示例

```js
//通知slot对象
var notificationSlot = {
X
xuchenghua09 已提交
535
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
536 537 538 539 540 541 542 543 544 545 546 547
}
//通知slot array 对象
var notificationSlotArray = new Array(); 
notificationSlotArray[0] = notificationSlot; 

Notification.addSlots(notificationSlotArray).then((void) => {
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuchenghua09 已提交
548
## Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>)
Z
zhaoyuan17 已提交
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

- 接口说明

  获取一个通知通道(callback形式)

- getSlot参数描述

| 名称     | 读写属性 | 类型                              | 必填 | 描述                                                        |
| -------- | -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
| slotType | 只读     | slotType                          | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读     | AsyncCallback\<NotificationSlot\> | 是   | 表示被指定的回调方法                                        |

- 返回值

  void

- 示例

```js
//getSlot回调
function getSlotCallback(err,data) {
	console.info("==========================>getSlotCallback=======================>");
}
X
xuchenghua09 已提交
572
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
573 574 575 576 577
Notification.getSlot(slotType, getSlotCallback)
```



X
xuchenghua09 已提交
578
## Notification.getSlot(slotType)
Z
zhaoyuan17 已提交
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

- 接口说明

  获取一个通知通道(Promise形式)

- getSlot参数描述

| 名称     | 读写属性 | 类型     | 必填 | 描述                                                        |
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | 只读     | slotType | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |

- 返回值

  Promise\<NotificationSlot\>

- 示例

```js
X
xuchenghua09 已提交
597
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
598 599
Notification.getSlot(slotType).then((data) => {
	console.info("==========================>getSlotCallback=======================>");
X
xuchenghua09 已提交
600
});
Z
zhaoyuan17 已提交
601 602 603 604
```



X
xuchenghua09 已提交
605
## Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>)
Z
zhaoyuan17 已提交
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

- 接口说明

  获取此应用程序的所有通知通道(callback形式)

- getSlots参数描述

| 名称     | 读写属性 | 类型                              | 必填 | 描述                 |
| -------- | -------- | --------------------------------- | ---- | -------------------- |
| callback | 只读     | AsyncCallback\<NotificationSlot\> | 是   | 表示被指定的回调方法 |

- 返回值

  void

- 示例

```js
//getSlots回调
function getSlotsCallback(err,data) {
	console.info("==========================>getSlotsCallback=======================>");
}
Notification.getSlots(getSlotsCallback)
```



X
xuchenghua09 已提交
633
## Notification.getSlots()
Z
zhaoyuan17 已提交
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

- 接口说明

  获取此应用程序的所有通知通道(Promise形式)

- getSlots参数描述

  无参数

- 返回值

  Promise\<Array\<NotificationSlot\>\>

- 示例

```js
Notification.getSlots().then((data) => {
	console.info("==========================>getSlotsCallback=======================>");
X
xuchenghua09 已提交
652
});
Z
zhaoyuan17 已提交
653 654 655 656
```



X
xuchenghua09 已提交
657
## Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680

- 接口说明

  根据通知通道类型删除创建的通知通道(callback形式)

- removeSlot参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                                                        |
| -------- | -------- | --------------------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读     | SlotType              | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法                                        |

- 返回值

  void

- 示例

```js
//removeSlot回调
function removeSlotCallback(err) {
	console.info("==========================>removeSlotCallback=======================>");
}
X
xuchenghua09 已提交
681
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
682 683 684 685 686
Notification.removeSlot(slotType,removeSlotCallback)
```



X
xuchenghua09 已提交
687
## Notification.removeSlot(slotType: SlotType)
Z
zhaoyuan17 已提交
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

- 接口说明

  根据通知通道类型删除创建的通知通道(Promise形式)

- removeSlot参数描述

| 名称     | 读写属性 | 类型     | 必填 | 描述                                                        |
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读     | SlotType | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |

- 返回值

  Promise\<void\>

- 示例

```js
X
xuchenghua09 已提交
706
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
707 708
Notification.removeSlot(slotType).then((void) => {
	console.info("==========================>removeSlotCallback=======================>");
X
xuchenghua09 已提交
709
});
Z
zhaoyuan17 已提交
710 711 712 713
```



X
xuchenghua09 已提交
714
## Notification.removeAllSlots(callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740

- 接口说明

  删除所有通知通道(callback形式)

- removeAllSlots参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读     | AsyncCallback\<void\> | 是   | 表示被指定的回调方法 |

- 返回值

  void

- 示例

```js
function removeAllCallBack(err) {
	console.info("================>removeAllCallBack=======================>");
}
Notification.removeAllSlots(removeAllCallBack)
```



X
xuchenghua09 已提交
741
## Notification.removeAllSlots()
Z
zhaoyuan17 已提交
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764

- 接口说明

  删除所有通知通道(Promise形式)

- removeAllSlots参数描述

  参数无

- 返回值

  Promise\<void\>

- 示例

```js
Notification.removeAllSlots().then((void) => {
	console.info("==========================>removeAllCallBack=======================>");
});
```



X
xuchenghua09 已提交
765
## Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

- 接口说明

  订阅通知并指定订阅信息(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 | 否   | 服务失联回调函数           |
| 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           | 是   | 通知排序序号 |

- 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 = {
X
xuchenghua09 已提交
856
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
857 858
}
var info = {
X
xuchenghua09 已提交
859
    bundleNames: ["bundleName1","bundleName2"]
Z
zhaoyuan17 已提交
860 861 862 863 864 865
}
Notification.subscribe(subscriber, info, subscribeCallback);
```



X
xuchenghua09 已提交
866
## Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892

- 接口说明

  订阅通知并指定订阅信息(callback形式)

- subscribe参数描述

| 名称       | 读写属性 | 类型                   | 必填 | 描述             |
| ---------- | -------- | ---------------------- | ---- | ---------------- |
| subscriber | 只读     | NotificationSubscriber | 是   | 通知订阅对象     |
| callback   | 只读     | AsyncCallback\<void\>  | 是   | 订阅动作回调函数 |

- 返回值

  void

- 示例

```js
function subscribeCallback(err) {
	console.info("==========================>subscribeCallback=======================>");
}
function onConsumeCallback(err, data) {
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
893
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
894 895 896 897 898 899
}
Notification.subscribe(subscriber, subscribeCallback);
```



X
xuchenghua09 已提交
900
## Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo)
Z
zhaoyuan17 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923

- 接口说明

  订阅通知并指定订阅信息(Promise形式)

- subscribe参数描述

| 名称       | 读写属性 | 类型                      | 必填 | 描述         |
| ---------- | -------- | ------------------------- | ---- | ------------ |
| subscriber | 只读     | NotificationSubscriber    | 是   | 通知订阅对象 |
| info       | 只读     | NotificationSubscribeInfo | 否   | 订阅信息     |

- 返回值

  Promise\<void\>

- 示例

```js
function onConsumeCallback(err, data) {
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
924
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
925 926 927 928 929 930 931 932
};
Notification.subscribe(subscriber).then((void) => {
	console.info("==========================>subscribeCallback=======================>");
});
```



X
xuchenghua09 已提交
933
## Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959

- 接口说明

  取消订阅(callbcak形式)

- unsubscribe参数描述

| 名称       | 读写属性 | 类型                   | 必填 | 描述                 |
| ---------- | -------- | ---------------------- | ---- | -------------------- |
| subscriber | 只读     | NotificationSubscriber | 是   | 通知订阅对象         |
| callback   | 只读     | AsyncCallback\<void\>  | 是   | 取消订阅动作回调函数 |

- 返回值

  void

- 示例

```js
function unsubscribeCallback(err) {
	console.info("==========================>unsubscribeCallback=======================>");
}
function onConsumeCallback(err, data) {
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
960
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
961 962 963 964 965 966
}
Notification.unsubscribe(subscriber, unsubscribeCallback);
```



X
xuchenghua09 已提交
967
## Notification.unsubscribe(subscriber: NotificationSubscriber)
Z
zhaoyuan17 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

- 接口说明

  取消订阅(Promise形式)

- unsubscribe参数描述

| 名称       | 读写属性 | 类型                   | 必填 | 描述         |
| ---------- | -------- | ---------------------- | ---- | ------------ |
| subscriber | 只读     | NotificationSubscriber | 是   | 通知订阅对象 |

- 返回值

  Promise\<void\>

- 示例

```js
function onConsumeCallback(err, data) {
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
990
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
991 992 993 994 995 996 997 998
};
Notification.unsubscribe(subscriber).then((void) => {
	console.info("==========================>unsubscribeCallback=======================>");
});
```



X
xuchenghua09 已提交
999
## Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

- 接口说明

  设定指定包的通知使能状态(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 = {
X
xuchenghua09 已提交
1030
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1031 1032 1033 1034 1035 1036
}
Notification.enableNotification(bundle, false, enableNotificationCallback);
```



X
xuchenghua09 已提交
1037
## Notification.enableNotification(bundle: BundleOption, enable: boolean)
Z
zhaoyuan17 已提交
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

- 接口说明

  设定指定包的通知使能状态(Promise形式)

- enableNotification参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |
| enable | 只读     | boolean      | 是   | 使能状态   |

- 返回值

  Promise\<void\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1058
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1059 1060 1061 1062 1063 1064 1065 1066
}
Notification.enableNotification(bundle, false).then((void) => {
	console.info("==========================>enableNotificationCallback=======================>");
});
```



X
xuchenghua09 已提交
1067
## Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
Z
zhaoyuan17 已提交
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

- 接口说明

  获取指定包的通知使能状态(Callback形式)

- isNotificationEnabled参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                     |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| bundle   | 只读     | BundleOption          | 是   | 指定包信息               |
| callback | 只读     | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数 |

- 返回值

  void

- 示例

```js
function isNotificationEnabledCallback(err, data) {
	console.info("==========================>isNotificationEnabledCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1091
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1092 1093 1094 1095 1096 1097
}
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```



X
xuchenghua09 已提交
1098
## Notification.isNotificationEnabled(bundle: BundleOption)
Z
zhaoyuan17 已提交
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117

- 接口说明

  获取指定包的通知使能状态(Promise形式)

- isNotificationEnabled参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |

- 返回值

  Promise\<boolean\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1118
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1119 1120 1121 1122 1123 1124 1125 1126
}
Notification.isNotificationEnabled(bundle).then((data) => {
	console.info("==========================>isNotificationEnabledCallback=======================>");
});
```



X
xuchenghua09 已提交
1127
## Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>)
Z
zhaoyuan17 已提交
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154

- 接口说明

  获取通知使能状态(Callback形式)

- isNotificationEnabled参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                     |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| callback | 只读     | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数 |

- 返回值

  void

- 示例

```js
function isNotificationEnabledCallback(err, data) {
	console.info("==========================>isNotificationEnabledCallback=======================>");
}

Notification.isNotificationEnabled(isNotificationEnabledCallback);
```



X
xuchenghua09 已提交
1155
## Notification.isNotificationEnabled()
Z
zhaoyuan17 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180

- 接口说明

  获取通知使能状态(Promise形式)

- isNotificationEnabled参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |

- 返回值

  Promise\<boolean\>

- 示例

```js
Notification.isNotificationEnabled().then((data) => {
	console.info("==========================>isNotificationEnabledCallback=======================>");
});
```



X
xuchenghua09 已提交
1181
## Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205

- 接口说明

  设定指定包的角标使能状态(Callback形式)

- displayBadge参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle   | 只读     | BundleOption          | 是   | 指定包信息           |
| enable   | 只读     | boolean               | 是   | 使能状态             |
| callback | 只读     | AsyncCallback\<void\> | 是   | 设定角标使能回调函数 |

- 返回值

  void

- 示例

```js
function displayBadgeCallback(err) {
	console.info("==========================>displayBadgeCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1206
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1207 1208 1209 1210 1211 1212
}
Notification.displayBadge(bundle, false, displayBadgeCallback);
```



X
xuchenghua09 已提交
1213
## Notification.displayBadge(bundle: BundleOption, enable: boolean)
Z
zhaoyuan17 已提交
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233

- 接口说明

  设定指定包的角标使能状态(Promise形式)

- displayBadge参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |
| enable | 只读     | boolean      | 是   | 使能状态   |

- 返回值

  Promise\<void\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1234
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1235 1236 1237 1238 1239 1240 1241 1242
}
Notification.displayBadge(bundle, false).then((void) => {
	console.info("==========================>displayBadgeCallback=======================>");
});
```



X
xuchenghua09 已提交
1243
## Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
Z
zhaoyuan17 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266

- 接口说明

  获取指定包的角标使能状态(Callback形式)

- isBadgeDisplayed参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                     |
| -------- | -------- | --------------------- | ---- | ------------------------ |
| bundle   | 只读     | BundleOption          | 是   | 指定包信息               |
| callback | 只读     | AsyncCallback\<void\> | 是   | 获取角标使能状态回调函数 |

- 返回值

  void

- 示例

```js
function isBadgeDisplayedCallback(err, data) {
	console.info("==========================>isBadgeDisplayedCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1267
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1268 1269 1270 1271 1272 1273
}
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
```



X
xuchenghua09 已提交
1274
## Notification.isBadgeDisplayed(bundle: BundleOption)
Z
zhaoyuan17 已提交
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293

- 接口说明

  获取指定包的角标使能状态(Promise形式)

- isBadgeDisplayed参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |

- 返回值

  Promise\<boolean\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1294
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1295 1296 1297 1298 1299 1300 1301 1302
}
Notification.isBadgeDisplayed(bundle).then((data) => {
	console.info("==========================>isBadgeDisplayedCallback=======================>");
});
```



X
xuchenghua09 已提交
1303
## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

- 接口说明

  设定指定包的通知通道状态(Callback形式)

- setSlotByBundle参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle   | 只读     | BundleOption          | 是   | 指定包信息           |
| slot     | 只读     | NotificationSlot      | 是   | 通知通道             |
| callback | 只读     | AsyncCallback\<void\> | 是   | 设定通知通道回调函数 |

- 返回值

  void

- 示例

```js
function setSlotByBundleCallback(err) {
	console.info("==========================>setSlotByBundleCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1328
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1329 1330
}
var notificationSlot = {
X
xuchenghua09 已提交
1331
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
1332 1333 1334 1335 1336 1337
}
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```



X
xuchenghua09 已提交
1338
## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot)
Z
zhaoyuan17 已提交
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358

- 接口说明

  设定指定包的角标使能状态(Promise形式)

- setSlotByBundle参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |
| enable | 只读     | boolean      | 是   | 使能状态   |

- 返回值

  Promise\<void\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1359
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1360 1361
}
var notificationSlot = {
X
xuchenghua09 已提交
1362
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
1363 1364 1365 1366 1367 1368 1369 1370
}
Notification.displayBadge(bundle, notificationSlot).then((void) => {
	console.info("==========================>setSlotByBundleCallback=======================>");
});
```



X
xuchenghua09 已提交
1371
## Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>)
Z
zhaoyuan17 已提交
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394

- 接口说明

  获取指定包的通知通道(Callback形式)

- getSlotsByBundle参数描述

| 名称     | 读写属性 | 类型                                     | 必填 | 描述                 |
| -------- | -------- | ---------------------------------------- | ---- | -------------------- |
| bundle   | 只读     | BundleOption                             | 是   | 指定包信息           |
| callback | 只读     | AsyncCallback<Array\<NotificationSlot\>> | 是   | 获取通知通道回调函数 |

- 返回值

  void

- 示例

```js
function getSlotsByBundleCallback(err, data) {
	console.info("==========================>getSlotsByBundleCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1395
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1396 1397 1398 1399 1400 1401
}
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```



X
xuchenghua09 已提交
1402
## Notification.getSlotsByBundle(bundle: BundleOption)
Z
zhaoyuan17 已提交
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421

- 接口说明

  获取指定包的通知通道(Promise形式)

- getSlotsByBundle参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |

- 返回值

  Promise<Array\<NotificationSlot\>>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1422
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1423 1424 1425 1426 1427 1428 1429 1430
}
Notification.getSlotsByBundle(bundle).then((data) => {
	console.info("==========================>getSlotsByBundleCallback=======================>");
});
```



X
xuchenghua09 已提交
1431
## Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>)
Z
zhaoyuan17 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454

- 接口说明

  获取指定包的通知通道数(Callback形式)

- getSlotNumByBundle参数描述

| 名称     | 读写属性 | 类型                      | 必填 | 描述                   |
| -------- | -------- | ------------------------- | ---- | ---------------------- |
| bundle   | 只读     | BundleOption              | 是   | 指定包信息             |
| callback | 只读     | AsyncCallback\<number\> | 是   | 获取通知通道数回调函数 |

- 返回值

  void

- 示例

```js
function getSlotNumByBundle(err, data) {
	console.info("==========================>getSlotNumByBundleCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1455
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1456 1457 1458 1459 1460 1461
}
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```



X
xuchenghua09 已提交
1462
## Notification.getSlotNumByBundle(bundle: BundleOption)
Z
zhaoyuan17 已提交
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481

- 接口说明

  获取指定包的通知通道数(Promise形式)

- getSlotNumByBundle参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 是   | 指定包信息 |

- 返回值

  Promise\<number\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1482
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1483 1484 1485 1486 1487 1488 1489 1490
}
Notification.getSlotNumByBundle(bundle).then((data) => {
	console.info("==========================>getSlotNumByBundleCallback=======================>");
});
```



X
xuchenghua09 已提交
1491
## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522

- 接口说明

  删除指定通知(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 = {
X
xuchenghua09 已提交
1523
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1524 1525
}
var notificationKey = {
X
xuchenghua09 已提交
1526 1527
    id: 0;
    label: "label";
Z
zhaoyuan17 已提交
1528 1529 1530 1531 1532 1533
}
Notification.remove(bundle, notificationKey, removeCallback);
```



X
xuchenghua09 已提交
1534
## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey)
Z
zhaoyuan17 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554

- 接口说明

  删除指定通知(Promise形式)

- remove参数描述

| 名称            | 读写属性 | 类型            | 必填 | 描述       |
| --------------- | -------- | --------------- | ---- | ---------- |
| bundle          | 只读     | BundleOption    | 是   | 指定包信息 |
| notificationKey | 只读     | NotificationKey | 是   | 通知键值   |

- 返回值

  Promise\<void\>

- 示例

```js
var bundle = {
X
xuchenghua09 已提交
1555
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1556 1557
}
var notificationKey = {
X
xuchenghua09 已提交
1558 1559
    id: 0;
    label: "label";
Z
zhaoyuan17 已提交
1560 1561 1562 1563 1564 1565 1566 1567
}
Notification.remove(bundle, notificationKey).then((void) => {
	console.info("==========================>removeCallback=======================>");
});
```



X
xuchenghua09 已提交
1568
## Notification.remove(hashCode: string, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596

- 接口说明

  删除指定通知(Callback形式)

- remove参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| hashCode | 只读     | string                | 是   | 通知唯一ID           |
| callback | 只读     | AsyncCallback\<void\> | 是   | 删除指定通知回调函数 |

- 返回值

  void

- 示例

```js
function removeCallback(err) {
	console.info("==========================>removeCallback=======================>");
}

Notification.remove(hashCode, removeCallback);
```



X
xuchenghua09 已提交
1597
## Notification.remove(hashCode: string)
Z
zhaoyuan17 已提交
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622

- 接口说明

  删除指定通知(Promise形式)

- remove参数描述

| 名称     | 读写属性 | 类型       | 必填 | 描述       |
| -------- | -------- | ---------- | ---- | ---------- |
| hashCode | 只读     | string | 是   | 通知唯一ID |

- 返回值

  Promise\<void\>

- 示例

```js
Notification.remove(hashCode).then((void) => {
	console.info("==========================>removeCallback=======================>");
});
```



X
xuchenghua09 已提交
1623
## Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646

- 接口说明

  删除指定包的所有通知(Callback形式)

- removeAll参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                         |
| -------- | -------- | --------------------- | ---- | ---------------------------- |
| bundle   | 只读     | BundleOption          | 是   | 指定包信息                   |
| callback | 只读     | AsyncCallback\<void\> | 是   | 删除指定包的所有通知回调函数 |

- 返回值

  void

- 示例

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}
var bundle = {
X
xuchenghua09 已提交
1647
    bundle: "bundleName1";
Z
zhaoyuan17 已提交
1648 1649 1650 1651 1652 1653
}
Notification.removeAll(bundle, removeAllCallback);
```



X
xuchenghua09 已提交
1654
## Notification.removeAll(callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

- 接口说明

  删除所有通知(Callback形式)

- removeAll参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| callback | 只读     | AsyncCallback\<void\> | 是   | 删除所有通知回调函数 |

- 返回值

  void

- 示例

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}

Notification.removeAll(removeAllCallback);
```



X
xuchenghua09 已提交
1682
## Notification.removeAll(bundle?: BundleOption)
Z
zhaoyuan17 已提交
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707

- 接口说明

  删除所有通知(Promise形式)

- removeAll参数描述

| 名称   | 读写属性 | 类型         | 必填 | 描述       |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读     | BundleOption | 否   | 指定包信息 |

- 返回值

  Promise\<void\>

- 示例

```js
Notification.removeAll().then((void) => {
	console.info("==========================>removeAllCallback=======================>");
});
```



X
xuchenghua09 已提交
1708
## Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
Z
zhaoyuan17 已提交
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735

- 接口说明

  获取活动通知(Callback形式)

- getAllActiveNotifications参数描述

| 名称     | 读写属性 | 类型                                        | 必填 | 描述                 |
| -------- | -------- | ------------------------------------------- | ---- | -------------------- |
| callback | 只读     | AsyncCallback<Array\<NotificationRequest\>> | 是   | 获取活动通知回调函数 |

- 返回值

  void

- 示例

```js
function getAllActiveNotificationsCallback(err, data) {
	console.info("==========================>getAllActiveNotificationsCallback=======================>");
}

Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
```



X
xuchenghua09 已提交
1736
## Notification.getAllActiveNotifications()
Z
zhaoyuan17 已提交
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759

- 接口说明

  获取活动通知(Promise形式)

- getAllActiveNotifications参数描述



- 返回值

  Promise\<Array\<NotificationRequest\>\>

- 示例

```js
Notification.getAllActiveNotifications().then((data) => {
	console.info("==========================>getAllActiveNotificationsCallback=======================>");
});
```



X
xuchenghua09 已提交
1760
## Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>)
Z
zhaoyuan17 已提交
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787

- 接口说明

  获取当前应用的活动通知数(Callback形式)

- getActiveNotificationCount参数描述

| 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| callback | 只读     | AsyncCallback\<number\> | 是   | 获取活动通知数回调函数 |

- 返回值

  void

- 示例

```js
function getActiveNotificationCountCallback(err, data) {
	console.info("==========================>getActiveNotificationCountCallback=======================>");
}

Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
```



X
xuchenghua09 已提交
1788
## Notification.getActiveNotificationCount()
Z
zhaoyuan17 已提交
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811

- 接口说明

  获取当前应用的活动通知数(Promise形式)

- getActiveNotificationCount参数描述



- 返回值

  返回值为Promise\<number\>

- 示例

```js
Notification.getActiveNotificationCount().then((data) => {
	console.info("==========================>getActiveNotificationCountCallback=======================>");
});
```



X
xuchenghua09 已提交
1812
## Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
Z
zhaoyuan17 已提交
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839

- 接口说明

  获取当前应用的活动通知(Callback形式)

- getActiveNotifications参数描述

| 名称     | 读写属性 | 类型                                        | 必填 | 描述                           |
| -------- | -------- | ------------------------------------------- | ---- | ------------------------------ |
| callback | 只读     | AsyncCallback<Array\<NotificationRequest\>> | 是   | 获取当前应用的活动通知回调函数 |

- 返回值

  void

- 示例

```js
function getActiveNotificationsCallback(err, data) {
	console.info("==========================>getActiveNotificationsCallback=======================>");
}

Notification.getActiveNotifications(getActiveNotificationsCallback);
```



X
xuchenghua09 已提交
1840
## Notification.getActiveNotifications()
Z
zhaoyuan17 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863

- 接口说明

  获取当前应用的活动通知(Promise形式)

- getActiveNotifications参数描述



- 返回值

  Promise\<Array\<NotificationRequest\>\>

- 示例

```js
Notification.getActiveNotifications().then((data) => {
	console.info("==========================>getActiveNotificationsCallback=======================>");
});
```



X
xuchenghua09 已提交
1864
## Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894

- 接口说明

  取消本应用指定组通知(Callback形式)

- cancelGroup参数描述

| 名称      | 读写属性 | 类型                  | 必填 | 描述                         |
| --------- | -------- | --------------------- | ---- | ---------------------------- |
| groupName | 只读     | string                | 是   | 指定通知组名称               |
| callback  | 只读     | AsyncCallback\<void\> | 是   | 取消本应用指定组通知回调函数 |

- 返回值

  void

- 示例

```js
function cancelGroupCallback(err) {
   console.info("==========================>cancelGroupCallback=======================>");
}

var groupName = "GroupName";

Notification.cancelGroup(groupName, cancelGroupCallback);
```



X
xuchenghua09 已提交
1895
## Notification.cancelGroup(groupName: string)
Z
zhaoyuan17 已提交
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921

- 接口说明

  取消本应用指定组通知(Promise形式)

- cancelGroup参数描述

| 名称      | 读写属性 | 类型   | 必填 | 描述           |
| --------- | -------- | ------ | ---- | -------------- |
| groupName | 只读     | string | 是   | 指定通知组名称 |

- 返回值

  Promise\<void\>

- 示例

```js
var groupName = "GroupName";
Notification.cancelGroup(groupName).then(() => {
	console.info("==========================>cancelGroupPromise=======================>");
});
```



X
xuchenghua09 已提交
1922
## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946

- 接口说明

  删除指定应用指定组通知(Callback形式)

- removeGroupByBundle参数描述

| 名称      | 读写属性 | 类型                  | 必填 | 描述                         |
| --------- | -------- | --------------------- | ---- | ---------------------------- |
| bundle    | 只读     | BundleOption          | 是   | 指定包信息                   |
| groupName | 只读     | string                | 是   | 指定通知组名称               |
| callback  | 只读     | AsyncCallback\<void\> | 是   | 删除本应用指定组通知回调函数 |

- 返回值

  void

- 示例

```js
function removeGroupByBundleCallback(err) {
   console.info("==========================>removeGroupByBundleCallback=======================>");
}

X
xuchenghua09 已提交
1947
var bundleOption = {bundle: "Bundle"};
Z
zhaoyuan17 已提交
1948 1949 1950 1951 1952 1953 1954
var groupName = "GroupName";

Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
```



X
xuchenghua09 已提交
1955
## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string)
Z
zhaoyuan17 已提交
1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974

- 接口说明

  删除指定应用指定组通知(Promise形式)

- removeGroupByBundle参数描述

| 名称      | 读写属性 | 类型         | 必填 | 描述           |
| --------- | -------- | ------------ | ---- | -------------- |
| bundle    | 只读     | BundleOption | 是   | 指定包信息     |
| groupName | 只读     | string       | 是   | 指定通知组名称 |

- 返回值

  Promise\<void\>

- 示例

```js
X
xuchenghua09 已提交
1975
var bundleOption = {bundle: "Bundle"};
Z
zhaoyuan17 已提交
1976 1977 1978 1979 1980 1981 1982 1983
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
	console.info("==========================>removeGroupByBundlePromise=======================>");
});
```



X
xuchenghua09 已提交
1984
## Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008

- 接口说明

  设置免打扰时间(Callback形式)

- setDoNotDisturbDate参数描述

| 名称     | 读写属性 | 类型                  | 必填 | 描述                   |
| -------- | -------- | --------------------- | ---- | ---------------------- |
| date     | 只读     | DoNotDisturbDate      | 是   | 免打扰时间选项         |
| callback | 只读     | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数 |

- 返回值

  void

- 示例

```js
function setDoNotDisturbDateCallback(err) {
   console.info("==========================>setDoNotDisturbDateCallback=======================>");
}

var doNotDisturbDate = {
X
xuchenghua09 已提交
2009 2010 2011
    type: notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
Z
zhaoyuan17 已提交
2012 2013 2014 2015 2016 2017 2018
}

Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
```



X
xuchenghua09 已提交
2019
## Notification.setDoNotDisturbDate(date: DoNotDisturbDate)
Z
zhaoyuan17 已提交
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038

- 接口说明

  设置免打扰时间接口(Promise形式)

- setDoNotDisturbDate参数描述

| 名称 | 读写属性 | 类型             | 必填 | 描述           |
| ---- | -------- | ---------------- | ---- | -------------- |
| date | 只读     | DoNotDisturbDate | 是   | 免打扰时间选项 |

- 返回值

  Promise\<void\>

- 示例

```js
var doNotDisturbDate = {
X
xuchenghua09 已提交
2039 2040 2041
    type: notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
Z
zhaoyuan17 已提交
2042 2043 2044 2045 2046 2047 2048 2049
}
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
	console.info("==========================>setDoNotDisturbDatePromise=======================>");
});
```



X
xuchenghua09 已提交
2050
## Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>)
Z
zhaoyuan17 已提交
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077

- 接口说明

  查询免打扰时间接口(Callback形式)

- getDoNotDisturbDate参数描述

| 名称     | 读写属性 | 类型                              | 必填 | 描述                   |
| -------- | -------- | --------------------------------- | ---- | ---------------------- |
| callback | 只读     | AsyncCallback\<DoNotDisturbDate\> | 是   | 查询免打扰时间回调函数 |

- 返回值

  void

- 示例

```js
function getDoNotDisturbDateCallback(err,data) {
   console.info("==========================>getDoNotDisturbDateCallback=======================>");
}

Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
```



X
xuchenghua09 已提交
2078
## Notification.getDoNotDisturbDate()
Z
zhaoyuan17 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101

- 接口说明

  查询免打扰时间接口(Promise形式)

- getDoNotDisturbDate参数描述



- 返回值

  Promise\<DoNotDisturbDate\>

- 示例

```js
Notification.getDoNotDisturbDate().then((data) => {
	console.info("==========================>getDoNotDisturbDatePromise=======================>");
});
```



X
xuchenghua09 已提交
2102
## Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>)
Z
zhaoyuan17 已提交
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129

- 接口说明

  查询是否支持勿扰模式功能(Callback形式)

- supportDoNotDisturbMode参数描述

| 名称     | 读写属性 | 类型                     | 必填 | 描述                             |
| -------- | -------- | ------------------------ | ---- | -------------------------------- |
| callback | 只读     | AsyncCallback\<boolean\> | 是   | 查询是否支持勿扰模式功能回调函数 |

- 返回值

  void

- 示例

```js
function supportDoNotDisturbModeCallback(err,data) {
   console.info("==========================>supportDoNotDisturbModeCallback=======================>");
}

Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
```



X
xuchenghua09 已提交
2130
## Notification.supportDoNotDisturbMode()
Z
zhaoyuan17 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153

- 接口说明

  查询是否支持勿扰模式功能(Promise形式)

- supportDoNotDisturbMode参数描述



- 返回值

  Promise\<boolean\>

- 示例

```js
Notification.supportDoNotDisturbMode().then((data) => {
	console.info("==========================>supportDoNotDisturbModePromise=======================>");
});
```



Z
zengsiyu 已提交
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220
## Notification.isSupportTemplate

isSupportTemplate(templateName: string, callback: AsyncCallback\<boolean\>): void

查询模板是否存在。

- 参数

| 参数名       | 类型                     | 必填 | 说明                       |
| ------------ | ------------------------ | ---- | -------------------------- |
| templateName | string                   | 是   | 模板名称                   |
| callback     | AsyncCallback\<boolean\> | 是   | 查询模板是否存在的回调函数 |

- 示例

```javascript
var templateName = 'process';
function isSupportTemplateCallback(err, data) {
    console.info("isSupportTemplateCallback");
}

Notification.isSupportTemplate(templateName, isSupportTemplateCallback);
```



## Notification.isSupportTemplate

isSupportTemplate(templateName: string): Promise\<boolean\>

查询模板是否存在。

- 参数

| 参数名       | 类型   | 必填 | 说明     |
| ------------ | ------ | ---- | -------- |
| templateName | string | 是   | 模板名称 |

- 返回值

| 类型               | 说明            |
| ------------------ | --------------- |
| Promise\<boolean\> | Promise方式返回 |

- 示例

```javascript
var templateName = 'process';

Notification.isSupportTemplate(templateName).then((data) => {
    console.info("isSupportTemplateCallback");
});
```



## NotificationTemplate

模板信息

| 名称 | 参数类型               | 可读 | 可写 | 说明     |
| ---- | ---------------------- | ---- | ---- | -------- |
| name | string                 | 是   | 是   | 模板名称 |
| data | {[key:string]: Object} | 是   | 是   | 模板数据 |



X
xuchenghua09 已提交
2221
## WantAgent接口
Z
zhaoyuan17 已提交
2222

X
xuchenghua09 已提交
2223
## 导入模块
Z
zhaoyuan17 已提交
2224 2225 2226 2227 2228

```js
import WantAgent from '@ohos.wantAgent';
```

X
xuchenghua09 已提交
2229
## WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>)
Z
zhaoyuan17 已提交
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

- 接口说明

  创建WantAgent(callback形式)

- getWantAgent参数描述


| 名称     | 读写属性 | 类型                       | 必填 | 描述                    |
| -------- | -------- | -------------------------- | ---- | ----------------------- |
| info     | 只读     | WantAgentInfo              | 是   | WantAgent信息           |
| callback | 只读     | AsyncCallback\<WantAgent\> | 是   | 创建WantAgent的回调方法 |

- WantAgentInfo类型说明

| 名称           | 读写属性 | 类型                            | 必填 | 描述                   |
| -------------- | -------- | ------------------------------- | ---- | ---------------------- |
| wants          | 读、写   | Array\<Want\>                   | 是   | 将被执行的动作列表     |
| operationType  | 读、写   | wantAgent.OperationType         | 是   | 动作类型               |
| requestCode    | 读、写   | number                          | 是   | 使用者定义的一个私有值 |
| wantAgentFlags | 读、写   | Array<wantAgent.WantAgentFlags> | 否   | 动作执行属性           |
| extraInfo      | 读、写   | {[key: string]: any}            | 否   | 额外数据               |

- 
  WantAgentFlags类型说明


| 名称                | 读写属性 | 类型 | 必填 | 描述                                                         |
| ------------------- | -------- | ---- | ---- | ------------------------------------------------------------ |
| ONE_TIME_FLAG       | 只读     | enum | 否   | WantAgent仅能使用一次                                        |
| NO_BUILD_FLAG       | 只读     | enum | 否   | 如果描述WantAgent对象不存在,则不创建它,直接返回null        |
| CANCEL_PRESENT_FLAG | 只读     | enum | 否   | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象   |
| UPDATE_PRESENT_FLAG | 只读     | enum | 否   | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据 |
| CONSTANT_FLAG       | 只读     | enum | 否   | WantAgent是不可变的                                          |

- OperationType类型说明

| 名称              | 读写属性 | 类型 | 必填 | 描述                    |
| ----------------- | -------- | ---- | ---- | ----------------------- |
| UNKNOWN_TYPE      | 只读     | enum | 否   | 不识别的类型            |
| START_ABILITY     | 只读     | enum | 否   | 开启一个有页面的Ability |
| START_ABILITIES   | 只读     | enum | 否   | 开启多个有页面的Ability |
| START_SERVICE     | 只读     | enum | 否   | 开启一个无页面的ability |
| SEND_COMMON_EVENT | 只读     | enum | 否   | 发送一个公共事件        |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2282 2283
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
}
//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]
}

X
xuchenghua09 已提交
2317
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
2318 2319 2320 2321
```



X
xuchenghua09 已提交
2322
## WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
Z
zhaoyuan17 已提交
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341

- 接口说明

  创建WantAgent(Promise形式)

- getWantAgent参数描述


| 名称 | 读写属性 | 类型          | 必填 | 描述          |
| ---- | -------- | ------------- | ---- | ------------- |
| info | 只读     | WantAgentInfo | 是   | WantAgent信息 |

- 返回值

  Promise\<WantAgent\>

- 示例

```js
X
xuchenghua09 已提交
2342 2343
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372

//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]
}

X
xuchenghua09 已提交
2373
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
2374 2375 2376 2377 2378 2379
	console.info("==========================>getWantAgentCallback=======================>");
});
```



X
xuchenghua09 已提交
2380
## WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>)
Z
zhaoyuan17 已提交
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400

- 接口说明

  获取WantAgent实例的包名(callback形式)

- getBundleName参数描述


| 名称     | 读写属性 | 类型                    | 必填 | 描述                              |
| -------- | -------- | ----------------------- | ---- | --------------------------------- |
| agent    | 只读     | WantAgent               | 是   | WantAgent对象                     |
| callback | 只读     | AsyncCallback\<string\> | 是   | 获取WantAgent实例的包名的回调方法 |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2401 2402
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2403 2404

//wantAgent对象
X
xuchenghua09 已提交
2405
var wantAgent;
Z
zhaoyuan17 已提交
2406 2407 2408 2409 2410

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
2411
    	wantAgent = data;
Z
zhaoyuan17 已提交
2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
    } 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:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}

X
xuchenghua09 已提交
2444
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
2445 2446 2447 2448 2449

//getBundleName回调
function getBundleNameCallback(err, data) {
	console.info("==========================>getBundleNameCallback=======================>");
}
X
xuchenghua09 已提交
2450
WantAgent.getBundleName(wantAgent, getBundleNameCallback)
Z
zhaoyuan17 已提交
2451 2452 2453 2454
```



X
xuchenghua09 已提交
2455
## WantAgent.getBundleName(agent: WantAgent): Promise\<string\>
Z
zhaoyuan17 已提交
2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474

- 接口说明

  获取WantAgent实例的包名(Promise形式)

- getBundleName参数描述


| 名称  | 读写属性 | 类型      | 必填 | 描述          |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读     | WantAgent | 是   | WantAgent对象 |

- 返回值

  Promise\<string\>

- 示例

```js
X
xuchenghua09 已提交
2475 2476
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2477 2478

//wantAgent对象
X
xuchenghua09 已提交
2479
var wantAgent;
Z
zhaoyuan17 已提交
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508

//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]
}

X
xuchenghua09 已提交
2509
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
2510
	console.info("==========================>getWantAgentCallback=======================>");
X
xuchenghua09 已提交
2511
    wantAgent = data;
Z
zhaoyuan17 已提交
2512 2513
});

X
xuchenghua09 已提交
2514
WantAgent.getBundleName(wantAgent).then((data) => {
Z
zhaoyuan17 已提交
2515 2516 2517 2518 2519 2520
	console.info("==========================>getBundleNameCallback=======================>");
});
```



X
xuchenghua09 已提交
2521
## WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>)
Z
zhaoyuan17 已提交
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541

- 接口说明

  获取WantAgent实例的用户ID(callback形式)

- getUid参数描述


| 名称     | 读写属性 | 类型                    | 必填 | 描述                                |
| -------- | -------- | ----------------------- | ---- | ----------------------------------- |
| agent    | 只读     | WantAgent               | 是   | WantAgent对象                       |
| callback | 只读     | AsyncCallback\<number\> | 是   | 获取WantAgent实例的用户ID的回调方法 |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2542 2543
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2544 2545

//wantAgent对象
X
xuchenghua09 已提交
2546
var wantAgent;
Z
zhaoyuan17 已提交
2547 2548 2549 2550 2551

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
2552
    	wantAgent = data;
Z
zhaoyuan17 已提交
2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
    } 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:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}

X
xuchenghua09 已提交
2585
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
2586 2587 2588 2589 2590

//getUid回调
function getUidCallback(err, data) {
	console.info("==========================>getUidCallback=======================>");
}
X
xuchenghua09 已提交
2591
WantAgent.getUid(wantAgent, getUidCallback)
Z
zhaoyuan17 已提交
2592 2593 2594 2595
```



X
xuchenghua09 已提交
2596
## WantAgent.getUid(agent: WantAgent): Promise\<number\>
Z
zhaoyuan17 已提交
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615

- 接口说明

  获取WantAgent实例的用户ID(Promise形式)

- getUid参数描述


| 名称  | 读写属性 | 类型      | 必填 | 描述          |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读     | WantAgent | 是   | WantAgent对象 |

- 返回值

  Promise\<number\>

- 示例

```js
X
xuchenghua09 已提交
2616 2617
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2618 2619

//wantAgent对象
X
xuchenghua09 已提交
2620
var wantAgent;
Z
zhaoyuan17 已提交
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649

//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]
}

X
xuchenghua09 已提交
2650
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
2651
	console.info("==========================>getWantAgentCallback=======================>");
X
xuchenghua09 已提交
2652
    wantAgent = data;
Z
zhaoyuan17 已提交
2653 2654
});

X
xuchenghua09 已提交
2655
WantAgent.getUid(wantAgent).then((data) => {
Z
zhaoyuan17 已提交
2656 2657 2658 2659 2660 2661
	console.info("==========================>getUidCallback=======================>");
});
```



X
xuchenghua09 已提交
2662
## WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>)
Z
zhaoyuan17 已提交
2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682

- 接口说明

  获取WantAgent对象的want(callback形式)

- getWant参数描述


| 名称     | 读写属性 | 类型                  | 必填 | 描述                            |
| -------- | -------- | --------------------- | ---- | ------------------------------- |
| agent    | 只读     | WantAgent             | 是   | WantAgent对象                   |
| callback | 只读     | AsyncCallback\<Want\> | 是   | 获取WantAgent对象want的回调方法 |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2683 2684
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2685 2686

//wantAgent对象
X
xuchenghua09 已提交
2687
var wantAgent;
Z
zhaoyuan17 已提交
2688 2689 2690 2691 2692

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
2693
    	wantAgent = data;
Z
zhaoyuan17 已提交
2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725
    } 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]
}

X
xuchenghua09 已提交
2726
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
2727 2728 2729 2730 2731

//getWant回调
function getWantCallback(err, data) {
	console.info("==========================>getWantCallback=======================>");
}
X
xuchenghua09 已提交
2732
WantAgent.getWant(wantAgent, getWantCallback)
Z
zhaoyuan17 已提交
2733 2734 2735 2736
```



X
xuchenghua09 已提交
2737
## WantAgent.getWant(agent: WantAgent): Promise\<Want\>
Z
zhaoyuan17 已提交
2738 2739 2740

- 接口说明

X
xuchenghua09 已提交
2741
  获取WantAgent对象的want(Promise形式)
Z
zhaoyuan17 已提交
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756

- getWant参数描述


| 名称  | 读写属性 | 类型      | 必填 | 描述          |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读     | WantAgent | 是   | WantAgent对象 |

- 返回值

  Promise\<Want\>

- 示例

```js
X
xuchenghua09 已提交
2757 2758
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2759 2760

//wantAgent对象
X
xuchenghua09 已提交
2761
var wantAgent;
Z
zhaoyuan17 已提交
2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790

//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]
}

X
xuchenghua09 已提交
2791
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
2792
	console.info("==========================>getWantAgentCallback=======================>");
X
xuchenghua09 已提交
2793
    wantAgent = data;
Z
zhaoyuan17 已提交
2794 2795
});

X
xuchenghua09 已提交
2796
WantAgent.getWant(wantAgent).then((data) => {
Z
zhaoyuan17 已提交
2797 2798 2799 2800 2801 2802
	console.info("==========================>getWantCallback=======================>");
});
```



X
xuchenghua09 已提交
2803
## WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>)
Z
zhaoyuan17 已提交
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823

- 接口说明

  取消WantAgent实例(callback形式)

- cancel参数描述


| 名称     | 读写属性 | 类型                  | 必填 | 描述                        |
| -------- | -------- | --------------------- | ---- | --------------------------- |
| agent    | 只读     | WantAgent             | 是   | WantAgent对象               |
| callback | 只读     | AsyncCallback\<void\> | 是   | 取消WantAgent实例的回调方法 |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2824 2825
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2826 2827

//wantAgent对象
X
xuchenghua09 已提交
2828
var wantAgent;
Z
zhaoyuan17 已提交
2829 2830 2831 2832 2833

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
2834
    	wantAgent = data;
Z
zhaoyuan17 已提交
2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
    } 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:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}

X
xuchenghua09 已提交
2867
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
2868 2869 2870 2871 2872

//cancel回调
function cancelCallback(err, data) {
	console.info("==========================>cancelCallback=======================>");
}
X
xuchenghua09 已提交
2873
WantAgent.cancel(wantAgent, cancelCallback)
Z
zhaoyuan17 已提交
2874 2875 2876 2877
```



X
xuchenghua09 已提交
2878
## WantAgent.cancel(agent: WantAgent): Promise\<void\>
Z
zhaoyuan17 已提交
2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897

- 接口说明

  取消WantAgent实例(Promise形式)

- cancel参数描述


| 名称  | 读写属性 | 类型      | 必填 | 描述          |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读     | WantAgent | 是   | WantAgent对象 |

- 返回值

  Promise\<void\>

- 示例

```js
X
xuchenghua09 已提交
2898 2899
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2900 2901

//wantAgent对象
X
xuchenghua09 已提交
2902
var wantAgent;
Z
zhaoyuan17 已提交
2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931

//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]
}

X
xuchenghua09 已提交
2932
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
2933
	console.info("==========================>getWantAgentCallback=======================>");
X
xuchenghua09 已提交
2934
    wantAgent = data;
Z
zhaoyuan17 已提交
2935 2936
});

X
xuchenghua09 已提交
2937
WantAgent.cancel(wantAgent).then((data) => {
Z
zhaoyuan17 已提交
2938 2939 2940 2941 2942 2943
	console.info("==========================>cancelCallback=======================>");
});
```



X
xuchenghua09 已提交
2944
## WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>)
Z
zhaoyuan17 已提交
2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974

- 接口说明

  主动激发WantAgent实例(callback形式)

- trigger参数描述


| 名称        | 读写属性 | 类型                          | 必填 | 描述                            |
| ----------- | -------- | ----------------------------- | ---- | ------------------------------- |
| agent       | 只读     | WantAgent                     | 是   | WantAgent对象                   |
| triggerInfo | 只读     | TriggerInfo                   | 是   | TriggerInfo对象                 |
| callback    | 只读     | AsyncCallback\<CompleteData\> | 是   | 主动激发WantAgent实例的回调方法 |

- TriggerInfo类型说明

| 名称       | 读写属性 | 类型                 | 必填 | 描述        |
| ---------- | -------- | -------------------- | ---- | ----------- |
| code       | 读、写   | number               | 是   | result code |
| want       | 读、写   | Want                 | 否   | Want        |
| permission | 读、写   | string               | 否   | 权限定义    |
| extraInfo  | 读、写   | {[key: string]: any} | 否   | 额外数据    |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
2975 2976
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
2977 2978

//wantAgent对象
X
xuchenghua09 已提交
2979
var wantAgent;
Z
zhaoyuan17 已提交
2980 2981 2982 2983 2984

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
2985
    	wantAgent = data;
Z
zhaoyuan17 已提交
2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017
    } 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:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}

X
xuchenghua09 已提交
3018
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
3019 3020 3021 3022 3023 3024 3025 3026 3027

//trigger回调
function triggerCallback(err, data) {
	console.info("==========================>triggerCallback=======================>");
}

var triggerInfo = {
    code:0
}
X
xuchenghua09 已提交
3028
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
Z
zhaoyuan17 已提交
3029 3030 3031 3032
```



X
xuchenghua09 已提交
3033
## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>)
Z
zhaoyuan17 已提交
3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054

- 接口说明

  判断两个WantAgent实例是否相等(callback形式)

- equal参数描述


| 名称       | 读写属性 | 类型                     | 必填 | 描述                                    |
| ---------- | -------- | ------------------------ | ---- | --------------------------------------- |
| agent      | 只读     | WantAgent                | 是   | WantAgent对象                           |
| otherAgent | 只读     | WantAgent                | 是   | WantAgent对象                           |
| callback   | 只读     | AsyncCallback\<boolean\> | 是   | 判断两个WantAgent实例是否相等的回调方法 |

- 返回值

  void

- 示例

```js
X
xuchenghua09 已提交
3055 3056
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
3057 3058

//wantAgent对象
X
xuchenghua09 已提交
3059 3060
var wantAgent1;
var wantAgent2;
Z
zhaoyuan17 已提交
3061 3062 3063 3064 3065

//getWantAgent回调
function getWantAgentCallback(err, data) {
	console.info("==========================>getWantAgentCallback=======================>");
    if (err.code == 0) {
X
xuchenghua09 已提交
3066 3067
    	wantAgent1 = data;
        wantAgent2 = data;
Z
zhaoyuan17 已提交
3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099
    } 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:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}

X
xuchenghua09 已提交
3100
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
Z
zhaoyuan17 已提交
3101 3102 3103 3104 3105

//equal回调
function equalCallback(err, data) {
	console.info("==========================>equalCallback=======================>");
}
X
xuchenghua09 已提交
3106
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
Z
zhaoyuan17 已提交
3107 3108 3109 3110
```



X
xuchenghua09 已提交
3111
## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
Z
zhaoyuan17 已提交
3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131

- 接口说明

  判断两个WantAgent实例是否相等(Promise形式)

- equal参数描述


| 名称       | 读写属性 | 类型      | 必填 | 描述          |
| ---------- | -------- | --------- | ---- | ------------- |
| agent      | 只读     | WantAgent | 是   | WantAgent对象 |
| otherAgent | 只读     | WantAgent | 是   | WantAgent对象 |

- 返回值

  Promise\<boolean\>

- 示例

```js
X
xuchenghua09 已提交
3132 3133
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
Z
zhaoyuan17 已提交
3134 3135

//wantAgent对象
X
xuchenghua09 已提交
3136 3137
var wantAgent1;
var wantAgent2;
Z
zhaoyuan17 已提交
3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166

//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]
}

X
xuchenghua09 已提交
3167
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
Z
zhaoyuan17 已提交
3168
	console.info("==========================>getWantAgentCallback=======================>");
X
xuchenghua09 已提交
3169 3170
    wantAgent1 = data;
    wantAgent2 = data;
Z
zhaoyuan17 已提交
3171 3172
});

X
xuchenghua09 已提交
3173
WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
Z
zhaoyuan17 已提交
3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
	console.info("==========================>equalCallback=======================>");
});
```



####