1# Notification模块 2 3>  **说明：** 4> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5 6## 导入模块 7 8```js 9import Notification from '@ohos.notification'; 10``` 11 12## Notification.publish 13 14publish(request: NotificationRequest, callback: AsyncCallback\<void\>): void 15 16发布通知（callback形式）。 17 18**系统能力**：SystemCapability.Notification.Notification 19 20**参数：** 21 22| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 23| -------- | ---- | ---- | ------------------------------------------- | ---- | ------------------------------------------- | 24| request | 是 | 否 |[NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | 25| callback | 是 | 否 |AsyncCallback\<void\> | 是 | 被指定的回调方法。 | 26 27**示例：** 28 29```js 30//publish回调 31function publishCallback(err) { 32 console.info("==========================>publishCallback=======================>"); 33} 34//通知Request对象 35var notificationRequest = { 36 id: 1, 37 content: { 38 contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, 39 normal: { 40 title: "test_title", 41 text: "test_text", 42 additionalText: "test_additionalText" 43 } 44 } 45} 46Notification.publish(notificationRequest, publishCallback) 47``` 48 49 50 51## Notification.publish 52 53publish(request: NotificationRequest): Promise\<void\> 54 55发布通知（Promise形式）。 56 57**系统能力**：SystemCapability.Notification.Notification 58 59**示例：** 60 61```js 62//通知Request对象 63var notificationRequest = { 64 notificationId: 1, 65 content: { 66 contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, 67 normal: { 68 title: "test_title", 69 text: "test_text", 70 additionalText: "test_additionalText" 71 } 72 } 73} 74Notification.publish(notificationRequest).then(() => { 75 console.info("==========================>publishCallback=======================>"); 76}); 77 78``` 79 80## Notification.publish<sup>8+</sup> 81 82publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<void\>): void 83 84发布通知（callback形式）。 85 86**系统能力**：SystemCapability.Notification.Notification 87 88**参数：** 89 90| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 91| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- | 92| request | 是 | 否 |[NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | 93| userId | 是 | 否 |number | 是 | 接收通知用户的Id。 | 94| callback | 是 | 否 |AsyncCallback\<void\> | 是 | 被指定的回调方法。 | 95 96**示例：** 97 98```js 99//publish回调 100function publishCallback(err) { 101 console.info("==========================>publishCallback=======================>"); 102} 103// 接收通知的用户ID 104var userId = 1 105//通知Request对象 106var notificationRequest = { 107 id: 1, 108 content: { 109 contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, 110 normal: { 111 title: "test_title", 112 text: "test_text", 113 additionalText: "test_additionalText" 114 } 115 } 116} 117Notification.publish(notificationRequest, userId, publishCallback); 118``` 119 120## Notification.publish<sup>8+</sup> 121 122publish(request: NotificationRequest, userId: number): Promise\<void\> 123 124发布通知（Promise形式）。 125 126**系统能力**：SystemCapability.Notification.Notification 127 128**参数：** 129 130| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 131| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- | 132| request | 是 | 否 |[NotificationRequest](#notificationrequest) | 是 | 设置要发布通知内容的NotificationRequest对象。 | 133| userId | 是 | 否 |number | 是 | 接收通知用户的Id。 | 134 135**示例：** 136 137```js 138var notificationRequest = { 139 notificationId: 1, 140 content: { 141 contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, 142 normal: { 143 title: "test_title", 144 text: "test_text", 145 additionalText: "test_additionalText" 146 } 147 } 148} 149 150var userId = 1 151 152Notification.publish(notificationRequest, userId).then(() => { 153 console.info("==========================>publishCallback=======================>"); 154}); 155``` 156 157 158## Notification.cancel 159 160cancel(id: number, label: string, callback: AsyncCallback\<void\>): void 161 162取消与指定id和label相匹配的已发布通知（callback形式）。 163 164**系统能力**：SystemCapability.Notification.Notification 165 166**参数：** 167 168| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 169| -------- | --- | ---- | --------------------- | ---- | -------------------- | 170| id | 是 | 否 | number | 是 | 通知ID。 | 171| label | 是 | 否 | string | 是 | 通知标签。 | 172| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 173 174**示例：** 175 176```js 177//cancel回调 178function cancelCallback(err) { 179 console.info("==========================>cancelCallback=======================>"); 180} 181Notification.cancel(0, "label", cancelCallback) 182``` 183 184 185 186## Notification.cancel 187 188cancel(id: number, label?: string): Promise\<void\> 189 190取消与指定id相匹配的已发布通知，label可以指定也可以不指定（Promise形式）。 191 192**系统能力**：SystemCapability.Notification.Notification 193 194**参数：** 195 196| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 197| ----- | --- | ---- | ------ | ---- | -------- | 198| id | 是 | 否 | number | 是 | 通知ID。 | 199| label | 是 | 否 | string | 否 | 通知标签。 | 200 201**示例：** 202 203```js 204Notification.cancel(0).then(() => { 205 console.info("==========================>cancelCallback=======================>"); 206}); 207``` 208 209 210 211## Notification.cancel 212 213cancel(id: number, callback: AsyncCallback\<void\>): void 214 215取消与指定id相匹配的已发布通知（callback形式）。 216 217**系统能力**：SystemCapability.Notification.Notification 218 219**参数：** 220 221| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 222| -------- | ---- | --- | --------------------- | ---- | -------------------- | 223| id | 是 | 否 | number | 是 | 通知ID。 | 224| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 225 226**示例：** 227 228```js 229//cancel回调 230function cancelCallback(err) { 231 console.info("==========================>cancelCallback=======================>"); 232} 233Notification.cancel(0, cancelCallback) 234``` 235 236 237 238## Notification.cancelAll 239 240cancelAll(callback: AsyncCallback\<void\>): void 241 242取消所有已发布的通知（callback形式）。 243 244**系统能力**：SystemCapability.Notification.Notification 245 246**参数：** 247 248| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 249| -------- | ---- | --- | --------------------- | ---- | -------------------- | 250| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 251 252**示例：** 253 254```js 255//cancel回调 256function cancelAllCallback(err) { 257 console.info("==========================>cancelAllCallback=======================>"); 258} 259Notification.cancelAll(cancelAllCallback) 260``` 261 262 263 264## Notification.cancelAll 265 266cancelAll(): Promise\<void\> 267 268取消所有已发布的通知（Promise形式）。 269 270**系统能力**：SystemCapability.Notification.Notification 271 272**示例：** 273 274```js 275Notification.cancelAll().then(() => { 276 console.info("==========================>cancelAllCallback=======================>"); 277}); 278``` 279 280 281 282## Notification.addSlot 283 284addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>): void 285 286创建通知通道（callback形式）。 287 288**系统能力**：SystemCapability.Notification.Notification 289 290**参数：** 291 292| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 293| -------- | ---- | --- | --------------------- | ---- | -------------------- | 294| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 要创建的通知通道对象。 | 295| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 296 297**示例：** 298 299```js 300//addslot回调 301function addSlotCallBack(err) { 302 console.info("==========================>addSlotCallBack=======================>"); 303} 304//通知slot对象 305var notificationSlot = { 306 type: Notification.SlotType.SOCIAL_COMMUNICATION 307} 308Notification.addSlot(notificationSlot, addSlotCallBack) 309``` 310 311 312 313## Notification.addSlot 314 315addSlot(slot: NotificationSlot): Promise\<void\> 316 317创建通知通道（Promise形式）。 318 319**系统能力**：SystemCapability.Notification.Notification 320 321**参数：** 322 323| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 324| ---- | ---- | --- | ---------------- | ---- | -------------------- | 325| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 要创建的通知通道对象。 | 326 327**示例：** 328 329```js 330//通知slot对象 331var notificationSlot = { 332 type: Notification.SlotType.SOCIAL_COMMUNICATION 333} 334Notification.addSlot(notificationSlot).then(() => { 335 console.info("==========================>addSlotCallback=======================>"); 336}); 337``` 338 339 340 341## Notification.addSlot 342 343addSlot(type: SlotType, callback: AsyncCallback\<void\>): void 344 345创建通知通道（callback形式）。 346 347**系统能力**：SystemCapability.Notification.Notification 348 349**参数：** 350 351| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 352| -------- | ---- | --- | --------------------- | ---- | ---------------------- | 353| type | 是 | 否 | [SlotType](#slottype) | 是 | 要创建的通知通道的类型。 | 354| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 355 356**示例：** 357 358```js 359//addslot回调 360function addSlotCallBack(err) { 361 console.info("==========================>addSlotCallBack=======================>"); 362} 363Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack) 364``` 365 366 367 368## Notification.addSlot 369 370addSlot(type: SlotType): Promise\<void\> 371 372创建通知通道（Promise形式）。 373 374**系统能力**：SystemCapability.Notification.Notification 375 376**参数：** 377 378| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 379| ---- | ---- | --- | -------- | ---- | ---------------------- | 380| type | 是 | 否 | [SlotType](#slottype) | 是 | 要创建的通知通道的类型。 | 381 382**示例：** 383 384```js 385Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => { 386 console.info("==========================>addSlotCallback=======================>"); 387}); 388``` 389 390 391 392## Notification.addSlots 393 394addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>): void 395 396创建多个通知通道（callback形式）。 397 398**系统能力**：SystemCapability.Notification.Notification 399 400**参数：** 401 402| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 403| -------- | ---- | --- | ------------------------- | ---- | ------------------------ | 404| slots | 是 | 否 | Array\<[NotificationSlot](#notificationslot)\> | 是 | 要创建的通知通道对象数组。 | 405| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 406 407**示例：** 408 409```js 410//addSlots回调 411function addSlotsCallBack(err) { 412 console.info("==========================>addSlotsCallBack=======================>"); 413} 414//通知slot对象 415var notificationSlot = { 416 type: Notification.SlotType.SOCIAL_COMMUNICATION 417} 418//通知slot array 对象 419var notificationSlotArray = new Array(); 420notificationSlotArray[0] = notificationSlot; 421 422Notification.addSlots(notificationSlotArray, addSlotsCallBack) 423``` 424 425 426 427## Notification.addSlots 428 429addSlots(slots: Array\<NotificationSlot\>): Promise\<void\> 430 431创建多个通知通道（Promise形式）。 432 433**系统能力**：SystemCapability.Notification.Notification 434 435**参数：** 436 437| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 438| ----- | ---- | --- | ------------------------- | ---- | ------------------------ | 439| slots | 是 | 否 | Array\<[NotificationSlot](#notificationslot)\> | 是 | 要创建的通知通道对象数组。 | 440 441**示例：** 442 443```js 444//通知slot对象 445var notificationSlot = { 446 type: Notification.SlotType.SOCIAL_COMMUNICATION 447} 448//通知slot array 对象 449var notificationSlotArray = new Array(); 450notificationSlotArray[0] = notificationSlot; 451 452Notification.addSlots(notificationSlotArray).then(() => { 453 console.info("==========================>addSlotCallback=======================>"); 454}); 455``` 456 457 458 459## Notification.getSlot 460 461getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>): void 462 463获取一个通知通道（callback形式）。 464 465**系统能力**：SystemCapability.Notification.Notification 466 467**参数：** 468 469| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 470| -------- | ---- | --- | --------------------------------- | ---- | ----------------------------------------------------------- | 471| slotType | 是 | 否 | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | 472| callback | 是 | 否 | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是 | 表示被指定的回调方法。 | 473 474**示例：** 475 476```js 477//getSlot回调 478function getSlotCallback(err,data) { 479 console.info("==========================>getSlotCallback=======================>"); 480} 481var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; 482Notification.getSlot(slotType, getSlotCallback) 483``` 484 485 486 487## Notification.getSlot 488 489getSlot(slotType: SlotType): Promise\<NotificationSlot\> 490 491获取一个通知通道（Promise形式）。 492 493**系统能力**：SystemCapability.Notification.Notification 494 495**参数：** 496 497| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 498| -------- | ---- | --- | -------- | ---- | ----------------------------------------------------------- | 499| slotType | 是 | 否 | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | 500 501**返回值：** 502 503| 类型 | 说明 | 504| ----------------------------------------------------------- | ------------------------------------------------------------ | 505| Promise\<NotificationSlot\> | 以Promise形式返回获取一个通知通道。 | 506 507**示例：** 508 509```js 510var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; 511Notification.getSlot(slotType).then((data) => { 512 console.info("==========================>getSlotCallback=======================>"); 513}); 514``` 515 516 517 518## Notification.getSlots 519 520getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>): void 521 522获取此应用程序的所有通知通道（callback形式）。 523 524**系统能力**：SystemCapability.Notification.Notification 525 526**参数：** 527 528| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 529| -------- | ---- | --- | --------------------------------- | ---- | -------------------- | 530| callback | 是 | 否 | AsyncCallback\<Array\<[NotificationSlot](#notificationslot)\>\> | 是 | 表示被指定的回调方法。 | 531 532**示例：** 533 534```js 535//getSlots回调 536function getSlotsCallback(err,data) { 537 console.info("==========================>getSlotsCallback=======================>"); 538} 539Notification.getSlots(getSlotsCallback) 540``` 541 542 543 544## Notification.getSlots 545 546getSlots(): Promise\<Array\<NotificationSlot\>> 547 548获取此应用程序的所有通知通道（Promise形式）。 549 550**系统能力**：SystemCapability.Notification.Notification 551 552**返回值：** 553 554| 类型 | 说明 | 555| ----------------------------------------------------------- | ------------------------------------------------------------ | 556| Promise\<Array\<[NotificationSlot](#notificationslot)\>\> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 | 557 558**示例：** 559 560```js 561Notification.getSlots().then((data) => { 562 console.info("==========================>getSlotsCallback=======================>"); 563}); 564``` 565 566 567 568## Notification.removeSlot 569 570removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>): void 571 572根据通知通道类型删除创建的通知通道（callback形式）。 573 574**系统能力**：SystemCapability.Notification.Notification 575 576**参数：** 577 578| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 579| -------- | ---- | --- | --------------------- | ---- | ----------------------------------------------------------- | 580| slotType | 是 | 否 | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | 581| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 582 583**示例：** 584 585```js 586//removeSlot回调 587function removeSlotCallback(err) { 588 console.info("==========================>removeSlotCallback=======================>"); 589} 590var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; 591Notification.removeSlot(slotType,removeSlotCallback) 592``` 593 594 595 596## Notification.removeSlot 597 598removeSlot(slotType: SlotType): Promise\<void\> 599 600根据通知通道类型删除创建的通知通道（Promise形式）。 601 602**系统能力**：SystemCapability.Notification.Notification 603 604**参数：** 605 606| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 607| -------- | ---- | --- | -------- | ---- | ----------------------------------------------------------- | 608| slotType | 是 | 否 | [SlotType](#slottype) | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 | 609 610**示例：** 611 612```js 613var slotType = Notification.SlotType.SOCIAL_COMMUNICATION; 614Notification.removeSlot(slotType).then(() => { 615 console.info("==========================>removeSlotCallback=======================>"); 616}); 617``` 618 619 620 621## Notification.removeAllSlots 622 623removeAllSlots(callback: AsyncCallback\<void\>): void 624 625删除所有通知通道（callback形式）。 626 627**系统能力**：SystemCapability.Notification.Notification 628 629**参数：** 630 631| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 632| -------- | ---- | --- | --------------------- | ---- | -------------------- | 633| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法。 | 634 635**示例：** 636 637```js 638function removeAllCallBack(err) { 639 console.info("================>removeAllCallBack=======================>"); 640} 641Notification.removeAllSlots(removeAllCallBack) 642``` 643 644 645 646## Notification.removeAllSlots 647 648removeAllSlots(): Promise\<void\> 649 650删除所有通知通道（Promise形式）。 651 652**系统能力**：SystemCapability.Notification.Notification 653 654**示例：** 655 656```js 657Notification.removeAllSlots().then(() => { 658 console.info("==========================>removeAllCallBack=======================>"); 659}); 660``` 661 662 663 664## Notification.subscribe 665 666subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>): void 667 668订阅通知并指定订阅信息（callback形式）。 669 670**系统能力**：SystemCapability.Notification.Notification 671 672**参数：** 673 674| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 675| ---------- | ---- | --- | ------------------------- | ---- | ---------------- | 676| subscriber | 是 | 否 | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | 677| info | 是 | 否 | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是 | 订阅信息。 | 678| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 订阅动作回调函数。 | 679 680**示例：** 681 682```js 683//subscribe回调 684function subscribeCallback(err) { 685 console.info("==========================>subscribeCallback=======================>"); 686} 687function onConsumeCallback(err, data) { 688 console.info("==========================>onConsumeCallback=======================>"); 689} 690var subscriber = { 691 onConsume: onConsumeCallback 692} 693var info = { 694 bundleNames: ["bundleName1","bundleName2"] 695} 696Notification.subscribe(subscriber, info, subscribeCallback); 697``` 698 699 700 701## Notification.subscribe 702 703subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>): void 704 705订阅通知并指定订阅信息（callback形式）。 706 707**系统能力**：SystemCapability.Notification.Notification 708 709**参数：** 710 711| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 712| ---------- | ---- | --- | ---------------------- | ---- | ---------------- | 713| subscriber | 是 | 否 | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | 714| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 订阅动作回调函数。 | 715 716**示例：** 717 718```js 719function subscribeCallback(err) { 720 console.info("==========================>subscribeCallback=======================>"); 721} 722function onConsumeCallback(err, data) { 723 console.info("==========================>onConsumeCallback=======================>"); 724} 725var subscriber = { 726 onConsume: onConsumeCallback 727} 728Notification.subscribe(subscriber, subscribeCallback); 729``` 730 731 732 733## Notification.subscribe 734 735subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise\<void\> 736 737订阅通知并指定订阅信息（Promise形式）。 738 739**系统能力**：SystemCapability.Notification.Notification 740 741**参数：** 742 743| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 744| ---------- | ---- | --- | ------------------------- | ---- | ------------ | 745| subscriber | 是 | 否 | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | 746| info | 是 | 否 | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否 | 订阅信息。 | 747 748**示例：** 749 750```js 751function onConsumeCallback(err, data) { 752 console.info("==========================>onConsumeCallback=======================>"); 753} 754var subscriber = { 755 onConsume: onConsumeCallback 756}; 757Notification.subscribe(subscriber).then(() => { 758 console.info("==========================>subscribeCallback=======================>"); 759}); 760``` 761 762 763 764## Notification.unsubscribe 765 766unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>): void 767 768取消订阅（callbcak形式）。 769 770**系统能力**：SystemCapability.Notification.Notification 771 772**参数：** 773 774| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 775| ---------- | ---- | --- | ---------------------- | ---- | -------------------- | 776| subscriber | 是 | 否 | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | 777| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 取消订阅动作回调函数。 | 778 779**示例：** 780 781```js 782function unsubscribeCallback(err) { 783 console.info("==========================>unsubscribeCallback=======================>"); 784} 785function onConsumeCallback(err, data) { 786 console.info("==========================>onConsumeCallback=======================>"); 787} 788var subscriber = { 789 onConsume: onConsumeCallback 790} 791Notification.unsubscribe(subscriber, unsubscribeCallback); 792``` 793 794 795 796## Notification.unsubscribe 797 798unsubscribe(subscriber: NotificationSubscriber): Promise\<void\> 799 800取消订阅（Promise形式）。 801 802**系统能力**：SystemCapability.Notification.Notification 803 804**参数：** 805 806| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 807| ---------- | ---- | --- | ---------------------- | ---- | ------------ | 808| subscriber | 是 | 否 | [NotificationSubscriber](#notificationsubscriber) | 是 | 通知订阅对象。 | 809 810**示例：** 811 812```js 813function onConsumeCallback(err, data) { 814 console.info("==========================>onConsumeCallback=======================>"); 815} 816var subscriber = { 817 onConsume: onConsumeCallback 818}; 819Notification.unsubscribe(subscriber).then(() => { 820 console.info("==========================>unsubscribeCallback=======================>"); 821}); 822``` 823 824 825 826## Notification.enableNotification 827 828enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void 829 830设定指定包的通知使能状态（Callback形式）。 831 832**系统能力**：SystemCapability.Notification.Notification 833 834**参数：** 835 836| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 837| -------- | ---- | --- | --------------------- | ---- | -------------------- | 838| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 839| enable | 是 | 否 | boolean | 是 | 使能状态。 | 840| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 设定通知使能回调函数。 | 841 842**示例：** 843 844```js 845function enableNotificationCallback(err) { 846 console.info("==========================>enableNotificationCallback=======================>"); 847} 848var bundle = { 849 bundle: "bundleName1", 850} 851Notification.enableNotification(bundle, false, enableNotificationCallback); 852``` 853 854 855 856## Notification.enableNotification 857 858enableNotification(bundle: BundleOption, enable: boolean): Promise\<void\> 859 860设定指定包的通知使能状态（Promise形式）。 861 862**系统能力**：SystemCapability.Notification.Notification 863 864**参数：** 865 866| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 867| ------ | ---- | --- | ------------ | ---- | ---------- | 868| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 869| enable | 是 | 否 | boolean | 是 | 使能状态。 | 870 871**示例：** 872 873```js 874var bundle = { 875 bundle: "bundleName1", 876} 877Notification.enableNotification(bundle, false).then(() => { 878 console.info("==========================>enableNotificationCallback=======================>"); 879}); 880``` 881 882 883 884## Notification.isNotificationEnabled 885 886isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void 887 888获取指定包的通知使能状态（Callback形式）。 889 890**系统能力**：SystemCapability.Notification.Notification 891 892**参数：** 893 894| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 895| -------- | ---- | --- | --------------------- | ---- | ------------------------ | 896| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 897| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数。 | 898 899**示例：** 900 901```js 902function isNotificationEnabledCallback(err, data) { 903 console.info("==========================>isNotificationEnabledCallback=======================>"); 904} 905var bundle = { 906 bundle: "bundleName1", 907} 908Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback); 909``` 910 911 912 913## Notification.isNotificationEnabled 914 915isNotificationEnabled(bundle: BundleOption): Promise\<boolean\> 916 917获取指定包的通知使能状态（Promise形式）。 918 919**系统能力**：SystemCapability.Notification.Notification 920 921**参数：** 922 923| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 924| ------ | ---- | --- | ------------ | ---- | ---------- | 925| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 926 927**返回值：** 928 929| 类型 | 说明 | 930| ----------------------------------------------------------- | ------------------------------------------------------------ | 931| Promise\<boolean\> | 以Promise形式返回获取指定包的通知使能状态的结果。 | 932 933**示例：** 934 935```js 936var bundle = { 937 bundle: "bundleName1", 938} 939Notification.isNotificationEnabled(bundle).then((data) => { 940 console.info("==========================>isNotificationEnabledCallback=======================>"); 941}); 942``` 943 944 945 946## Notification.isNotificationEnabled 947 948isNotificationEnabled(callback: AsyncCallback\<boolean\>): void 949 950获取通知使能状态（Callback形式）。 951 952**系统能力**：SystemCapability.Notification.Notification 953 954**参数：** 955 956| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 957| -------- | ---- | --- | --------------------- | ---- | ------------------------ | 958| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数。 | 959 960**示例：** 961 962```js 963function isNotificationEnabledCallback(err, data) { 964 console.info("==========================>isNotificationEnabledCallback=======================>"); 965} 966 967Notification.isNotificationEnabled(isNotificationEnabledCallback); 968``` 969 970 971 972## Notification.isNotificationEnabled 973 974isNotificationEnabled(): Promise\<boolean\> 975 976获取通知使能状态（Promise形式）。 977 978**系统能力**：SystemCapability.Notification.Notification 979 980**参数：** 981 982| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 983| ------ | ---- | --- | ------------ | ---- | ---------- | 984| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 985 986**返回值：** 987 988| 类型 | 说明 | 989| ----------------------------------------------------------- | ------------------------------------------------------------ | 990| Promise\<boolean\> | 以Promise形式返回获取通知使能状态的结果。 | 991 992**示例：** 993 994```js 995Notification.isNotificationEnabled().then((data) => { 996 console.info("==========================>isNotificationEnabledCallback=======================>"); 997}); 998``` 999 1000 1001 1002## Notification.displayBadge 1003 1004displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void 1005 1006设定指定包的角标使能状态（Callback形式）。 1007 1008**系统能力**：SystemCapability.Notification.Notification 1009 1010**参数：** 1011 1012| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1013| -------- | ---- | --- | --------------------- | ---- | -------------------- | 1014| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1015| enable | 是 | 否 | boolean | 是 | 使能状态。 | 1016| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 设定角标使能回调函数。 | 1017 1018**示例：** 1019 1020```js 1021function displayBadgeCallback(err) { 1022 console.info("==========================>displayBadgeCallback=======================>"); 1023} 1024var bundle = { 1025 bundle: "bundleName1", 1026} 1027Notification.displayBadge(bundle, false, displayBadgeCallback); 1028``` 1029 1030 1031 1032## Notification.displayBadge 1033 1034displayBadge(bundle: BundleOption, enable: boolean): Promise\<void\> 1035 1036设定指定包的角标使能状态（Promise形式）。 1037 1038**系统能力**：SystemCapability.Notification.Notification 1039 1040**参数：** 1041 1042| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1043| ------ | ---- | --- | ------------ | ---- | ---------- | 1044| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1045| enable | 是 | 否 | boolean | 是 | 使能状态。 | 1046 1047**示例：** 1048 1049```js 1050var bundle = { 1051 bundle: "bundleName1", 1052} 1053Notification.displayBadge(bundle, false).then(() => { 1054 console.info("==========================>displayBadgeCallback=======================>"); 1055}); 1056``` 1057 1058 1059 1060## Notification.isBadgeDisplayed 1061 1062isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void 1063 1064获取指定包的角标使能状态（Callback形式）。 1065 1066**系统能力**：SystemCapability.Notification.Notification 1067 1068**参数：** 1069 1070| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1071| -------- | ---- | --- | --------------------- | ---- | ------------------------ | 1072| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1073| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 获取角标使能状态回调函数。 | 1074 1075**示例：** 1076 1077```js 1078function isBadgeDisplayedCallback(err, data) { 1079 console.info("==========================>isBadgeDisplayedCallback=======================>"); 1080} 1081var bundle = { 1082 bundle: "bundleName1", 1083} 1084Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); 1085``` 1086 1087 1088 1089## Notification.isBadgeDisplayed 1090 1091isBadgeDisplayed(bundle: BundleOption): Promise\<boolean\> 1092 1093获取指定包的角标使能状态（Promise形式）。 1094 1095**系统能力**：SystemCapability.Notification.Notification 1096 1097**参数：** 1098 1099| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1100| ------ | ---- | --- | ------------ | ---- | ---------- | 1101| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1102 1103**返回值：** 1104 1105| 类型 | 说明 | 1106| ----------------------------------------------------------- | ------------------------------------------------------------ | 1107| Promise\<boolean\> | 以Promise形式返回获取指定包的角标使能状态。 | 1108 1109**示例：** 1110 1111```js 1112var bundle = { 1113 bundle: "bundleName1", 1114} 1115Notification.isBadgeDisplayed(bundle).then((data) => { 1116 console.info("==========================>isBadgeDisplayedCallback=======================>"); 1117}); 1118``` 1119 1120 1121 1122## Notification.setSlotByBundle 1123 1124setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>): void 1125 1126设定指定包的通知通道状态（Callback形式）。 1127 1128**系统能力**：SystemCapability.Notification.Notification 1129 1130**参数：** 1131 1132| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1133| -------- | ---- | --- | --------------------- | ---- | -------------------- | 1134| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1135| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 通知通道。 | 1136| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 设定通知通道回调函数。 | 1137 1138**示例：** 1139 1140```js 1141function setSlotByBundleCallback(err) { 1142 console.info("==========================>setSlotByBundleCallback=======================>"); 1143} 1144var bundle = { 1145 bundle: "bundleName1", 1146} 1147var notificationSlot = { 1148 type: Notification.SlotType.SOCIAL_COMMUNICATION 1149} 1150Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); 1151``` 1152 1153 1154 1155## Notification.setSlotByBundle 1156 1157setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\<void\> 1158 1159设定指定包的角标使能状态（Promise形式）。 1160 1161**系统能力**：SystemCapability.Notification.Notification 1162 1163**参数：** 1164 1165| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1166| ------ | ---- | --- | ------------ | ---- | ---------- | 1167| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1168| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 使能状态。 | 1169 1170**示例：** 1171 1172```js 1173var bundle = { 1174 bundle: "bundleName1", 1175} 1176var notificationSlot = { 1177 type: Notification.SlotType.SOCIAL_COMMUNICATION 1178} 1179Notification.displayBadge(bundle, notificationSlot).then(() => { 1180 console.info("==========================>setSlotByBundleCallback=======================>"); 1181}); 1182``` 1183 1184 1185 1186## Notification.getSlotsByBundle 1187 1188getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>): void 1189 1190获取指定包的通知通道（Callback形式）。 1191 1192**系统能力**：SystemCapability.Notification.Notification 1193 1194**参数：** 1195 1196| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1197| -------- | ---- | --- | ---------------------------------------- | ---- | -------------------- | 1198| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1199| callback | 是 | 否 | AsyncCallback<Array\<[NotificationSlot](#notificationslot)\>> | 是 | 获取通知通道回调函数。 | 1200 1201**示例：** 1202 1203```js 1204function getSlotsByBundleCallback(err, data) { 1205 console.info("==========================>getSlotsByBundleCallback=======================>"); 1206} 1207var bundle = { 1208 bundle: "bundleName1", 1209} 1210Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback); 1211``` 1212 1213 1214 1215## Notification.getSlotsByBundle 1216 1217getSlotsByBundle(bundle: BundleOption): Promise<Array\<NotificationSlot\>> 1218 1219获取指定包的通知通道（Promise形式）。 1220 1221**系统能力**：SystemCapability.Notification.Notification 1222 1223**参数：** 1224 1225| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1226| ------ | ---- | --- | ------------ | ---- | ---------- | 1227| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1228 1229**返回值：** 1230 1231| 类型 | 说明 | 1232| ----------------------------------------------------------- | ------------------------------------------------------------ | 1233| Promise<Array\<[NotificationSlot](#notificationslot)\>> | 以Promise形式返回获取指定包的通知通道。 | 1234 1235**示例：** 1236 1237```js 1238var bundle = { 1239 bundle: "bundleName1", 1240} 1241Notification.getSlotsByBundle(bundle).then((data) => { 1242 console.info("==========================>getSlotsByBundleCallback=======================>"); 1243}); 1244``` 1245 1246 1247 1248## Notification.getSlotNumByBundle 1249 1250getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>): void 1251 1252获取指定包的通知通道数（Callback形式）。 1253 1254**系统能力**：SystemCapability.Notification.Notification 1255 1256**参数：** 1257 1258| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1259| -------- | ---- | --- | ------------------------- | ---- | ---------------------- | 1260| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1261| callback | 是 | 否 | AsyncCallback\<number\> | 是 | 获取通知通道数回调函数。 | 1262 1263**示例：** 1264 1265```js 1266function getSlotNumByBundle(err, data) { 1267 console.info("==========================>getSlotNumByBundleCallback=======================>"); 1268} 1269var bundle = { 1270 bundle: "bundleName1", 1271} 1272Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); 1273``` 1274 1275 1276 1277## Notification.getSlotNumByBundle 1278 1279getSlotNumByBundle(bundle: BundleOption): Promise\<number\> 1280 1281获取指定包的通知通道数（Promise形式）。 1282 1283**系统能力**：SystemCapability.Notification.Notification 1284 1285**参数：** 1286 1287| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1288| ------ | ---- | --- | ------------ | ---- | ---------- | 1289| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1290 1291**返回值：** 1292 1293| 类型 | 说明 | 1294| ----------------------------------------------------------- | ------------------------------------------------------------ | 1295| Promise\<number\> | 以Promise形式返回获取指定包的通知通道数。 | 1296 1297**示例：** 1298 1299```js 1300var bundle = { 1301 bundle: "bundleName1", 1302} 1303Notification.getSlotNumByBundle(bundle).then((data) => { 1304 console.info("==========================>getSlotNumByBundleCallback=======================>"); 1305}); 1306``` 1307 1308 1309 1310## Notification.remove 1311 1312remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>): void 1313 1314删除指定通知（Callback形式）。 1315 1316**系统能力**：SystemCapability.Notification.Notification 1317 1318**参数：** 1319 1320| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1321| --------------- | ---- | --- | ----------------------------------- | ---- | -------------------- | 1322| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1323| notificationKey | 是 | 否 | [NotificationKey](#notificationkey) | 是 | 通知键值。 | 1324| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数。 | 1325 1326**示例：** 1327 1328```js 1329function removeCallback(err) { 1330 console.info("==========================>removeCallback=======================>"); 1331} 1332var bundle = { 1333 bundle: "bundleName1", 1334} 1335var notificationKey = { 1336 id: 0, 1337 label: "label", 1338} 1339Notification.remove(bundle, notificationKey, removeCallback); 1340``` 1341 1342 1343 1344## Notification.remove 1345 1346remove(bundle: BundleOption, notificationKey: NotificationKey): Promise\<void\> 1347 1348删除指定通知（Promise形式）。 1349 1350**系统能力**：SystemCapability.Notification.Notification 1351 1352**参数：** 1353 1354| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1355| --------------- | ---- | --- | --------------- | ---- | ---------- | 1356| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1357| notificationKey | 是 | 否 | [NotificationKey](#notificationkey) | 是 | 通知键值。 | 1358 1359**示例：** 1360 1361```js 1362var bundle = { 1363 bundle: "bundleName1", 1364} 1365var notificationKey = { 1366 id: 0, 1367 label: "label", 1368} 1369Notification.remove(bundle, notificationKey).then(() => { 1370 console.info("==========================>removeCallback=======================>"); 1371}); 1372``` 1373 1374 1375 1376## Notification.remove 1377 1378remove(hashCode: string, callback: AsyncCallback\<void\>): void 1379 1380删除指定通知（Callback形式）。 1381 1382**系统能力**：SystemCapability.Notification.Notification 1383 1384**参数：** 1385 1386| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1387| -------- | ---- | --- | --------------------- | ---- | -------------------- | 1388| hashCode | 是 | 否 | string | 是 | 通知唯一ID。 | 1389| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数。 | 1390 1391**示例：** 1392 1393```js 1394function removeCallback(err) { 1395 console.info("==========================>removeCallback=======================>"); 1396} 1397 1398Notification.remove(hashCode, removeCallback); 1399``` 1400 1401 1402 1403## Notification.remove 1404 1405remove(hashCode: string): Promise\<void\> 1406 1407删除指定通知（Promise形式）。 1408 1409**系统能力**：SystemCapability.Notification.Notification 1410 1411**参数：** 1412 1413| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1414| -------- | ---- | --- | ---------- | ---- | ---------- | 1415| hashCode | 是 | 否 | string | 是 | 通知唯一ID。 | 1416 1417**示例：** 1418 1419```js 1420Notification.remove(hashCode).then(() => { 1421 console.info("==========================>removeCallback=======================>"); 1422}); 1423``` 1424 1425 1426 1427## Notification.removeAll 1428 1429removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>): void 1430 1431删除指定包的所有通知（Callback形式）。 1432 1433**系统能力**：SystemCapability.Notification.Notification 1434 1435**参数：** 1436 1437| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1438| -------- | ---- | --- | --------------------- | ---- | ---------------------------- | 1439| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1440| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除指定包的所有通知回调函数。 | 1441 1442**示例：** 1443 1444```js 1445function removeAllCallback(err) { 1446 console.info("==========================>removeAllCallback=======================>"); 1447} 1448var bundle = { 1449 bundle: "bundleName1", 1450} 1451Notification.removeAll(bundle, removeAllCallback); 1452``` 1453 1454 1455 1456## Notification.removeAll 1457 1458removeAll(callback: AsyncCallback\<void\>): void 1459 1460删除所有通知（Callback形式）。 1461 1462**系统能力**：SystemCapability.Notification.Notification 1463 1464**参数：** 1465 1466| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1467| -------- | ---- | --- | --------------------- | ---- | -------------------- | 1468| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除所有通知回调函数。 | 1469 1470**示例：** 1471 1472```js 1473function removeAllCallback(err) { 1474 console.info("==========================>removeAllCallback=======================>"); 1475} 1476 1477Notification.removeAll(removeAllCallback); 1478``` 1479 1480 1481 1482## Notification.removeAll 1483 1484removeAll(bundle?: BundleOption): Promise\<void\> 1485 1486删除所有通知（Promise形式）。 1487 1488**系统能力**：SystemCapability.Notification.Notification 1489 1490**参数：** 1491 1492| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1493| ------ | ---- | --- | ------------ | ---- | ---------- | 1494| bundle | 是 | 否 | [BundleOption](#bundleoption) | 否 | 指定包信息。 | 1495 1496**示例：** 1497 1498```js 1499Notification.removeAll().then(() => { 1500 console.info("==========================>removeAllCallback=======================>"); 1501}); 1502``` 1503 1504## Notification.removeAll<sup>8+</sup> 1505 1506removeAll(userId: number, callback: AsyncCallback\<void>): void 1507 1508删除所有通知（callback形式）。 1509 1510**系统能力**：SystemCapability.Notification.Notification 1511 1512**参数：** 1513 1514| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1515| ------ | ---- | --- | ------------ | ---- | ---------- | 1516| userId | 是 | 否 | number | 是 | 接收通知用户的Id。 | 1517| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除所有通知回调函数。 | 1518 1519**示例：** 1520 1521```js 1522function removeAllCallback(err) { 1523 console.info("==========================>removeAllCallback=======================>"); 1524} 1525 1526var userId = 1 1527 1528Notification.removeAll(userId, removeAllCallback); 1529``` 1530 1531## Notification.removeAll<sup>8+</sup> 1532 1533removeAll(userId: number): Promise\<void> 1534 1535删除所有通知（Promise形式）。 1536 1537**系统能力**：SystemCapability.Notification.Notification 1538 1539**参数：** 1540 1541| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1542| ------ | ---- | --- | ------------ | ---- | ---------- | 1543| userId | 是 | 否 | number | 是 | 接收通知用户的Id。 | 1544 1545**示例：** 1546 1547```js 1548function removeAllCallback(err) { 1549 console.info("==========================>removeAllCallback=======================>"); 1550} 1551 1552var userId = 1 1553 1554Notification.removeAll(userId, removeAllCallback); 1555``` 1556 1557 1558## Notification.getAllActiveNotifications 1559 1560getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void 1561 1562获取活动通知（Callback形式）。 1563 1564**系统能力**：SystemCapability.Notification.Notification 1565 1566**参数：** 1567 1568| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1569| -------- | ---- | --- | ------------------------------------------------------------ | ---- | -------------------- | 1570| callback | 是 | 否 | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是 | 获取活动通知回调函数。 | 1571 1572**示例：** 1573 1574```js 1575function getAllActiveNotificationsCallback(err, data) { 1576 console.info("==========================>getAllActiveNotificationsCallback=======================>"); 1577} 1578 1579Notification.getAllActiveNotifications(getAllActiveNotificationsCallback); 1580``` 1581 1582 1583 1584## Notification.getAllActiveNotifications 1585 1586getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> 1587 1588获取活动通知（Promise形式）。 1589 1590**系统能力**：SystemCapability.Notification.Notification 1591 1592**返回值：** 1593 1594| 类型 | 说明 | 1595| ----------------------------------------------------------- | ------------------------------------------------------------ | 1596| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取活动通知。 | 1597 1598**示例：** 1599 1600```js 1601Notification.getAllActiveNotifications().then((data) => { 1602 console.info("==========================>getAllActiveNotificationsCallback=======================>"); 1603}); 1604``` 1605 1606 1607 1608## Notification.getActiveNotificationCount 1609 1610getActiveNotificationCount(callback: AsyncCallback\<number\>): void 1611 1612获取当前应用的活动通知数（Callback形式）。 1613 1614**系统能力**：SystemCapability.Notification.Notification 1615 1616**参数：** 1617 1618| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1619| -------- | ---- | --- | ---------------------- | ---- | ---------------------- | 1620| callback | 是 | 否 | AsyncCallback\<number\> | 是 | 获取活动通知数回调函数。 | 1621 1622**示例：** 1623 1624```js 1625function getActiveNotificationCountCallback(err, data) { 1626 console.info("==========================>getActiveNotificationCountCallback=======================>"); 1627} 1628 1629Notification.getActiveNotificationCount(getActiveNotificationCountCallback); 1630``` 1631 1632 1633 1634## Notification.getActiveNotificationCount 1635 1636getActiveNotificationCount(): Promise\<number\> 1637 1638获取当前应用的活动通知数（Promise形式）。 1639 1640**系统能力**：SystemCapability.Notification.Notification 1641 1642**返回值：** 1643 1644| 类型 | 说明 | 1645| ----------------------------------------------------------- | ------------------------------------------------------------ | 1646| Promise\<number\> | 以Promise形式返回获取当前应用的活动通知数。 | 1647 1648**示例：** 1649 1650```js 1651Notification.getActiveNotificationCount().then((data) => { 1652 console.info("==========================>getActiveNotificationCountCallback=======================>"); 1653}); 1654``` 1655 1656 1657 1658## Notification.getActiveNotifications 1659 1660getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void 1661 1662获取当前应用的活动通知（Callback形式）。 1663 1664**系统能力**：SystemCapability.Notification.Notification 1665 1666**参数：** 1667 1668| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1669| -------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------------------ | 1670| callback | 是 | 否 | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是 | 获取当前应用的活动通知回调函数。 | 1671 1672**示例：** 1673 1674```js 1675function getActiveNotificationsCallback(err, data) { 1676 console.info("==========================>getActiveNotificationsCallback=======================>"); 1677} 1678 1679Notification.getActiveNotifications(getActiveNotificationsCallback); 1680``` 1681 1682 1683 1684## Notification.getActiveNotifications 1685 1686getActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> 1687 1688获取当前应用的活动通知（Promise形式）。 1689 1690**系统能力**：SystemCapability.Notification.Notification 1691 1692**返回值：** 1693 1694| 类型 | 说明 | 1695| ----------------------------------------------------------- | ------------------------------------------------------------ | 1696| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取当前应用的活动通知。 | 1697 1698**示例：** 1699 1700```js 1701Notification.getActiveNotifications().then((data) => { 1702 console.info("==========================>getActiveNotificationsCallback=======================>"); 1703}); 1704``` 1705 1706 1707 1708## Notification.cancelGroup<sup>8+</sup> 1709 1710cancelGroup(groupName: string, callback: AsyncCallback\<void\>): void 1711 1712取消本应用指定组通知（Callback形式）。 1713 1714**系统能力**：SystemCapability.Notification.Notification 1715 1716**参数：** 1717 1718| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1719| --------- | ---- | --- | --------------------- | ---- | ---------------------------- | 1720| groupName | 是 | 否 | string | 是 | 指定通知组名称。 | 1721| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 取消本应用指定组通知回调函数。 | 1722 1723**示例：** 1724 1725```js 1726function cancelGroupCallback(err) { 1727 console.info("==========================>cancelGroupCallback=======================>"); 1728} 1729 1730var groupName = "GroupName"; 1731 1732Notification.cancelGroup(groupName, cancelGroupCallback); 1733``` 1734 1735 1736 1737## Notification.cancelGroup<sup>8+</sup> 1738 1739cancelGroup(groupName: string): Promise\<void\> 1740 1741取消本应用指定组通知（Promise形式）。 1742 1743**系统能力**：SystemCapability.Notification.Notification 1744 1745**参数：** 1746 1747| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1748| --------- | ---- | --- | ------ | ---- | -------------- | 1749| groupName | 是 | 否 | string | 是 | 指定通知组名称。 | 1750 1751**示例：** 1752 1753```js 1754var groupName = "GroupName"; 1755Notification.cancelGroup(groupName).then(() => { 1756 console.info("==========================>cancelGroupPromise=======================>"); 1757}); 1758``` 1759 1760 1761 1762## Notification.removeGroupByBundle<sup>8+</sup> 1763 1764removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>): void 1765 1766删除指定应用指定组通知（Callback形式）。 1767 1768**系统能力**：SystemCapability.Notification.Notification 1769 1770**参数：** 1771 1772| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1773| --------- | ---- | --- | --------------------- | ---- | ---------------------------- | 1774| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1775| groupName | 是 | 否 | string | 是 | 指定通知组名称。 | 1776| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 删除本应用指定组通知回调函数。 | 1777 1778**示例：** 1779 1780```js 1781function removeGroupByBundleCallback(err) { 1782 console.info("==========================>removeGroupByBundleCallback=======================>"); 1783} 1784 1785var bundleOption = {bundle: "Bundle"}; 1786var groupName = "GroupName"; 1787 1788Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback); 1789``` 1790 1791 1792 1793## Notification.removeGroupByBundle<sup>8+</sup> 1794 1795removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\<void\> 1796 1797删除指定应用指定组通知（Promise形式）。 1798 1799**系统能力**：SystemCapability.Notification.Notification 1800 1801**参数：** 1802 1803| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1804| --------- | ---- | --- | ------------ | ---- | -------------- | 1805| bundle | 是 | 否 | [BundleOption](#bundleoption) | 是 | 指定包信息。 | 1806| groupName | 是 | 否 | string | 是 | 指定通知组名称。 | 1807 1808**示例：** 1809 1810```js 1811var bundleOption = {bundle: "Bundle"}; 1812var groupName = "GroupName"; 1813Notification.removeGroupByBundle(bundleOption, groupName).then(() => { 1814 console.info("==========================>removeGroupByBundlePromise=======================>"); 1815}); 1816``` 1817 1818 1819 1820## Notification.setDoNotDisturbDate<sup>8+</sup> 1821 1822setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>): void 1823 1824设置免打扰时间（Callback形式）。 1825 1826**系统能力**：SystemCapability.Notification.Notification 1827 1828**参数：** 1829 1830| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1831| -------- | ---- | --- | --------------------- | ---- | ---------------------- | 1832| date | 是 | 否 | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | 1833| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 设置免打扰时间回调函数。 | 1834 1835**示例：** 1836 1837```js 1838function setDoNotDisturbDateCallback(err) { 1839 console.info("==========================>setDoNotDisturbDateCallback=======================>"); 1840} 1841 1842var doNotDisturbDate = { 1843 type: Notification.DoNotDisturbType.TYPE_ONCE, 1844 begin: new Date(), 1845 end: new Date(2021, 11, 15, 18, 0) 1846} 1847 1848Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); 1849``` 1850 1851 1852 1853## Notification.setDoNotDisturbDate<sup>8+</sup> 1854 1855setDoNotDisturbDate(date: DoNotDisturbDate): Promise\<void\> 1856 1857设置免打扰时间接口（Promise形式）。 1858 1859**系统能力**：SystemCapability.Notification.Notification 1860 1861**参数：** 1862 1863| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1864| ---- | ---- | --- | ---------------- | ---- | -------------- | 1865| date | 是 | 否 | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | 1866 1867**示例：** 1868 1869```js 1870var doNotDisturbDate = { 1871 type: Notification.DoNotDisturbType.TYPE_ONCE, 1872 begin: new Date(), 1873 end: new Date(2021, 11, 15, 18, 0) 1874} 1875Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => { 1876 console.info("==========================>setDoNotDisturbDatePromise=======================>"); 1877}); 1878``` 1879 1880 1881## Notification.setDoNotDisturbDate<sup>8+</sup> 1882 1883setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback\<void\>): void 1884 1885指定用户设置免打扰时间（Callback形式）。 1886 1887**系统能力**：SystemCapability.Notification.Notification 1888 1889**参数：** 1890 1891| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1892| -------- | ---- | --- | --------------------- | ---- | ---------------------- | 1893| date | 是 | 否 | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | 1894| userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 | 1895| callback | 是 | 否 | AsyncCallback\<void\> | 是 | 设置免打扰时间回调函数。 | 1896 1897**示例：** 1898 1899```js 1900function setDoNotDisturbDateCallback(err) { 1901 console.info("==========================>setDoNotDisturbDateCallback=======================>"); 1902} 1903 1904var doNotDisturbDate = { 1905 type: Notification.DoNotDisturbType.TYPE_ONCE, 1906 begin: new Date(), 1907 end: new Date(2021, 11, 15, 18, 0) 1908} 1909 1910var userId = 1 1911 1912Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback); 1913``` 1914 1915 1916 1917## Notification.setDoNotDisturbDate<sup>8+</sup> 1918 1919setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\<void\> 1920 1921指定用户设置免打扰时间接口（Promise形式）。 1922 1923**系统能力**：SystemCapability.Notification.Notification 1924 1925**参数：** 1926 1927| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1928| ------ | ---- | --- | ---------------- | ---- | -------------- | 1929| date | 是 | 否 | [DoNotDisturbDate](#donotdisturbdate8) | 是 | 免打扰时间选项。 | 1930| userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 | 1931 1932**示例：** 1933 1934```js 1935var doNotDisturbDate = { 1936 type: Notification.DoNotDisturbType.TYPE_ONCE, 1937 begin: new Date(), 1938 end: new Date(2021, 11, 15, 18, 0) 1939} 1940 1941var userId = 1 1942 1943Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => { 1944 console.info("==========================>setDoNotDisturbDatePromise=======================>"); 1945}); 1946``` 1947 1948 1949## Notification.getDoNotDisturbDate<sup>8+</sup> 1950 1951getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>): void 1952 1953查询免打扰时间接口（Callback形式）。 1954 1955**系统能力**：SystemCapability.Notification.Notification 1956 1957**参数：** 1958 1959| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 1960| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- | 1961| callback | 是 | 否 | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是 | 查询免打扰时间回调函数。 | 1962 1963**示例：** 1964 1965```js 1966function getDoNotDisturbDateCallback(err,data) { 1967 console.info("==========================>getDoNotDisturbDateCallback=======================>"); 1968} 1969 1970Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback); 1971``` 1972 1973 1974 1975## Notification.getDoNotDisturbDate<sup>8+</sup> 1976 1977getDoNotDisturbDate(): Promise\<DoNotDisturbDate\> 1978 1979查询免打扰时间接口（Promise形式）。 1980 1981**系统能力**：SystemCapability.Notification.Notification 1982 1983**返回值：** 1984 1985| 类型 | 说明 | 1986| ----------------------------------------------------------- | ------------------------------------------------------------ | 1987| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 | 1988 1989**示例：** 1990 1991```js 1992Notification.getDoNotDisturbDate().then((data) => { 1993 console.info("==========================>getDoNotDisturbDatePromise=======================>"); 1994}); 1995``` 1996 1997 1998## Notification.getDoNotDisturbDate<sup>8+</sup> 1999 2000getDoNotDisturbDate(userId: number, callback: AsyncCallback\<DoNotDisturbDate\>): void 2001 2002指定用户查询免打扰时间接口（Callback形式）。 2003 2004**系统能力**：SystemCapability.Notification.Notification 2005 2006**参数：** 2007 2008| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2009| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- | 2010| callback | 是 | 否 | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是 | 查询免打扰时间回调函数。 | 2011| userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 | 2012 2013**示例：** 2014 2015```js 2016function getDoNotDisturbDateCallback(err,data) { 2017 console.info("==========================>getDoNotDisturbDateCallback=======================>"); 2018} 2019 2020var userId = 1 2021 2022Notification.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback); 2023``` 2024 2025 2026 2027## Notification.getDoNotDisturbDate<sup>8+</sup> 2028 2029getDoNotDisturbDate(userId: number): Promise\<DoNotDisturbDate\> 2030 2031指定用户查询免打扰时间接口（Promise形式）。 2032 2033**系统能力**：SystemCapability.Notification.Notification 2034 2035**参数：** 2036 2037| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2038| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- | 2039| userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 | 2040 2041**返回值：** 2042 2043| 类型 | 说明 | 2044| ----------------------------------------------------------- | ------------------------------------------------------------ | 2045| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 | 2046 2047**示例：** 2048 2049```js 2050var userId = 1 2051 2052Notification.getDoNotDisturbDate(userId).then((data) => { 2053 console.info("==========================>getDoNotDisturbDatePromise=======================>"); 2054}); 2055``` 2056 2057 2058## Notification.supportDoNotDisturbMode<sup>8+</sup> 2059 2060supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>): void 2061 2062查询是否支持勿扰模式功能（Callback形式）。 2063 2064**系统能力**：SystemCapability.Notification.Notification 2065 2066**参数：** 2067 2068| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2069| -------- | ---- | --- | ------------------------ | ---- | -------------------------------- | 2070| callback | 是 | 否 | AsyncCallback\<boolean\> | 是 | 查询是否支持勿扰模式功能回调函数。 | 2071 2072**示例：** 2073 2074```js 2075function supportDoNotDisturbModeCallback(err,data) { 2076 console.info("==========================>supportDoNotDisturbModeCallback=======================>"); 2077} 2078 2079Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback); 2080``` 2081 2082 2083 2084## Notification.supportDoNotDisturbMode<sup>8+</sup> 2085 2086supportDoNotDisturbMode(): Promise\<boolean\> 2087 2088查询是否支持勿扰模式功能（Promise形式）。 2089 2090**系统能力**：SystemCapability.Notification.Notification 2091 2092**返回值：** 2093 2094| 类型 | 说明 | 2095| ----------------------------------------------------------- | ------------------------------------------------------------ | 2096| Promise\<boolean\> | 以Promise形式返回获取是否支持勿扰模式功能的结果。 | 2097 2098**示例：** 2099 2100```js 2101Notification.supportDoNotDisturbMode().then((data) => { 2102 console.info("==========================>supportDoNotDisturbModePromise=======================>"); 2103}); 2104``` 2105 2106 2107 2108## Notification.isSupportTemplate<sup>8+</sup> 2109 2110isSupportTemplate(templateName: string, callback: AsyncCallback\<boolean\>): void 2111 2112查询模板是否存在（Callback形式）。 2113 2114**系统能力**：SystemCapability.Notification.Notification 2115 2116**参数：** 2117 2118| 参数名 | 类型 | 必填 | 说明 | 2119| ------------ | ------------------------ | ---- | -------------------------- | 2120| templateName | string | 是 | 模板名称。 | 2121| callback | AsyncCallback\<boolean\> | 是 | 查询模板是否存在的回调函数。 | 2122 2123**示例：** 2124 2125```javascript 2126var templateName = 'process'; 2127function isSupportTemplateCallback(err, data) { 2128 console.info("isSupportTemplateCallback"); 2129} 2130 2131Notification.isSupportTemplate(templateName, isSupportTemplateCallback); 2132``` 2133 2134 2135 2136## Notification.isSupportTemplate<sup>8+</sup> 2137 2138isSupportTemplate(templateName: string): Promise\<boolean\> 2139 2140查询模板是否存在（Promise形式）。 2141 2142**系统能力**：SystemCapability.Notification.Notification 2143 2144**参数：** 2145 2146| 参数名 | 类型 | 必填 | 说明 | 2147| ------------ | ------ | ---- | -------- | 2148| templateName | string | 是 | 模板名称。 | 2149 2150**返回值：** 2151 2152| 类型 | 说明 | 2153| ------------------ | --------------- | 2154| Promise\<boolean\> | Promise方式返回模板是否存在的结果。 | 2155 2156**示例：** 2157 2158```javascript 2159var templateName = 'process'; 2160 2161Notification.isSupportTemplate(templateName).then((data) => { 2162 console.info("isSupportTemplateCallback"); 2163}); 2164``` 2165 2166 2167 2168## Notification.requestEnableNotification<sup>8+</sup> 2169 2170requestEnableNotification(callback: AsyncCallback\<void\>): void 2171 2172应用请求通知使能（Callback形式）。 2173 2174**系统能力**：SystemCapability.Notification.Notification 2175 2176**参数：** 2177 2178| 参数名 | 类型 | 必填 | 说明 | 2179| -------- | ------------------------ | ---- | -------------------------- | 2180| callback | AsyncCallback\<void\> | 是 | 应用请求通知使能的回调函数。 | 2181 2182**示例：** 2183 2184```javascript 2185function requestEnabledNotificationCallback() { 2186 console.log('------------- requestEnabledNotification --------------'); 2187}; 2188 2189Notification.requestEnabledNotification(requestEnabledNotificationCallback); 2190``` 2191 2192 2193 2194## Notification.requestEnableNotification<sup>8+</sup> 2195 2196requestEnableNotification(): Promise\<void\> 2197 2198应用请求通知使能（Promise形式）。 2199 2200**系统能力**：SystemCapability.Notification.Notification 2201 2202**示例：** 2203 2204```javascript 2205Notification.requestEnableNotification() 2206 .then(() => { 2207 console.info("requestEnableNotification "); 2208 }); 2209``` 2210 2211 2212## Notification.enableDistributed<sup>8+</sup> 2213 2214enableDistributed(enable: boolean, callback: AsyncCallback\<void\>): void 2215 2216设置设备是否支持分布式通知（Callback形式）。 2217 2218**系统能力**：SystemCapability.Notification.Notification 2219 2220**参数：** 2221 2222| 参数名 | 类型 | 必填 | 说明 | 2223| -------- | ------------------------ | ---- | -------------------------- | 2224| enable | boolean | 是 | 是否支持。<br/>true 支持。<br/>false 不支持。| 2225| callback | AsyncCallback\<void\> | 是 | 设置设备是否支持分布式通知的回调函数。 | 2226 2227**示例：** 2228 2229```javascript 2230function enabledNotificationCallback() { 2231 console.log('----------- enableDistributed ------------'); 2232}; 2233 2234var enable = true 2235 2236Notification.enableDistributed(enable, enabledNotificationCallback); 2237``` 2238 2239 2240 2241## Notification.enableDistributed<sup>8+</sup> 2242 2243enableDistributed(enable: boolean): Promise\<void> 2244 2245设置设备是否支持分布式通知（Promise形式）。 2246 2247**系统能力**：SystemCapability.Notification.Notification 2248 2249**参数：** 2250 2251| 参数名 | 类型 | 必填 | 说明 | 2252| -------- | ------------------------ | ---- | -------------------------- | 2253| enable | boolean | 是 | 是否支持。<br/>true 支持。<br/>false 不支持。| 2254 2255**示例：** 2256 2257```javascript 2258var enable = true 2259 2260Notification.enableDistributed(enable) 2261 .then(() => { 2262 console.log('-------- enableDistributed ----------'); 2263 }); 2264``` 2265 2266 2267## Notification.isDistributedEnabled<sup>8+</sup> 2268 2269isDistributedEnabled(callback: AsyncCallback\<boolean>): void 2270 2271获取设备是否支持分布式通知（Callback形式）。 2272 2273**系统能力**：SystemCapability.Notification.Notification 2274 2275**参数：** 2276 2277| 参数名 | 类型 | 必填 | 说明 | 2278| -------- | ------------------------ | ---- | -------------------------- | 2279| callback | AsyncCallback\<boolean\> | 是 | 设备是否支持分布式通知的回调函数。 | 2280 2281**示例：** 2282 2283```javascript 2284function isDistributedEnabledCallback() { 2285 console.log('----------- isDistributedEnabled ------------'); 2286}; 2287 2288Notification.enableDistributed(isDistributedEnabledCallback); 2289``` 2290 2291 2292 2293## Notification.isDistributedEnabled<sup>8+</sup> 2294 2295isDistributedEnabled(): Promise\<boolean> 2296 2297获取设备是否支持分布式通知（Promise形式）。 2298 2299**系统能力**：SystemCapability.Notification.Notification 2300 2301**返回值：** 2302 2303| 类型 | 说明 | 2304| ------------------ | --------------- | 2305| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。<br/>true 支持。<br/>false 不支持。 | 2306 2307**示例：** 2308 2309```javascript 2310Notification.isDistributedEnabled() 2311 .then((data) => { 2312 console.log('-------- isDistributedEnabled ----------'); 2313 }); 2314``` 2315 2316 2317## Notification.enableDistributedByBundle<sup>8+</sup> 2318 2319enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void>): void 2320 2321根据应用的包设置应用程序是否支持分布式通知（Callback形式）。 2322 2323**系统能力**：SystemCapability.Notification.Notification 2324 2325**参数：** 2326 2327| 参数名 | 类型 | 必填 | 说明 | 2328| -------- | ------------------------ | ---- | -------------------------- | 2329| bundle | [BundleOption](#bundleoption) | 是 | 应用的包。 | 2330| enable | boolean | 是 | 是否支持。 | 2331| callback | AsyncCallback\<void\> | 是 | 应用程序是否支持分布式通知的回调函数。 | 2332 2333**示例：** 2334 2335```javascript 2336function enableDistributedByBundleCallback() { 2337 console.log('----------- enableDistributedByBundle ------------'); 2338}; 2339 2340var bundle = { 2341 bundle: "bundleName1", 2342} 2343 2344var enable = true 2345 2346Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundleCallback); 2347``` 2348 2349 2350 2351## Notification.enableDistributedByBundle<sup>8+</sup> 2352bundleenableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\<void> 2353 2354根据应用的包设置应用程序是否支持分布式通知（Promise形式）。 2355 2356**系统能力**：SystemCapability.Notification.Notification 2357 2358**参数：** 2359 2360| 参数名 | 类型 | 必填 | 说明 | 2361| -------- | ------------------------ | ---- | -------------------------- | 2362| bundle | [BundleOption](#bundleoption) | 是 | 应用的包。 | 2363| enable | boolean | 是 | 是否支持。 | 2364 2365**示例：** 2366 2367```javascript 2368var bundle = { 2369 bundle: "bundleName1", 2370} 2371 2372var enable = true 2373 2374Notification.enableDistributedByBundle(bundle, enable) 2375 .then(() => { 2376 console.log('-------- enableDistributedByBundle ----------'); 2377 }); 2378``` 2379 2380## Notification.isDistributedEnabledByBundle<sup>8+</sup> 2381 2382isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\<boolean>): void 2383 2384根据应用的包获取应用程序是否支持分布式通知（Callback形式）。 2385 2386**系统能力**：SystemCapability.Notification.Notification 2387 2388**参数：** 2389 2390| 参数名 | 类型 | 必填 | 说明 | 2391| -------- | ------------------------ | ---- | -------------------------- | 2392| bundle | [BundleOption](#bundleoption) | 是 | 应用的包。 | 2393| callback | AsyncCallback\<boolean\> | 是 | 应用程序是否支持分布式通知的回调函数。 | 2394 2395**示例：** 2396 2397```javascript 2398function isDistributedEnabledByBundleCallback(data) { 2399 console.log('----------- isDistributedEnabledByBundle ------------', data); 2400}; 2401 2402var bundle = { 2403 bundle: "bundleName1", 2404} 2405 2406Notification.enableDistributedByBundle(bundle, isDistributedEnabledByBundleCallback); 2407``` 2408 2409 2410 2411## Notification.isDistributedEnabledByBundle<sup>8+</sup> 2412 2413isDistributedEnabledByBundle(bundle: BundleOption): Promise\<boolean> 2414 2415根据应用的包获取应用程序是否支持分布式通知（Promise形式）。 2416 2417**系统能力**：SystemCapability.Notification.Notification 2418 2419**参数：** 2420 2421| 参数名 | 类型 | 必填 | 说明 | 2422| -------- | ------------------------ | ---- | -------------------------- | 2423| bundle | [BundleOption](#bundleoption) | 是 | 应用的包。 | 2424 2425**返回值：** 2426 2427| 类型 | 说明 | 2428| ------------------ | --------------- | 2429| Promise\<boolean\> | Promise方式返回应用程序是否支持分布式通知的结果。<br/>true 支持。<br/>false 不支持。 | 2430 2431**示例：** 2432 2433```javascript 2434var bundle = { 2435 bundle: "bundleName1", 2436} 2437 2438Notification.isDistributedEnabledByBundle(bundle) 2439 .then((data) => { 2440 console.log('-------- isDistributedEnabledByBundle ----------', data); 2441 }); 2442``` 2443 2444 2445## Notification.getDeviceRemindType<sup>8+</sup> 2446 2447getDeviceRemindType(callback: AsyncCallback\<DeviceRemindType\>): void 2448 2449获取通知的提醒方式（Callback形式）。 2450 2451**系统能力**：SystemCapability.Notification.Notification 2452 2453**参数：** 2454 2455| 参数名 | 类型 | 必填 | 说明 | 2456| -------- | --------------------------------- | ---- | -------------------------- | 2457| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype8)\> | 是 | 获取通知的提醒方式的回调函数。 | 2458 2459**示例：** 2460 2461```javascript 2462function getDeviceRemindTypeCallback(data) { 2463 console.log('----------- getDeviceRemindType ------------', data); 2464}; 2465 2466Notification.getDeviceRemindType(getDeviceRemindTypeCallback); 2467``` 2468 2469 2470 2471## Notification.getDeviceRemindType<sup>8+</sup> 2472 2473getDeviceRemindType(): Promise\<DeviceRemindType\> 2474 2475获取通知的提醒方式（Promise形式）。 2476 2477**系统能力**：SystemCapability.Notification.Notification 2478 2479**返回值：** 2480 2481| 类型 | 说明 | 2482| ------------------ | --------------- | 2483| Promise\<[DeviceRemindType](#deviceremindtype8)\> | Promise方式返回通知的提醒方式的结果。 | 2484 2485**示例：** 2486 2487```javascript 2488Notification.getDeviceRemindType() 2489 .then((data) => { 2490 console.log('-------- getDeviceRemindType ----------', data); 2491 }); 2492``` 2493 2494## NotificationSubscriber 2495 2496### onConsume 2497 2498onConsume?:(data: [SubscribeCallbackData](#subscribecallbackdata)) 2499 2500接收通知回调函数。 2501 2502**系统能力**：SystemCapability.Notification.Notification 2503 2504**参数：** 2505 2506| 参数名 | 类型 | 必填 | 说明 | 2507| ------------ | ------------------------ | ---- | -------------------------- | 2508| data | AsyncCallback\<[SubscribeCallbackData](#subscribecallbackdata)\> | 是 | 回调返回接收到的通知信息。 | 2509 2510**示例：** 2511 2512```javascript 2513function subscribeCallback(err) { 2514 if (err.code) { 2515 console.info("subscribe failed " + JSON.stringify(err)); 2516 } else { 2517 console.info("subscribeCallback"); 2518 } 2519}; 2520 2521function onConsumeCallback(data) { 2522 console.info('===> onConsume in test'); 2523 let req = data.request; 2524 console.info('===> onConsume callback req.id:' + req.id); 2525 let wantAgent = data.wantAgent; 2526 wantAgent .getWant(wantAgent) 2527 .then((data1) => { 2528 console.log('===> getWant success want:' + JSON.stringify(data1)); 2529 }) 2530 .catch((err) => { 2531 console.error('===> getWant failed because' + JSON.stringify(err)); 2532 }); 2533 console.info('===> onConsume callback req.wantAgent:' + JSON.stringify(req.wantAgent)); 2534}; 2535 2536var subscriber = { 2537 onConsume: onConsumeCallback 2538}; 2539 2540Notification.subscribe(subscriber, subscribeCallback); 2541``` 2542 2543### onCancel 2544 2545onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) 2546 2547删除通知回调函数。 2548 2549**系统能力**：SystemCapability.Notification.Notification 2550 2551**参数：** 2552 2553| 参数名 | 类型 | 必填 | 说明 | 2554| ------------ | ------------------------ | ---- | -------------------------- | 2555| data | AsyncCallback\<[SubscribeCallbackData](#subscribecallbackdata)\> | 是 | 回调返回接收到的通知信息。 | 2556 2557**示例：** 2558 2559```javascript 2560function subscribeCallback(err) { 2561 if (err.code) { 2562 console.info("subscribe failed " + JSON.stringify(err)); 2563 } else { 2564 console.info("subscribeCallback"); 2565 } 2566}; 2567 2568function onCancelCallback(data) { 2569 console.info('===> onCancel in test'); 2570 let req = data.request; 2571 console.info('===> onCancel callback req.id:' + req.id); 2572} 2573 2574var subscriber = { 2575 onCancel: onCancelCallback 2576}; 2577 2578Notification.subscribe(subscriber, subscribeCallback); 2579``` 2580 2581### onUpdate 2582 2583onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) 2584 2585更新通知排序回调函数。 2586 2587**系统能力**：SystemCapability.Notification.Notification 2588 2589**参数：** 2590 2591| 参数名 | 类型 | 必填 | 说明 | 2592| ------------ | ------------------------ | ---- | -------------------------- | 2593| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 回调返回接收到的通知信息。 | 2594 2595**示例：** 2596 2597```javascript 2598function subscribeCallback(err) { 2599 if (err.code) { 2600 console.info("subscribe failed " + JSON.stringify(err)); 2601 } else { 2602 console.info("subscribeCallback"); 2603 } 2604}; 2605 2606function onUpdateCallback() { 2607 console.info('===> onUpdate in test'); 2608} 2609 2610var subscriber = { 2611 onUpdate: onUpdateCallback 2612}; 2613 2614Notification.subscribe(subscriber, subscribeCallback); 2615``` 2616 2617### onConnect 2618 2619onConnect?:void 2620 2621注册订阅回调函数。 2622 2623**系统能力**：SystemCapability.Notification.Notification 2624 2625**示例：** 2626 2627```javascript 2628function subscribeCallback(err) { 2629 if (err.code) { 2630 console.info("subscribe failed " + JSON.stringify(err)); 2631 } else { 2632 console.info("subscribeCallback"); 2633 } 2634}; 2635 2636function onConnectCallback() { 2637 console.info('===> onConnect in test'); 2638} 2639 2640var subscriber = { 2641 onConnect: onConnectCallback 2642}; 2643 2644Notification.subscribe(subscriber, subscribeCallback); 2645``` 2646 2647### onDisconnect 2648 2649onDisconnect?:void 2650 2651取消订阅回调函数。 2652 2653**系统能力**：SystemCapability.Notification.Notification 2654 2655**示例：** 2656 2657```javascript 2658function subscribeCallback(err) { 2659 if (err.code) { 2660 console.info("subscribe failed " + JSON.stringify(err)); 2661 } else { 2662 console.info("subscribeCallback"); 2663 } 2664}; 2665 2666function onDisconnectCallback() { 2667 console.info('===> onDisconnect in test'); 2668} 2669 2670var subscriber = { 2671 onDisconnect: onDisconnectCallback 2672}; 2673 2674Notification.subscribe(subscriber, subscribeCallback); 2675``` 2676 2677### onDestroy 2678 2679onDestroy?:void 2680 2681服务失联回调函数。 2682 2683**系统能力**：SystemCapability.Notification.Notification 2684 2685**示例：** 2686 2687```javascript 2688function subscribeCallback(err) { 2689 if (err.code) { 2690 console.info("subscribe failed " + JSON.stringify(err)); 2691 } else { 2692 console.info("subscribeCallback"); 2693 } 2694}; 2695 2696function onDestroyCallback() { 2697 console.info('===> onDestroy in test'); 2698} 2699 2700var subscriber = { 2701 onDestroy: onDestroyCallback 2702}; 2703 2704Notification.subscribe(subscriber, subscribeCallback); 2705``` 2706 2707### onDoNotDisturbDateChange<sup>8+</sup> 2708 2709onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate8)) 2710 2711免打扰时间选项变更回调函数。 2712 2713**系统能力**：SystemCapability.Notification.Notification 2714 2715**参数：** 2716 2717| 参数名 | 类型 | 必填 | 说明 | 2718| ------------ | ------------------------ | ---- | -------------------------- | 2719| mode | Notification.[DoNotDisturbDate](#donotdisturbdate8) | 是 | 回调返回免打扰时间选项变更。 | 2720 2721**示例：** 2722```javascript 2723function subscribeCallback(err) { 2724 if (err.code) { 2725 console.info("subscribe failed " + JSON.stringify(err)); 2726 } else { 2727 console.info("subscribeCallback"); 2728 } 2729}; 2730 2731function onDoNotDisturbDateChangeCallback() { 2732 console.info('===> onDoNotDisturbDateChange in test'); 2733} 2734 2735var subscriber = { 2736 onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback 2737}; 2738 2739Notification.subscribe(subscriber, subscribeCallback); 2740``` 2741 2742 2743### onEnabledNotificationChanged<sup>8+</sup> 2744 2745onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) 2746 2747监听应用通知使能变化。 2748 2749**系统能力**：SystemCapability.Notification.Notification 2750 2751**参数：** 2752 2753| 参数名 | 类型 | 必填 | 说明 | 2754| ------------ | ------------------------ | ---- | -------------------------- | 2755| callback | AsyncCallback\<[EnabledNotificationCallbackData](#enablednotificationcallbackdata8)\> | 是 | 回调返回监听到的应用信息。 | 2756 2757**示例：** 2758 2759```javascript 2760function subscribeCallback(err) { 2761 if (err.code) { 2762 console.info("subscribe failed " + JSON.stringify(err)); 2763 } else { 2764 console.info("subscribeCallback"); 2765 } 2766}; 2767 2768function onEnabledNotificationChangedCallback(err, callbackData) { 2769 if (err.code) { 2770 console.info("subscribe failed " + JSON.stringify(err)); 2771 } else { 2772 console.info("bundle: ", callbackData.bundle); 2773 console.info("uid: ", callbackData.uid); 2774 console.info("enable: ", callbackData.enable); 2775 } 2776}; 2777 2778var subscriber = { 2779 onEnabledNotificationChanged: onEnabledNotificationChangedCallback 2780}; 2781 2782Notification.subscribe(subscriber, subscribeCallback); 2783``` 2784 2785## SubscribeCallbackData 2786 2787**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2788 2789| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2790| --------------- | ---- | --- | ------------------------------------------------- | ---- | -------- | 2791| request | 是 | 否 | [NotificationRequest](#notificationrequest) | 是 | 通知内容。 | 2792| sortingMap | 是 | 否 | [NotificationSortingMap](#notificationsortingmap) | 否 | 排序信息。 | 2793| reason | 是 | 否 | number | 否 | 删除原因。 | 2794| sound | 是 | 否 | string | 否 | 通知声音。 | 2795| vibrationValues | 是 | 否 | Array\<number\> | 否 | 通知震动。 | 2796 2797 2798## EnabledNotificationCallbackData<sup>8+</sup> 2799 2800**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2801 2802| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2803| ------ | ---- | --- | ------- | ---- | ---------------- | 2804| bundle | 是 | 否 | string | 是 | 应用的包名。 | 2805| uid | 是 | 否 | number | 是 | 应用的uid。 | 2806| enable | 是 | 否 | boolean | 是 | 应用通知使能状态。 | 2807 2808 2809## DoNotDisturbDate<sup>8+</sup> 2810 2811**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2812 2813| 名称 | 可读 | 可写 | 类型 | 描述 | 2814| ----- | ---- | --- | ------------------------------------- | ------------------------ | 2815| type | 是 | 否 | [DoNotDisturbType](#donotdisturbtype8) | 指定免打扰设置的时间类型。 | 2816| begin | 是 | 否 | Date | 指定免打扰设置的起点时间。 | 2817| end | 是 | 否 | Date | 指定免打扰设置的终点时间。 | 2818 2819 2820 2821## DoNotDisturbType<sup>8+</sup> 2822 2823**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2824 2825 2826| 名称 | 值 | 说明 | 2827| ------------ | ---------------- | ------------------------------------------ | 2828| TYPE_NONE | DoNotDisturbType | 非通知勿扰类型。 | 2829| TYPE_ONCE | DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰。 | 2830| TYPE_DAILY | DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰。 | 2831| TYPE_CLEARLY | DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰。 | 2832 2833 2834## ContentType 2835 2836**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2837 2838| 名称 | 值 | 说明 | 2839| --------------------------------- | ----------- | ------------------ | 2840| NOTIFICATION_CONTENT_BASIC_TEXT | ContentType | 普通类型通知。 | 2841| NOTIFICATION_CONTENT_LONG_TEXT | ContentType | 长文本类型通知。 | 2842| NOTIFICATION_CONTENT_PICTURE | ContentType | 图片类型通知。 | 2843| NOTIFICATION_CONTENT_CONVERSATION | ContentType | 社交类型通知。 | 2844| NOTIFICATION_CONTENT_MULTILINE | ContentType | 多行文本类型通知。 | 2845 2846## SlotLevel 2847 2848**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2849 2850| 名称 | 值 | 说明 | 2851| --------------------------------- | ----------- | ------------------ | 2852| LEVEL_NONE | 0 | 表示关闭通知功能。 | 2853| LEVEL_MIN | 1 | 指示通知功能已启用，但状态栏中不显示通知图标，且没有横幅或提示音。 | 2854| LEVEL_LOW | 2 | 指示通知功能已启用，且状态栏中显示通知图标，但没有横幅或提示音。 | 2855| LEVEL_DEFAULT | 3 | 指示通知功能已启用，状态栏中显示通知图标，没有横幅但有提示音。 | 2856| LEVEL_HIGH | 4 | 指示通知功能已启用，状态栏中显示通知图标，有横幅和提示音。 | 2857 2858 2859## BundleOption 2860 2861**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2862 2863| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2864| ------ | ---- | --- | ------ | ---- | ------ | 2865| bundle | 是 | 是 | string | 是 | 包名。 | 2866| uid | 是 | 是 | number | 否 | 用户id。 | 2867 2868 2869 2870## NotificationKey 2871 2872**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2873 2874| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2875| ----- | ---- | --- | ------ | ---- | -------- | 2876| id | 是 | 是 | number | 是 | 通知ID。 | 2877| label | 是 | 是 | string | 否 | 通知标签。 | 2878 2879 2880## SlotType 2881 2882**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2883 2884| 名称 | 值 | 说明 | 2885| -------------------- | -------- | ---------- | 2886| UNKNOWN_TYPE | SlotType | 未知类型。 | 2887| SOCIAL_COMMUNICATION | SlotType | 社交类型。 | 2888| SERVICE_INFORMATION | SlotType | 服务类型。 | 2889| CONTENT_INFORMATION | SlotType | 内容类型。 | 2890| OTHER_TYPES | SlotType | 其他类型。 | 2891 2892 2893## NotificationActionButton 2894 2895**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2896 2897| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2898| --------- | --- | ---- | ----------------------------------------------- | ---- | ------------------------- | 2899| title | 是 | 是 | string | 是 | 按钮标题。 | 2900| wantAgent | 是 | 是 | WantAgent | 是 | 点击按钮时触发的WantAgent。 | 2901| extras | 是 | 是 | { [key: string]: any } | 否 | 按钮扩展信息。 | 2902| userInput | 是 | 是 | [NotificationUserInput](#notificationuserinput8) | 否 | 用户输入信息。 | 2903 2904 2905## NotificationBasicContent 2906 2907**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2908 2909| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2910| -------------- | ---- | ---- | ------ | ---- | ---------------------------------- | 2911| title | 是 | 是 | string | 是 | 通知标题。 | 2912| text | 是 | 是 | string | 是 | 通知内容。 | 2913| additionalText | 是 | 是 | string | 否 | 通知次要内容，是对通知内容的补充。 | 2914 2915 2916## NotificationLongTextContent 2917 2918**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2919 2920| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2921| -------------- | ---- | --- | ------ | ---- | -------------------------------- | 2922| title | 是 | 是 | string | 是 | 通知标题。 | 2923| text | 是 | 是 | string | 是 | 通知内容。 | 2924| additionalText | 是 | 是 | string | 否 | 通知次要内容，是对通知内容的补充。 | 2925| longText | 是 | 是 | string | 是 | 通知的长文本。 | 2926| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 | 2927| expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 | 2928 2929 2930## NotificationMultiLineContent 2931 2932**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2933 2934| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2935| -------------- | --- | --- | --------------- | ---- | -------------------------------- | 2936| title | 是 | 是 | string | 是 | 通知标题。 | 2937| text | 是 | 是 | string | 是 | 通知内容。 | 2938| additionalText | 是 | 是 | string | 否 | 通知次要内容，是对通知内容的补充。 | 2939| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 | 2940| longTitle | 是 | 是 | string | 是 | 通知展开时的标题。 | 2941| lines | 是 | 是 | Array\<string\> | 是 | 通知的多行文本。 | 2942 2943 2944## NotificationPictureContent 2945 2946**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2947 2948| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2949| -------------- | ---- | --- | -------------- | ---- | -------------------------------- | 2950| title | 是 | 是 | string | 是 | 通知标题。 | 2951| text | 是 | 是 | string | 是 | 通知内容。 | 2952| additionalText | 是 | 是 | string | 否 | 通知次要内容，是对通知内容的补充。 | 2953| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 | 2954| expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 | 2955| picture | 是 | 是 | image.PixelMap | 是 | 通知的图片内容。 | 2956 2957 2958## NotificationContent 2959 2960**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2961 2962| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2963| ----------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------ | 2964| contentType | 是 | 是 | [ContentType](#contenttype) | 是 | 通知内容类型。 | 2965| normal | 是 | 是 | [NotificationBasicContent](#notificationbasiccontent) | 否 | 基本类型通知内容。 | 2966| longText | 是 | 是 | [NotificationLongTextContent](#notificationlongtextcontent) | 否 | 长文本类型通知内容。 | 2967| multiLine | 是 | 是 | [NotificationMultiLineContent](#notificationmultilinecontent) | 否 | 多行类型通知内容。 | 2968| picture | 是 | 是 | [NotificationPictureContent](#notificationpicturecontent) | 否 | 图片类型通知内容。 | 2969 2970 2971## NotificationFlagStatus<sup>8+</sup> 2972 2973**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2974 2975| 名称 | 值 | 描述 | 2976| -------------- | --- | --------------------------------- | 2977| TYPE_NONE | 0 | 默认标志。 | 2978| TYPE_OPEN | 1 | 通知标志打开。 | 2979| TYPE_CLOSE | 2 | 通知标志关闭。 | 2980 2981 2982## NotificationFlags<sup>8+</sup> 2983 2984**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2985 2986| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2987| ---------------- | ---- | ---- | ---------------------- | ---- | --------------------------------- | 2988| soundEnabled | 是 | 否 | NotificationFlagStatus | 否 | 是否启用声音提示。 | 2989| vibrationEnabled | 是 | 否 | NotificationFlagStatus | 否 | 是否启用振动提醒功能。 | 2990 2991 2992## NotificationRequest 2993 2994**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 2995 2996| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 2997| --------------------- | ---- | --- | --------------------------------------------- | ---- | -------------------------- | 2998| content | 是 | 是 | [NotificationContent](#notificationcontent) | 是 | 通知内容。 | 2999| id | 是 | 是 | number | 否 | 通知ID。 | 3000| slotType | 是 | 是 | [SlotType](#slottype) | 否 | 通道类型。 | 3001| isOngoing | 是 | 是 | boolean | 否 | 是否进行时通知。 | 3002| isUnremovable | 是 | 是 | boolean | 否 | 是否可移除。 | 3003| deliveryTime | 是 | 是 | number | 否 | 通知发送时间。 | 3004| tapDismissed | 是 | 是 | boolean | 否 | 通知是否自动清除。 | 3005| autoDeletedTime | 是 | 是 | number | 否 | 自动清除的时间。 | 3006| wantAgent | 是 | 是 | WantAgent | 否 | 点击跳转的WantAgent。 | 3007| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 扩展参数。 | 3008| color | 是 | 是 | number | 否 | 通知背景颜色。 | 3009| colorEnabled | 是 | 是 | boolean | 否 | 通知背景颜色是否使能。 | 3010| isAlertOnce | 是 | 是 | boolean | 否 | 设置是否仅有一次此通知警报。 | 3011| isStopwatch | 是 | 是 | boolean | 否 | 是否显示已用时间。 | 3012| isCountDown | 是 | 是 | boolean | 否 | 是否显示倒计时时间。 | 3013| isFloatingIcon | 是 | 是 | boolean | 否 | 是否显示状态栏图标。 | 3014| label | 是 | 是 | string | 否 | 通知标签。 | 3015| badgeIconStyle | 是 | 是 | number | 否 | 通知角标类型。 | 3016| showDeliveryTime | 是 | 是 | boolean | 否 | 是否显示分发时间。 | 3017| actionButtons | 是 | 是 | Array\<[NotificationActionButton](#notificationactionbutton)\> | 否 | 通知按钮，最多两个按钮。 | 3018| smallIcon | 是 | 是 | PixelMap | 否 | 通知小图标。 | 3019| largeIcon | 是 | 是 | PixelMap | 否 | 通知大图标。 | 3020| creatorBundleName | 是 | 否 | string | 否 | 创建通知的包名。 | 3021| creatorUid | 是 | 否 | number | 否 | 创建通知的UID。 | 3022| creatorPid | 是 | 否 | number | 否 | 创建通知的PID。 | 3023| creatorUserId<sup>8+</sup>| 是 | 否 | number | 否 | 创建通知的UserId。 | 3024| hashCode | 是 | 否 | string | 否 | 通知唯一标识。 | 3025| classification | 是 | 是 | string | 否 | 通知分类。 | 3026| groupName<sup>8+</sup>| 是 | 是 | string | 否 | 组通知名称。 | 3027| template<sup>8+</sup> | 是 | 是 | [NotificationTemplate](#notificationtemplate8) | 否 | 通知模板。 | 3028| isRemoveAllowed<sup>8+</sup> | 是 | 否 | boolean | 否 | 通知是否能被移除。 | 3029| source<sup>8+</sup> | 是 | 否 | number | 否 | 通知源。 | 3030| distributedOption<sup>8+</sup> | 是 | 是 | [DistributedOptions](#distributedoptions8) | 否 | 分布式通知的选项。 | 3031| deviceId<sup>8+</sup> | 是 | 否 | string | 否 | 通知源的deviceId。 | 3032| notificationFlags<sup>8+</sup> | 是 | 否 | [NotificationFlags](#notificationflags8) | 否 | 获取NotificationFlags。 | 3033 3034 3035## DistributedOptions<sup>8+</sup> 3036 3037**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3038 3039| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3040| ---------------------- | ---- | ---- | -------------- | ---- | ---------------------------------- | 3041| isDistributed | 是 | 是 | boolean | 否 | 是否为分布式通知。 | 3042| supportDisplayDevices | 是 | 是 | Array\<string> | 是 | 可以同步通知到的设备类型。 | 3043| supportOperateDevices | 是 | 是 | Array\<string> | 否 | 可以打开通知的设备。 | 3044| remindType | 是 | 否 | number | 否 | 通知的提醒方式。 | 3045 3046 3047## NotificationSlot 3048 3049**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3050 3051| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3052| -------------------- | ---- | --- | --------------------- | ---- | ------------------------------------------ | 3053| type | 是 | 是 | [SlotType](#slottype) | 是 | 通道类型。 | 3054| level | 是 | 是 | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 | 3055| desc | 是 | 是 | string | 否 | 通知渠道描述信息。 | 3056| badgeFlag | 是 | 是 | boolean | 否 | 是否显示角标。 | 3057| bypassDnd | 是 | 是 | boolean | 否 | 置是否在系统中绕过免打扰模式。 | 3058| lockscreenVisibility | 是 | 是 | number | 否 | 在锁定屏幕上显示通知的模式。 | 3059| vibrationEnabled | 是 | 是 | boolean | 否 | 是否可振动。 | 3060| sound | 是 | 是 | string | 否 | 通知提示音。 | 3061| lightEnabled | 是 | 是 | boolean | 否 | 是否闪灯。 | 3062| lightColor | 是 | 是 | number | 否 | 通知灯颜色。 | 3063| vibrationValues | 是 | 是 | Array\<number\> | 否 | 通知振动样式。 | 3064 3065 3066## NotificationSorting 3067 3068**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3069 3070| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3071| -------- | ---- | --- | ------------------------------------- | ---- | ------------ | 3072| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 通知通道内容。 | 3073| hashCode | 是 | 否 | string | 是 | 通知唯一标识。 | 3074| ranking | 是 | 否 | number | 是 | 通知排序序号。 | 3075 3076 3077## NotificationSortingMap 3078 3079**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3080 3081| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3082| -------------- | ---- | --- | ------------------------------------------------------------ | ---- | ---------------- | 3083| sortings | 是 | 否 | {[key: string]: [NotificationSorting](#notificationsorting)} | 是 | 通知排序信息数组。 | 3084| sortedHashCode | 是 | 否 | Array\<string\> | 是 | 通知唯一标识数组。 | 3085 3086 3087## NotificationSubscribeInfo 3088 3089**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3090 3091| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3092| ----------- | --- | ---- | --------------- | ---- | ------------------------------- | 3093| bundleNames | 是 | 是 | Array\<string\> | 否 | 指定订阅哪些包名的APP发来的通知。 | 3094| userId | 是 | 是 | number | 否 | 指定订阅哪个用户下发来的通知。 | 3095 3096 3097## NotificationTemplate<sup>8+</sup> 3098 3099**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification 3100 3101| 名称 | 参数类型 | 可读 | 可写 | 说明 | 3102| ---- | ---------------------- | ---- | ---- | ---------- | 3103| name | string | 是 | 是 | 模板名称。 | 3104| data | {[key:string]: Object} | 是 | 是 | 模板数据。 | 3105 3106 3107## NotificationUserInput<sup>8+</sup> 3108 3109**系统能力**：SystemCapability.Notification.Notification 3110 3111| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | 3112| -------- | --- | ---- | ------ | ---- | ----------------------------- | 3113| inputKey | 是 | 是 | string | 是 | 用户输入时用于标识此输入的key。 | 3114 3115 3116## DeviceRemindType<sup>8+</sup> 3117 3118**系统能力**：SystemCapability.Notification.Notification 3119 3120| 名称 | 值 | 描述 | 3121| -------------------- | --- | --------------------------------- | 3122| IDLE_DONOT_REMIND | 0 | 设备未被使用，无需提醒。 | 3123| IDLE_REMIND | 1 | 提醒设备未被使用。 | 3124| ACTIVE_DONOT_REMIND | 2 | 设备正在使用，无需提醒。 | 3125| ACTIVE_REMIND | 3 | 提醒设备正在使用。 |
