js-apis-notificationManager.md 136.8 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.notificationManager (NotificationManager模块)
2 3 4 5 6 7 8 9 10

本模块提供通知管理的能力,包括发布、取消发布通知,创建、获取、移除通知通道,获取通知的使能状态、角标使能状态,获取通知的相关信息等。

> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

11 12
```ts
import notificationManager from '@ohos.notificationManager';
13 14
```

15
## notificationManager.publish
16 17 18 19 20 21 22 23 24

publish(request: NotificationRequest, callback: AsyncCallback\<void\>): void

发布通知(callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
25
| 参数名     | 类型                                        | 必填 | 说明                                        |
26
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
F
fangJinliang1 已提交
27 28
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| callback | AsyncCallback\<void\>                       | 是   | 发布通知的回调方法。                        |
29 30 31 32 33 34 35 36 37 38 39 40 41 42

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600009  | Over max number notifications per second. |

**示例:**

43
```ts
44 45 46 47 48 49 50 51 52
//publish回调
function publishCallback(err) {
    if (err) {
        console.info("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish success");
    }
}
//通知Request对象
F
fangJinliang1 已提交
53
let notificationRequest = {
54 55
    id: 1,
    content: {
56
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
57 58 59 60 61 62
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
63
};
64
notificationManager.publish(notificationRequest, publishCallback);
65 66
```

67
## notificationManager.publish
68 69 70 71 72 73 74 75 76

publish(request: NotificationRequest): Promise\<void\>

发布通知(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
77
| 参数名     | 类型                                        | 必填 | 说明                                        |
78
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
F
fangJinliang1 已提交
79
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
80 81 82 83 84 85 86 87 88 89 90 91 92 93

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600009  | Over max number notifications per second. |

**示例:**

94
```ts
F
fangJinliang1 已提交
95
// 通知Request对象
F
fangJinliang1 已提交
96
let notificationRequest = {
97 98
    notificationId: 1,
    content: {
99
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
100 101 102 103 104 105
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
106
};
107
notificationManager.publish(notificationRequest).then(() => {
F
fangJinliang1 已提交
108
	console.info("publish success");
109 110 111 112
});

```

113
## notificationManager.publish
114 115 116

publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
117
发布通知给指定的用户(callback形式)。
118 119 120 121 122 123 124 125 126

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
127
| 参数名     | 类型                                        | 必填 | 说明                                        |
128
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
F
fangJinliang1 已提交
129 130
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| userId   | number                                      | 是   | 用户ID。                           |
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
| callback | AsyncCallback\<void\>                       | 是   | 被指定的回调方法。                           |

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600008  | The user is not exist.                    |
| 1600009  | Over max number notifications per second. |

**示例:**

147
```ts
F
fangJinliang1 已提交
148
// publish回调
149 150 151 152 153 154 155
function publishCallback(err) {
    if (err) {
        console.info("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish success");
    }
}
F
fangJinliang1 已提交
156
// 用户ID
F
fangJinliang1 已提交
157
let userId = 1;
F
fangJinliang1 已提交
158
// 通知Request对象
F
fangJinliang1 已提交
159
let notificationRequest = {
160 161
    id: 1,
    content: {
162
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
163 164 165 166 167 168
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
169
};
170
notificationManager.publish(notificationRequest, userId, publishCallback);
171 172
```

173
## notificationManager.publish
174 175 176

publish(request: NotificationRequest, userId: number): Promise\<void\>

F
fangJinliang1 已提交
177
发布通知给指定的用户(Promise形式)。
178 179 180 181 182 183 184 185 186

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
187
| 参数名     |  类型                                        | 必填 | 说明                                        |
188
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
F
fangJinliang1 已提交
189 190
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| userId   | number                                      | 是   | 用户ID。                           |
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600008  | The user is not exist.                    |
| 1600009  | Over max number notifications per second. |

**示例:**

206
```ts
F
fangJinliang1 已提交
207
let notificationRequest = {
208 209
    notificationId: 1,
    content: {
210
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
211 212 213 214 215 216
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
217
};
218

F
fangJinliang1 已提交
219
let userId = 1;
220

221
notificationManager.publish(notificationRequest, userId).then(() => {
F
fangJinliang1 已提交
222
	console.info("publish success");
223 224 225 226
});
```


227
## notificationManager.cancel
228 229 230

cancel(id: number, label: string, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
231
通过通知ID和通知标签取消已发布的通知(callback形式)。
232 233 234 235 236

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
237
| 参数名     | 类型                  | 必填 | 说明                 |
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| label    | string                | 是   | 通知标签。             |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

254
```ts
F
fangJinliang1 已提交
255
// cancel回调
256 257 258 259 260 261 262
function cancelCallback(err) {
    if (err) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
}
263
notificationManager.cancel(0, "label", cancelCallback);
264 265
```

266
## notificationManager.cancel
267 268 269

cancel(id: number, label?: string): Promise\<void\>

F
fangJinliang1 已提交
270
取消与指定通知ID相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
271 272 273 274 275

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
276
| 参数名  | 类型   | 必填 | 说明     |
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
| ----- | ------ | ---- | -------- |
| id    | number | 是   | 通知ID。   |
| label | string | 否   | 通知标签。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

292 293
```ts
notificationManager.cancel(0).then(() => {
F
fangJinliang1 已提交
294
	console.info("cancel success");
295 296 297
});
```

298
## notificationManager.cancel
299 300 301

cancel(id: number, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
302
取消与指定通知ID相匹配的已发布通知(callback形式)。
303 304 305 306 307

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
308
| 参数名     | 类型                  | 必填 | 说明                 |
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

324
```ts
F
fangJinliang1 已提交
325
// cancel回调
326 327 328 329 330 331 332
function cancelCallback(err) {
    if (err) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
}
333
notificationManager.cancel(0, cancelCallback);
334 335
```

336
## notificationManager.cancelAll
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

cancelAll(callback: AsyncCallback\<void\>): void

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

**系统能力**:SystemCapability.Notification.Notification

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**参数:**

F
fangJinliang1 已提交
354
| 参数名     | 类型                  | 必填 | 说明                 |
355 356 357 358 359
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**示例:**

360
```ts
F
fangJinliang1 已提交
361
// cancel回调
362 363 364 365 366 367 368
function cancelAllCallback(err) {
    if (err) {
        console.info("cancelAll failed " + JSON.stringify(err));
    } else {
        console.info("cancelAll success");
    }
}
369
notificationManager.cancelAll(cancelAllCallback);
370 371
```

372
## notificationManager.cancelAll
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

cancelAll(): Promise\<void\>

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

**系统能力**:SystemCapability.Notification.Notification

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

390 391
```ts
notificationManager.cancelAll().then(() => {
F
fangJinliang1 已提交
392
	console.info("cancelAll success");
393 394 395
});
```

396
## notificationManager.addSlot
397 398 399 400 401 402 403 404 405 406 407 408 409

addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>): void

创建通知通道(callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
410
| 参数名     | 类型                  | 必填 | 说明                 |
411 412 413 414 415 416 417 418 419 420 421 422 423 424
| -------- | --------------------- | ---- | -------------------- |
| slot     | [NotificationSlot](#notificationslot)       | 是   | 要创建的通知通道对象。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

425
```ts
F
fangJinliang1 已提交
426
// addslot回调
427 428 429 430 431 432 433
function addSlotCallBack(err) {
    if (err) {
        console.info("addSlot failed " + JSON.stringify(err));
    } else {
        console.info("addSlot success");
    }
}
F
fangJinliang1 已提交
434
// 通知slot对象
F
fangJinliang1 已提交
435
let notificationSlot = {
436
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
437
};
438
notificationManager.addSlot(notificationSlot, addSlotCallBack);
439 440
```

441
## notificationManager.addSlot
442 443 444 445 446 447 448 449 450 451 452 453 454

addSlot(slot: NotificationSlot): Promise\<void\>

创建通知通道(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
455
| 参数名 | 类型             | 必填 | 说明                 |
456 457 458 459 460 461 462 463 464 465 466 467 468
| ---- | ---------------- | ---- | -------------------- |
| slot | [NotificationSlot](#notificationslot) | 是   | 要创建的通知通道对象。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

469
```ts
F
fangJinliang1 已提交
470
// 通知slot对象
F
fangJinliang1 已提交
471
let notificationSlot = {
472
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
473
};
474
notificationManager.addSlot(notificationSlot).then(() => {
F
fangJinliang1 已提交
475
	console.info("addSlot success");
476 477 478
});
```

479
## notificationManager.addSlot
480 481 482

addSlot(type: SlotType, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
483
创建指定类型的通知通道(callback形式)。
484 485 486 487 488

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
489
| 参数名     | 类型                  | 必填 | 说明                   |
490 491 492 493 494 495 496 497 498 499 500 501 502 503
| -------- | --------------------- | ---- | ---------------------- |
| type     | [SlotType](#slottype)              | 是   | 要创建的通知通道的类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。   |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

504
```ts
F
fangJinliang1 已提交
505
// addslot回调
506 507 508 509 510 511 512
function addSlotCallBack(err) {
    if (err) {
        console.info("addSlot failed " + JSON.stringify(err));
    } else {
        console.info("addSlot success");
    }
}
513
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);
514 515
```

516
## notificationManager.addSlot
517 518 519

addSlot(type: SlotType): Promise\<void\>

F
fangJinliang1 已提交
520
创建指定类型的通知通道(Promise形式)。
521 522 523 524 525

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
526
| 参数名 | 类型     | 必填 | 说明                   |
527 528 529 530 531 532 533 534 535 536 537 538 539
| ---- | -------- | ---- | ---------------------- |
| type | [SlotType](#slottype) | 是   | 要创建的通知通道的类型。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

540 541
```ts
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
F
fangJinliang1 已提交
542
	console.info("addSlot success");
543 544 545
});
```

546
## notificationManager.addSlots
547 548 549 550 551 552 553 554 555 556 557 558 559

addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>): void

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
560
| 参数名     | 类型                      | 必填 | 说明                     |
561 562 563 564 565 566 567 568 569 570 571 572 573 574
| -------- | ------------------------- | ---- | ------------------------ |
| slots    | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |
| callback | AsyncCallback\<void\>     | 是   | 表示被指定的回调方法。     |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

575
```ts
F
fangJinliang1 已提交
576
// addSlots回调
577 578 579 580 581 582 583
function addSlotsCallBack(err) {
    if (err) {
        console.info("addSlots failed " + JSON.stringify(err));
    } else {
        console.info("addSlots success");
    }
}
F
fangJinliang1 已提交
584
// 通知slot对象
F
fangJinliang1 已提交
585
let notificationSlot = {
586
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
587
};
F
fangJinliang1 已提交
588
// 通知slot array 对象
F
fangJinliang1 已提交
589
let notificationSlotArray = new Array();
590 591
notificationSlotArray[0] = notificationSlot;

592
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
593 594
```

595
## notificationManager.addSlots
596 597 598 599 600 601 602 603 604 605 606 607 608

addSlots(slots: Array\<NotificationSlot\>): Promise\<void\>

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
609
| 参数名  | 类型                      | 必填 | 说明                     |
610 611 612 613 614 615 616 617 618 619 620 621 622
| ----- | ------------------------- | ---- | ------------------------ |
| slots | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

623
```ts
F
fangJinliang1 已提交
624
// 通知slot对象
F
fangJinliang1 已提交
625
let notificationSlot = {
626
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
627
};
F
fangJinliang1 已提交
628
// 通知slot array 对象
F
fangJinliang1 已提交
629
let notificationSlotArray = new Array();
630 631
notificationSlotArray[0] = notificationSlot;

632
notificationManager.addSlots(notificationSlotArray).then(() => {
F
fangJinliang1 已提交
633
	console.info("addSlots success");
634 635 636
});
```

637
## notificationManager.getSlot
638 639 640

getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>): void

F
fangJinliang1 已提交
641
获取一个指定类型的通知通道(callback形式)。
642 643 644 645 646

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
647
| 参数名     | 类型                              | 必填 | 说明                                                        |
648
| -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
F
fangJinliang1 已提交
649
| slotType | [SlotType](#slottype)                          | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
650 651 652 653 654 655 656 657 658 659 660 661
| callback | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是   | 表示被指定的回调方法。                                        |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

662
```ts
F
fangJinliang1 已提交
663
// getSlot回调
664 665 666 667 668 669 670
function getSlotCallback(err,data) {
    if (err) {
        console.info("getSlot failed " + JSON.stringify(err));
    } else {
        console.info("getSlot success");
    }
}
671 672
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);
673 674
```

675
## notificationManager.getSlot
676 677 678

getSlot(slotType: SlotType): Promise\<NotificationSlot\>

F
fangJinliang1 已提交
679
获取一个指定类型的通知通道(Promise形式)。
680 681 682 683 684

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
685
| 参数名     | 类型     | 必填 | 说明                                                        |
686
| -------- | -------- | ---- | ----------------------------------------------------------- |
F
fangJinliang1 已提交
687
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<NotificationSlot\> | 以Promise形式返回获取一个通知通道。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

705 706 707
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data) => {
F
fangJinliang1 已提交
708
	console.info("getSlot success, data: " + JSON.stringify(data));
709 710 711
});
```

712
## notificationManager.getSlots
713 714 715 716 717 718 719 720 721

getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>): void

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

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
722
| 参数名     | 类型                              | 必填 | 说明                 |
723
| -------- | --------------------------------- | ---- | -------------------- |
F
fangJinliang1 已提交
724
| callback | AsyncCallback\<Array\<[NotificationSlot](#notificationslot)\>\> | 是   | 以callback形式返回获取此应用程序的所有通知通道的结果。 |
725 726 727 728 729 730 731 732 733 734 735

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

736
```ts
F
fangJinliang1 已提交
737
// getSlots回调
738 739 740 741 742 743 744
function getSlotsCallback(err,data) {
    if (err) {
        console.info("getSlots failed " + JSON.stringify(err));
    } else {
        console.info("getSlots success");
    }
}
745
notificationManager.getSlots(getSlotsCallback);
746 747
```

748
## notificationManager.getSlots
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771

getSlots(): Promise\<Array\<NotificationSlot\>>

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

**系统能力**:SystemCapability.Notification.Notification

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<[NotificationSlot](#notificationslot)\>\> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

772 773
```ts
notificationManager.getSlots().then((data) => {
F
fangJinliang1 已提交
774
	console.info("getSlots success, data: " + JSON.stringify(data));
775 776 777
});
```

778
## notificationManager.removeSlot
779 780 781

removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
782
删除指定类型的通知通道(callback形式)。
783 784 785 786 787

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
788
| 参数名     | 类型                  | 必填 | 说明                                                        |
789 790 791 792 793 794 795 796 797 798 799 800 801 802
| -------- | --------------------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype)              | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。                                        |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

803
```ts
F
fangJinliang1 已提交
804
// removeSlot回调
805 806 807 808 809 810 811
function removeSlotCallback(err) {
    if (err) {
        console.info("removeSlot failed " + JSON.stringify(err));
    } else {
        console.info("removeSlot success");
    }
}
812 813
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType,removeSlotCallback);
814 815
```

816
## notificationManager.removeSlot
817 818 819

removeSlot(slotType: SlotType): Promise\<void\>

F
fangJinliang1 已提交
820
删除指定类型的通知通道(Promise形式)。
821 822 823 824 825

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
826
| 参数名     | 类型     | 必填 | 说明                                                        |
827 828 829 830 831 832 833 834 835 836 837 838 839
| -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

840 841 842
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
F
fangJinliang1 已提交
843
	console.info("removeSlot success");
844 845 846
});
```

847
## notificationManager.removeAllSlots
848 849 850 851 852 853 854 855 856

removeAllSlots(callback: AsyncCallback\<void\>): void

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

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
857
| 参数名     | 类型                  | 必填 | 说明                 |
858 859 860 861 862 863 864 865 866 867 868 869 870
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

871
```ts
872 873 874 875 876 877 878
function removeAllCallBack(err) {
    if (err) {
        console.info("removeAllSlots failed " + JSON.stringify(err));
    } else {
        console.info("removeAllSlots success");
    }
}
879
notificationManager.removeAllSlots(removeAllCallBack);
880 881
```

882
## notificationManager.removeAllSlots
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

removeAllSlots(): Promise\<void\>

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

**系统能力**:SystemCapability.Notification.Notification

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

900 901
```ts
notificationManager.removeAllSlots().then(() => {
F
fangJinliang1 已提交
902
	console.info("removeAllSlots success");
903 904 905
});
```

906
## notificationManager.setNotificationEnable
907 908 909

setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
910
设定指定应用的通知使能状态(Callback形式)。
911 912 913 914 915 916 917 918 919

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
920
| 参数名     | 类型                  | 必填 | 说明                 |
921
| -------- | --------------------- | ---- | -------------------- |
F
fangJinliang1 已提交
922
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。        |
923 924 925 926 927 928 929 930 931 932 933 934 935 936
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知使能回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

937
```ts
938 939 940 941 942 943 944
function setNotificationEnablenCallback(err) {
    if (err) {
        console.info("setNotificationEnablenCallback failed " + JSON.stringify(err));
    } else {
        console.info("setNotificationEnablenCallback success");
    }
}
F
fangJinliang1 已提交
945
let bundle = {
946
    bundle: "bundleName1",
F
fangJinliang1 已提交
947
};
948
notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback);
949 950
```

951
## notificationManager.setNotificationEnable
952 953 954

setNotificationEnable(bundle: BundleOption, enable: boolean): Promise\<void\>

F
fangJinliang1 已提交
955
设定指定应用的通知使能状态(Promise形式)。
956 957 958 959 960 961 962 963 964

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
965
| 参数名   | 类型         | 必填 | 说明       |
966
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
967
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
968 969 970 971 972 973 974 975 976 977 978 979 980
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

981
```ts
F
fangJinliang1 已提交
982
let bundle = {
983
    bundle: "bundleName1",
F
fangJinliang1 已提交
984
};
985
notificationManager.setNotificationEnable(bundle, false).then(() => {
F
fangJinliang1 已提交
986
	console.info("setNotificationEnable success");
987 988 989
});
```

990
## notificationManager.isNotificationEnabled
991 992 993

isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void

F
fangJinliang1 已提交
994
获取指定应用的通知使能状态(Callback形式)。
995 996 997 998 999 1000 1001 1002 1003

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

F
fangJinliang1 已提交
1004
| 参数名     | 类型                  | 必填 | 说明                     |
1005
| -------- | --------------------- | ---- | ------------------------ |
F
fangJinliang1 已提交
1006
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。            |
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
| callback | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1020
```ts
1021 1022 1023 1024 1025 1026 1027
function isNotificationEnabledCallback(err, data) {
    if (err) {
        console.info("isNotificationEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isNotificationEnabled success");
    }
}
F
fangJinliang1 已提交
1028
let bundle = {
1029
    bundle: "bundleName1",
F
fangJinliang1 已提交
1030
};
1031
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
1032 1033
```

1034
## notificationManager.isNotificationEnabled
1035 1036 1037

isNotificationEnabled(bundle: BundleOption): Promise\<boolean\>

F
fangJinliang1 已提交
1038
获取指定应用的通知使能状态(Promise形式)。
1039 1040 1041 1042 1043 1044 1045 1046 1047

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1048
| 参数名   | 类型         | 必填 | 说明       |
1049
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1050
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1051 1052 1053

**返回值:**

F
fangJinliang1 已提交
1054 1055 1056
| 类型               | 说明                                                |
| ------------------ | --------------------------------------------------- |
| Promise\<boolean\> | 以Promise形式返回获取指定应用的通知使能状态的结果。 |
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1069
```ts
F
fangJinliang1 已提交
1070
let bundle = {
1071
    bundle: "bundleName1",
F
fangJinliang1 已提交
1072
};
1073
notificationManager.isNotificationEnabled(bundle).then((data) => {
F
fangJinliang1 已提交
1074
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1075 1076 1077
});
```

1078
## notificationManager.isNotificationEnabled
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091

isNotificationEnabled(callback: AsyncCallback\<boolean\>): void

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1092
| 参数名     | 类型                  | 必填 | 说明                     |
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
| -------- | --------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1106
```ts
1107 1108 1109 1110 1111 1112 1113 1114
function isNotificationEnabledCallback(err, data) {
    if (err) {
        console.info("isNotificationEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isNotificationEnabled success");
    }
}

1115
notificationManager.isNotificationEnabled(isNotificationEnabledCallback);
1116 1117
```

1118
## notificationManager.isNotificationEnabled
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131

isNotificationEnabled(): Promise\<boolean\>

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1132
| 参数名   | 类型         | 必填 | 说明       |
1133
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1134
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取通知使能状态的结果。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1153 1154
```ts
notificationManager.isNotificationEnabled().then((data) => {
F
fangJinliang1 已提交
1155
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1156 1157 1158
});
```

1159
## notificationManager.displayBadge
1160 1161 1162

displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
1163
设定指定应用的角标使能状态(Callback形式)。
1164 1165 1166 1167 1168 1169 1170 1171 1172

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1173
| 参数名     | 类型                  | 必填 | 说明                 |
1174
| -------- | --------------------- | ---- | -------------------- |
F
fangJinliang1 已提交
1175
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。           |
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定角标使能回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1190
```ts
1191 1192 1193 1194 1195 1196 1197
function displayBadgeCallback(err) {
    if (err) {
        console.info("displayBadge failed " + JSON.stringify(err));
    } else {
        console.info("displayBadge success");
    }
}
F
fangJinliang1 已提交
1198
let bundle = {
1199
    bundle: "bundleName1",
F
fangJinliang1 已提交
1200
};
1201
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
1202 1203
```

1204
## notificationManager.displayBadge
1205 1206 1207

displayBadge(bundle: BundleOption, enable: boolean): Promise\<void\>

F
fangJinliang1 已提交
1208
设定指定应用的角标使能状态(Promise形式)。
1209 1210 1211 1212 1213 1214 1215 1216 1217

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1218
| 参数名   | 类型         | 必填 | 说明       |
1219
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1220
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1234
```ts
F
fangJinliang1 已提交
1235
let bundle = {
1236
    bundle: "bundleName1",
F
fangJinliang1 已提交
1237
};
1238
notificationManager.displayBadge(bundle, false).then(() => {
F
fangJinliang1 已提交
1239
	console.info("displayBadge success");
1240 1241 1242
});
```

1243
## notificationManager.isBadgeDisplayed
1244 1245 1246

isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void

F
fangJinliang1 已提交
1247
获取指定应用的角标使能状态(Callback形式)。
1248 1249 1250 1251 1252 1253 1254 1255 1256

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1257
| 参数名     | 类型                  | 必填 | 说明                     |
1258
| -------- | --------------------- | ---- | ------------------------ |
F
fangJinliang1 已提交
1259
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。               |
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
| callback | AsyncCallback\<void\> | 是   | 获取角标使能状态回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1273
```ts
1274 1275 1276 1277 1278 1279 1280
function isBadgeDisplayedCallback(err, data) {
    if (err) {
        console.info("isBadgeDisplayed failed " + JSON.stringify(err));
    } else {
        console.info("isBadgeDisplayed success");
    }
}
F
fangJinliang1 已提交
1281
let bundle = {
1282
    bundle: "bundleName1",
F
fangJinliang1 已提交
1283
};
1284
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
1285 1286
```

1287
## notificationManager.isBadgeDisplayed
1288 1289 1290

isBadgeDisplayed(bundle: BundleOption): Promise\<boolean\>

F
fangJinliang1 已提交
1291
获取指定应用的角标使能状态(Promise形式)。
1292 1293 1294 1295 1296 1297 1298 1299 1300

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1301
| 参数名   | 类型         | 必填 | 说明       |
1302
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1303
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1304 1305 1306 1307 1308

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
1309
| Promise\<boolean\> | 以Promise形式返回获取指定应用的角标使能状态。 |
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1322
```ts
F
fangJinliang1 已提交
1323
let bundle = {
1324
    bundle: "bundleName1",
F
fangJinliang1 已提交
1325
};
1326
notificationManager.isBadgeDisplayed(bundle).then((data) => {
F
fangJinliang1 已提交
1327
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
1328 1329 1330
});
```

1331
## notificationManager.setSlotByBundle
1332 1333 1334

setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
1335
设定指定应用的通知通道(Callback形式)。
1336 1337 1338 1339 1340 1341 1342 1343 1344

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1345
| 参数名     | 类型                  | 必填 | 说明                 |
1346
| -------- | --------------------- | ---- | -------------------- |
F
fangJinliang1 已提交
1347
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。           |
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
| slot     | [NotificationSlot](#notificationslot)      | 是   | 通知通道。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知通道回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1362
```ts
1363 1364 1365 1366 1367 1368 1369
function setSlotByBundleCallback(err) {
    if (err) {
        console.info("setSlotByBundle failed " + JSON.stringify(err));
    } else {
        console.info("setSlotByBundle success");
    }
}
F
fangJinliang1 已提交
1370
let bundle = {
1371
    bundle: "bundleName1",
F
fangJinliang1 已提交
1372 1373
};
let notificationSlot = {
1374
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1375
};
1376
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
1377 1378
```

1379
## notificationManager.setSlotByBundle
1380 1381 1382

setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\<void\>

F
fangJinliang1 已提交
1383
设定指定应用的通知通道(Promise形式)。
1384 1385 1386 1387 1388 1389 1390 1391 1392

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1393
| 参数名   | 类型         | 必填 | 说明       |
1394
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1395 1396
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
| slot   | [NotificationSlot](#notificationslot) | 是   | 通知通道。 |
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1409
```ts
F
fangJinliang1 已提交
1410
let bundle = {
1411
    bundle: "bundleName1",
F
fangJinliang1 已提交
1412 1413
};
let notificationSlot = {
1414
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1415
};
1416
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
F
fangJinliang1 已提交
1417
	console.info("setSlotByBundle success");
1418 1419 1420
});
```

1421
## notificationManager.getSlotsByBundle
1422 1423 1424

getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>): void

F
fangJinliang1 已提交
1425
获取指定应用的所有通知通道(Callback形式)。
1426 1427 1428 1429 1430 1431 1432 1433 1434

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1435
| 参数名     | 类型                                     | 必填 | 说明                 |
1436
| -------- | ---------------------------------------- | ---- | -------------------- |
F
fangJinliang1 已提交
1437
| bundle   | [BundleOption](#bundleoption)                             | 是   | 指定应用的包信息。           |
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
| callback | AsyncCallback<Array\<[NotificationSlot](#notificationslot)\>> | 是   | 获取通知通道回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1451
```ts
1452 1453 1454 1455 1456 1457 1458
function getSlotsByBundleCallback(err, data) {
    if (err) {
        console.info("getSlotsByBundle failed " + JSON.stringify(err));
    } else {
        console.info("getSlotsByBundle success");
    }
}
F
fangJinliang1 已提交
1459
let bundle = {
1460
    bundle: "bundleName1",
F
fangJinliang1 已提交
1461
};
1462
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
1463 1464
```

1465
## notificationManager.getSlotsByBundle
1466 1467 1468

getSlotsByBundle(bundle: BundleOption): Promise<Array\<NotificationSlot\>>

F
fangJinliang1 已提交
1469
获取指定应用的所有通知通道(Promise形式)。
1470 1471 1472 1473 1474 1475 1476 1477 1478

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1479
| 参数名   | 类型         | 必填 | 说明       |
1480
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1481
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1482 1483 1484 1485 1486

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
1487
| Promise<Array\<[NotificationSlot](#notificationslot)\>> | 以Promise形式返回获取指定应用的通知通道。 |
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1500
```ts
F
fangJinliang1 已提交
1501
let bundle = {
1502
    bundle: "bundleName1",
F
fangJinliang1 已提交
1503
};
1504
notificationManager.getSlotsByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
1505
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
1506 1507 1508
});
```

1509
## notificationManager.getSlotNumByBundle
1510 1511 1512

getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>): void

F
fangJinliang1 已提交
1513
获取指定应用的通知通道数量(Callback形式)。
1514 1515 1516 1517 1518 1519 1520 1521 1522

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1523
| 参数名     | 类型                      | 必填 | 说明                   |
1524
| -------- | ------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
1525 1526
| bundle   | [BundleOption](#bundleoption)              | 是   | 指定应用的包信息。             |
| callback | AsyncCallback\<number\> | 是   | 获取通知通道数量回调函数。 |
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1539
```ts
1540 1541 1542 1543 1544 1545 1546
function getSlotNumByBundleCallback(err, data) {
    if (err) {
        console.info("getSlotNumByBundle failed " + JSON.stringify(err));
    } else {
        console.info("getSlotNumByBundle success");
    }
}
F
fangJinliang1 已提交
1547
let bundle = {
1548
    bundle: "bundleName1",
F
fangJinliang1 已提交
1549
};
1550
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
1551 1552
```

1553
## notificationManager.getSlotNumByBundle
1554 1555 1556

getSlotNumByBundle(bundle: BundleOption): Promise\<number\>

F
fangJinliang1 已提交
1557
获取指定应用的通知通道数量(Promise形式)。
1558 1559 1560 1561 1562 1563 1564 1565 1566

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1567
| 参数名   | 类型         | 必填 | 说明       |
1568
| ------ | ------------ | ---- | ---------- |
F
fangJinliang1 已提交
1569
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
1570 1571 1572 1573 1574

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
1575
| Promise\<number\> | 以Promise形式返回获取指定应用的通知通道数量。 |
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1588
```ts
F
fangJinliang1 已提交
1589
let bundle = {
1590
    bundle: "bundleName1",
F
fangJinliang1 已提交
1591
};
1592
notificationManager.getSlotNumByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
1593
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
1594 1595 1596 1597
});
```


1598
## notificationManager.getAllActiveNotifications
1599 1600 1601

getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void

F
fangJinliang1 已提交
1602
获取当前未删除的所有通知(Callback形式)。
1603 1604 1605 1606 1607 1608 1609 1610 1611

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1612
| 参数名     | 类型                                                         | 必填 | 说明                 |
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
| -------- | ------------------------------------------------------------ | ---- | -------------------- |
| callback | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是   | 获取活动通知回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1626
```ts
1627 1628 1629 1630 1631 1632 1633 1634
function getAllActiveNotificationsCallback(err, data) {
    if (err) {
        console.info("getAllActiveNotifications failed " + JSON.stringify(err));
    } else {
        console.info("getAllActiveNotifications success");
    }
}

1635
notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);
1636 1637
```

1638
## notificationManager.getAllActiveNotifications
1639 1640 1641

getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\>

F
fangJinliang1 已提交
1642
获取当前未删除的所有通知(Promise形式)。
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取活动通知。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1666 1667
```ts
notificationManager.getAllActiveNotifications().then((data) => {
F
fangJinliang1 已提交
1668
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
1669 1670 1671
});
```

1672
## notificationManager.getActiveNotificationCount
1673 1674 1675

getActiveNotificationCount(callback: AsyncCallback\<number\>): void

F
fangJinliang1 已提交
1676
获取当前应用未删除的通知数(Callback形式)。
1677 1678 1679 1680 1681

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
1682
| 参数名     | 类型                   | 必填 | 说明                   |
1683
| -------- | ---------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
1684
| callback | AsyncCallback\<number\> | 是   | 获取未删除通知数回调函数。 |
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1696
```ts
1697 1698 1699 1700 1701 1702 1703 1704
function getActiveNotificationCountCallback(err, data) {
    if (err) {
        console.info("getActiveNotificationCount failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotificationCount success");
    }
}

1705
notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);
1706 1707
```

1708
## notificationManager.getActiveNotificationCount
1709 1710 1711

getActiveNotificationCount(): Promise\<number\>

F
fangJinliang1 已提交
1712
获取当前应用未删除的通知数(Promise形式)。
1713 1714 1715 1716 1717

**系统能力**:SystemCapability.Notification.Notification

**返回值:**

F
fangJinliang1 已提交
1718 1719 1720
| 类型              | 说明                                        |
| ----------------- | ------------------------------------------- |
| Promise\<number\> | 以Promise形式返回获取当前应用未删除通知数。 |
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1732 1733
```ts
notificationManager.getActiveNotificationCount().then((data) => {
F
fangJinliang1 已提交
1734
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
1735 1736 1737
});
```

1738
## notificationManager.getActiveNotifications
1739 1740 1741

getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void

F
fangJinliang1 已提交
1742
获取当前应用未删除的通知列表(Callback形式)。
1743 1744 1745 1746 1747

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
1748
| 参数名     | 类型                                                         | 必填 | 说明                           |
1749
| -------- | ------------------------------------------------------------ | ---- | ------------------------------ |
F
fangJinliang1 已提交
1750
| callback | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是   | 获取当前应用通知列表回调函数。 |
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1762
```ts
1763 1764 1765 1766 1767 1768 1769 1770
function getActiveNotificationsCallback(err, data) {
    if (err) {
        console.info("getActiveNotifications failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotifications success");
    }
}

1771
notificationManager.getActiveNotifications(getActiveNotificationsCallback);
1772 1773
```

1774
## notificationManager.getActiveNotifications
1775 1776 1777

getActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\>

F
fangJinliang1 已提交
1778
获取当前应用未删除的通知列表(Promise形式)。
1779 1780 1781 1782 1783

**系统能力**:SystemCapability.Notification.Notification

**返回值:**

F
fangJinliang1 已提交
1784 1785 1786
| 类型                                                         | 说明                                    |
| ------------------------------------------------------------ | --------------------------------------- |
| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取当前应用通知列表。 |
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1798 1799
```ts
notificationManager.getActiveNotifications().then((data) => {
F
fangJinliang1 已提交
1800
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
1801 1802 1803
});
```

1804
## notificationManager.cancelGroup
1805 1806 1807

cancelGroup(groupName: string, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
1808
取消本应用指定组下的通知(Callback形式)。
1809 1810 1811 1812 1813

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
1814
| 参数名      | 类型                  | 必填 | 说明                         |
1815
| --------- | --------------------- | ---- | ---------------------------- |
F
fangJinliang1 已提交
1816 1817
| groupName | string                | 是   | 通知组名称,此名称需要在发布通知时通过[NotificationRequest](#notificationrequest)对象指定。 |
| callback  | AsyncCallback\<void\> | 是   | 取消本应用指定组下通知的回调函数。 |
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1829
```ts
1830 1831 1832 1833 1834 1835 1836 1837
function cancelGroupCallback(err) {
    if (err) {
        console.info("cancelGroup failed " + JSON.stringify(err));
    } else {
        console.info("cancelGroup success");
    }
}

F
fangJinliang1 已提交
1838
let groupName = "GroupName";
1839

1840
notificationManager.cancelGroup(groupName, cancelGroupCallback);
1841 1842
```

1843
## notificationManager.cancelGroup
1844 1845 1846

cancelGroup(groupName: string): Promise\<void\>

F
fangJinliang1 已提交
1847
取消本应用指定组下的通知(Promise形式)。
1848 1849 1850 1851 1852

**系统能力**:SystemCapability.Notification.Notification

**参数:**

F
fangJinliang1 已提交
1853
| 参数名      | 类型   | 必填 | 说明           |
1854
| --------- | ------ | ---- | -------------- |
F
fangJinliang1 已提交
1855
| groupName | string | 是   | 通知组名称。 |
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1867
```ts
F
fangJinliang1 已提交
1868
let groupName = "GroupName";
1869
notificationManager.cancelGroup(groupName).then(() => {
F
fangJinliang1 已提交
1870
	console.info("cancelGroup success");
1871 1872 1873
});
```

1874
## notificationManager.removeGroupByBundle
1875 1876 1877

removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>): void

F
fangJinliang1 已提交
1878
删除指定应用的指定组下的通知(Callback形式)。
1879 1880 1881 1882 1883 1884 1885 1886 1887

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1888
| 参数名      | 类型                  | 必填 | 说明                         |
1889
| --------- | --------------------- | ---- | ---------------------------- |
F
fangJinliang1 已提交
1890 1891 1892
| bundle    | [BundleOption](#bundleoption)          | 是   | 应用的包信息。                   |
| groupName | string                | 是   | 通知组名称。               |
| callback  | AsyncCallback\<void\> | 是   | 删除指定应用指定组下通知的回调函数。 |
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1905
```ts
1906 1907 1908 1909 1910 1911 1912 1913
function removeGroupByBundleCallback(err) {
    if (err) {
        console.info("removeGroupByBundle failed " + JSON.stringify(err));
    } else {
        console.info("removeGroupByBundle success");
    }
}

F
fangJinliang1 已提交
1914 1915
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
1916

1917
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
1918 1919
```

1920
## notificationManager.removeGroupByBundle
1921 1922 1923

removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\<void\>

F
fangJinliang1 已提交
1924
删除指定应用的指定组下的通知(Promise形式)。
1925 1926 1927 1928 1929 1930 1931 1932 1933

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1934
| 参数名      | 类型         | 必填 | 说明           |
1935
| --------- | ------------ | ---- | -------------- |
F
fangJinliang1 已提交
1936 1937
| bundle    | [BundleOption](#bundleoption) | 是   | 应用的包信息。     |
| groupName | string       | 是   | 通知组名称。 |
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1950
```ts
F
fangJinliang1 已提交
1951 1952
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
1953
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
F
fangJinliang1 已提交
1954
	console.info("removeGroupByBundle success");
1955 1956 1957
});
```

1958
## notificationManager.setDoNotDisturbDate
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971

setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>): void

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
1972
| 参数名     | 类型                  | 必填 | 说明                   |
1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1987
```ts
1988 1989 1990 1991 1992 1993 1994 1995
function setDoNotDisturbDateCallback(err) {
    if (err) {
        console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
1996
let doNotDisturbDate = {
1997
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
1998 1999
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2000
};
2001

2002
notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
2003 2004
```

2005
## notificationManager.setDoNotDisturbDate
2006 2007 2008

setDoNotDisturbDate(date: DoNotDisturbDate): Promise\<void\>

F
fangJinliang1 已提交
2009
设置免打扰时间(Promise形式)。
2010 2011 2012 2013 2014 2015 2016 2017 2018

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2019
| 参数名 | 类型             | 必填 | 说明           |
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032
| ---- | ---------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2033
```ts
F
fangJinliang1 已提交
2034
let doNotDisturbDate = {
2035
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2036 2037
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2038
};
2039
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
F
fangJinliang1 已提交
2040
	console.info("setDoNotDisturbDate success");
2041 2042 2043 2044
});
```


2045
## notificationManager.setDoNotDisturbDate
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058

setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback\<void\>): void

指定用户设置免打扰时间(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2059
| 参数名     | 类型                  | 必填 | 说明                   |
2060 2061
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
F
fangJinliang1 已提交
2062
| userId   | number                | 是   | 设置免打扰时间的用户ID。 |
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

2076
```ts
2077 2078 2079 2080 2081 2082 2083 2084
function setDoNotDisturbDateCallback(err) {
    if (err) {
        console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
2085
let doNotDisturbDate = {
2086
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2087 2088
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2089
};
2090

F
fangJinliang1 已提交
2091
let userId = 1;
2092

2093
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
2094 2095
```

2096
## notificationManager.setDoNotDisturbDate
2097 2098 2099

setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise\<void\>

F
fangJinliang1 已提交
2100
指定用户设置免打扰时间(Promise形式)。
2101 2102 2103 2104 2105 2106 2107 2108 2109

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2110
| 参数名   | 类型             | 必填 | 说明           |
2111 2112
| ------ | ---------------- | ---- | -------------- |
| date   | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |
F
fangJinliang1 已提交
2113
| userId | number           | 是   | 设置免打扰时间的用户ID。 |
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

2126
```ts
F
fangJinliang1 已提交
2127
let doNotDisturbDate = {
2128
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2129 2130
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2131
};
2132

F
fangJinliang1 已提交
2133
let userId = 1;
2134

2135
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
F
fangJinliang1 已提交
2136
	console.info("setDoNotDisturbDate success");
2137 2138 2139 2140
});
```


2141
## notificationManager.getDoNotDisturbDate
2142 2143 2144

getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>): void

F
fangJinliang1 已提交
2145
查询免打扰时间(Callback形式)。
2146 2147 2148 2149 2150 2151 2152 2153 2154

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2155
| 参数名     | 类型                              | 必填 | 说明                   |
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2169
```ts
2170 2171 2172 2173 2174 2175 2176 2177
function getDoNotDisturbDateCallback(err,data) {
    if (err) {
        console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("getDoNotDisturbDate success");
    }
}

2178
notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);
2179 2180
```

2181
## notificationManager.getDoNotDisturbDate
2182 2183 2184

getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>

F
fangJinliang1 已提交
2185
查询免打扰时间(Promise形式)。
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**返回值:**

| 类型                                             | 说明                                      |
| ------------------------------------------------ | ----------------------------------------- |
F
fangJinliang1 已提交
2197
| Promise\<[DoNotDisturbDate](#donotdisturbdate)\> | 以Promise形式返回获取查询到的免打扰时间。 |
2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2209 2210
```ts
notificationManager.getDoNotDisturbDate().then((data) => {
F
fangJinliang1 已提交
2211
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2212 2213 2214 2215
});
```


2216
## notificationManager.getDoNotDisturbDate
2217 2218 2219

getDoNotDisturbDate(userId: number, callback: AsyncCallback\<DoNotDisturbDate\>): void

F
fangJinliang1 已提交
2220
查询指定用户的免打扰时间(Callback形式)。
2221 2222 2223 2224 2225 2226 2227 2228 2229

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2230
| 参数名     | 类型                              | 必填 | 说明                   |
2231 2232
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |
F
fangJinliang1 已提交
2233
| userId   | number                            | 是   | 用户ID。 |
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

2246
```ts
2247 2248 2249 2250 2251 2252 2253 2254
function getDoNotDisturbDateCallback(err,data) {
    if (err) {
        console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("getDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
2255
let userId = 1;
2256

2257
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
2258 2259
```

2260
## notificationManager.getDoNotDisturbDate
2261 2262 2263

getDoNotDisturbDate(userId: number): Promise\<DoNotDisturbDate\>

F
fangJinliang1 已提交
2264
查询指定用户的免打扰时间(Promise形式)。
2265 2266 2267 2268 2269 2270 2271 2272 2273

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2274
| 参数名     | 类型                              | 必填 | 说明                   |
2275
| -------- | --------------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
2276
| userId   | number                            | 是   | 用户ID。 |
2277 2278 2279 2280 2281

**返回值:**

| 类型                                             | 说明                                      |
| ------------------------------------------------ | ----------------------------------------- |
F
fangJinliang1 已提交
2282
| Promise\<[DoNotDisturbDate](#donotdisturbdate)\> | 以Promise形式返回获取查询到的免打扰时间。 |
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

2295
```ts
F
fangJinliang1 已提交
2296
let userId = 1;
2297

2298
notificationManager.getDoNotDisturbDate(userId).then((data) => {
F
fangJinliang1 已提交
2299
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2300 2301 2302 2303
});
```


F
fangJinliang1 已提交
2304
## notificationManager.isSupportDoNotDisturbMode
2305

F
fangJinliang1 已提交
2306
 isSupportDoNotDisturbMode(callback: AsyncCallback\<boolean\>): void
2307

F
fangJinliang1 已提交
2308
查询是否支持免打扰功能(Callback形式)。
2309 2310 2311 2312 2313 2314 2315 2316 2317

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2318
| 参数名     | 类型                     | 必填 | 说明                             |
2319
| -------- | ------------------------ | ---- | -------------------------------- |
F
fangJinliang1 已提交
2320
| callback | AsyncCallback\<boolean\> | 是   | 查询是否支持免打扰功能回调函数。 |
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2332
```ts
F
fangJinliang1 已提交
2333
function isSupportDoNotDisturbModeCallback(err,data) {
2334
    if (err) {
F
fangJinliang1 已提交
2335
        console.info("isSupportDoNotDisturbMode failed " + JSON.stringify(err));
2336
    } else {
F
fangJinliang1 已提交
2337
        console.info("isSupportDoNotDisturbMode success");
2338 2339 2340
    }
}

F
fangJinliang1 已提交
2341
notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);
2342 2343
```

F
fangJinliang1 已提交
2344
## notificationManager.isSupportDoNotDisturbMode
2345

F
fangJinliang1 已提交
2346
isSupportDoNotDisturbMode(): Promise\<boolean\>
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359

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

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
2360
| Promise\<boolean\> | 以Promise形式返回获取是否支持免打扰功能的结果。 |
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2372
```ts
F
fangJinliang1 已提交
2373
notificationManager.isSupportDoNotDisturbMode().then((data) => {
F
fangJinliang1 已提交
2374
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
2375 2376 2377
});
```

2378
## notificationManager.isSupportTemplate
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404

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

查询模板是否存在(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**参数:**

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

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600011  | Read template config failed.        |

**示例:**

```javascript
F
fangJinliang1 已提交
2405
let templateName = 'process';
2406 2407 2408 2409 2410 2411 2412 2413
function isSupportTemplateCallback(err, data) {
    if (err) {
        console.info("isSupportTemplate failed " + JSON.stringify(err));
    } else {
        console.info("isSupportTemplate success");
    }
}

2414
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);
2415 2416
```

2417
## notificationManager.isSupportTemplate
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 2444 2445 2446 2447 2448

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

查询模板是否存在(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**参数:**

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

**返回值:**

| 类型               | 说明            |
| ------------------ | --------------- |
| Promise\<boolean\> | Promise方式返回模板是否存在的结果。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600011  | Read template config failed.        |

**示例:**

```javascript
F
fangJinliang1 已提交
2449
let templateName = 'process';
2450

2451
notificationManager.isSupportTemplate(templateName).then((data) => {
2452 2453 2454 2455
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
```

2456
## notificationManager.requestEnableNotification
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488

requestEnableNotification(callback: AsyncCallback\<void\>): void

应用请求通知使能(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| callback | AsyncCallback\<void\> | 是   | 应用请求通知使能的回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
function requestEnableNotificationCallback(err) {
    if (err) {
        console.info("requestEnableNotification failed " + JSON.stringify(err));
    } else {
        console.info("requestEnableNotification success");
    }
};

2489
notificationManager.requestEnableNotification(requestEnableNotificationCallback);
2490 2491
```

2492
## notificationManager.requestEnableNotification
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510

requestEnableNotification(): Promise\<void\>

应用请求通知使能(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2511
notificationManager.requestEnableNotification().then(() => {
F
fangJinliang1 已提交
2512 2513
    console.info("requestEnableNotification success");
});
2514 2515 2516 2517
```



2518
## notificationManager.setDistributedEnable
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533

setDistributedEnable(enable: boolean, callback: AsyncCallback\<void\>): void

设置设备是否支持分布式通知(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2534
| enable   | boolean                  | 是   | 是否支持。 |
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
| callback | AsyncCallback\<void\> | 是   | 设置设备是否支持分布式通知的回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
function setDistributedEnableCallback() {
    if (err) {
        console.info("setDistributedEnable failed " + JSON.stringify(err));
    } else {
        console.info("setDistributedEnable success");
    }
};

F
fangJinliang1 已提交
2557
let enable = true;
2558

2559
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
2560 2561
```

2562
## notificationManager.setDistributedEnable
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577

setDistributedEnable(enable: boolean): Promise\<void>

设置设备是否支持分布式通知(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2578
| enable   | boolean                  | 是   | 是否支持。 |
2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
F
fangJinliang1 已提交
2592
let enable = true;
2593

2594
notificationManager.setDistributedEnable(enable).then(() => {
F
fangJinliang1 已提交
2595
        console.info("setDistributedEnable success");
2596 2597 2598 2599
    });
```


2600
## notificationManager.isDistributedEnabled
2601 2602 2603

isDistributedEnabled(callback: AsyncCallback\<boolean>): void

F
fangJinliang1 已提交
2604
查询设备是否支持分布式通知(Callback形式)。
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625

**系统能力**:SystemCapability.Notification.Notification

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| callback | AsyncCallback\<boolean\> | 是   | 设备是否支持分布式通知的回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
F
fangJinliang1 已提交
2626
function isDistributedEnabledCallback(err, data) {
2627 2628 2629
    if (err) {
        console.info("isDistributedEnabled failed " + JSON.stringify(err));
    } else {
F
fangJinliang1 已提交
2630
        console.info("isDistributedEnabled success " + JSON.stringify(data));
2631 2632 2633
    }
};

2634
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);
2635 2636 2637 2638
```



2639
## notificationManager.isDistributedEnabled
2640 2641 2642

isDistributedEnabled(): Promise\<boolean>

F
fangJinliang1 已提交
2643
查询设备是否支持分布式通知(Promise形式)。
2644 2645 2646 2647 2648

**系统能力**:SystemCapability.Notification.Notification

**返回值:**

F
fangJinliang1 已提交
2649 2650 2651
| 类型               | 说明                                          |
| ------------------ | --------------------------------------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。 |
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2665
notificationManager.isDistributedEnabled()
2666
    .then((data) => {
F
fangJinliang1 已提交
2667
        console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
2668 2669 2670 2671
    });
```


2672
## notificationManager.setDistributedEnableByBundle
2673 2674 2675

setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void>): void

F
fangJinliang1 已提交
2676
设置指定应用是否支持分布式通知(Callback形式)。
2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2688
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包信息。                   |
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
| enable   | boolean                  | 是   | 是否支持。                       |
| callback | AsyncCallback\<void\> | 是   | 应用程序是否支持分布式通知的回调函数。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
function setDistributedEnableByBundleCallback(err) {
    if (err) {
        console.info("enableDistributedByBundle failed " + JSON.stringify(err));
    } else {
        console.info("enableDistributedByBundle success");
    }
};

F
fangJinliang1 已提交
2713
let bundle = {
2714
    bundle: "bundleName1",
F
fangJinliang1 已提交
2715
};
2716

F
fangJinliang1 已提交
2717
let enable = true
2718

2719
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
2720 2721 2722 2723
```



2724
## notificationManager.setDistributedEnableByBundle
2725 2726 2727

setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise\<void>

F
fangJinliang1 已提交
2728
设置指定应用是否支持分布式通知(Promise形式)。
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |
| enable   | boolean                  | 是   | 是否支持。                  |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
F
fangJinliang1 已提交
2756
let bundle = {
2757
    bundle: "bundleName1",
F
fangJinliang1 已提交
2758
};
2759

F
fangJinliang1 已提交
2760
let enable = true
2761

2762 2763 2764
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
    console.info("setDistributedEnableByBundle success");
});
2765 2766
```

2767
## notificationManager.isDistributedEnabledByBundle
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783

isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\<boolean>): void

根据应用的包获取应用程序是否支持分布式通知(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                     |
F
fangJinliang1 已提交
2784
| callback | AsyncCallback\<boolean\> | 是   | 查询指定应用是否支持分布式通知的回调函数。 |
2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
function isDistributedEnabledByBundleCallback(data) {
    if (err) {
        console.info("isDistributedEnabledByBundle failed " + JSON.stringify(err));
    } else {
F
fangJinliang1 已提交
2803
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
2804 2805 2806
    }
};

F
fangJinliang1 已提交
2807
let bundle = {
2808
    bundle: "bundleName1",
F
fangJinliang1 已提交
2809
};
2810

2811
notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
2812 2813
```

2814
## notificationManager.isDistributedEnabledByBundle
2815 2816 2817

isDistributedEnabledByBundle(bundle: BundleOption): Promise\<boolean>

F
fangJinliang1 已提交
2818
查询指定应用是否支持分布式通知(Promise形式)。
2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |

**返回值:**

F
fangJinliang1 已提交
2834 2835 2836
| 类型               | 说明                                              |
| ------------------ | ------------------------------------------------- |
| Promise\<boolean\> | Promise方式返回指定应用是否支持分布式通知的结果。 |
2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
F
fangJinliang1 已提交
2851
let bundle = {
2852
    bundle: "bundleName1",
F
fangJinliang1 已提交
2853
};
2854

2855
notificationManager.isDistributedEnabledByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
2856 2857
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
2858 2859 2860
```


2861
## notificationManager.getDeviceRemindType
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876

getDeviceRemindType(callback: AsyncCallback\<DeviceRemindType\>): void

获取通知的提醒方式(Callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名   | 类型                               | 必填 | 说明                       |
| -------- | --------------------------------- | ---- | -------------------------- |
F
fangJinliang1 已提交
2877
| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype)\> | 是   | 获取通知提醒方式的回调函数。 |
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
function getDeviceRemindTypeCallback(err, data) {
    if (err) {
        console.info("getDeviceRemindType failed " + JSON.stringify(err));
    } else {
        console.info("getDeviceRemindType success");
    }
};

2898
notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);
2899 2900
```

2901
## notificationManager.getDeviceRemindType
2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916

getDeviceRemindType(): Promise\<DeviceRemindType\>

获取通知的提醒方式(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**返回值:**

| 类型               | 说明            |
| ------------------ | --------------- |
F
fangJinliang1 已提交
2917
| Promise\<[DeviceRemindType](#deviceremindtype)\> | Promise方式返回获取通知提醒方式的结果。 |
2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2930
notificationManager.getDeviceRemindType().then((data) => {
F
fangJinliang1 已提交
2931 2932
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
2933 2934 2935
```


2936
## notificationManager.publishAsBundle
2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949

publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback\<void\>): void

发布代理通知(callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

F
fangJinliang1 已提交
2950 2951 2952 2953 2954 2955
| 参数名               | 类型                                        | 必填 | 说明                                     |
| -------------------- | ------------------------------------------- | ---- | ---------------------------------------- |
| request              | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| representativeBundle | string                                      | 是   | 被代理应用的包名。                       |
| userId               | number                                      | 是   | 用户ID。                                 |
| callback             | AsyncCallback                               | 是   | 发布代理通知的回调方法。                 |
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600008  | The user is not exist.                    |
| 1600009  | Over max number notifications per second. |

**示例:**

2971
```ts
2972
//publishAsBundle回调
F
fangJinliang1 已提交
2973
function callback(err) {
2974 2975 2976 2977 2978 2979 2980
    if (err) {
        console.info("publishAsBundle failed " + JSON.stringify(err));
    } else {
        console.info("publishAsBundle success");
    }
}
// 被代理应用的包名
F
fangJinliang1 已提交
2981
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
2982
// 用户ID
F
fangJinliang1 已提交
2983
let userId = 100;
F
fangJinliang1 已提交
2984 2985
// NotificationRequest对象
let request = {
2986 2987
    id: 1,
    content: {
2988
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
2989 2990 2991 2992 2993 2994
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
2995
};
2996

2997
notificationManager.publishAsBundle(request, representativeBundle, userId, callback);
2998 2999
```

3000
## notificationManager.publishAsBundle
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016

publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise\<void\>

发布代理通知(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**


| 参数名               | 类型                                        | 必填 | 说明                                          |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
F
fangJinliang1 已提交
3017
| request              | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
3018
| representativeBundle | string                                      | 是   | 被代理应用的包名。                            |
F
fangJinliang1 已提交
3019
| userId               | number                                      | 是   | 用户ID。                            |
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034

**错误码:**

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 1600001  | Internal error.                           |
| 1600002  | Marshalling or unmarshalling error.       |
| 1600003  | Failed to connect service.                |
| 1600004  | Notification is not enabled.              |
| 1600005  | Notification slot is not enabled.         |
| 1600008  | The user is not exist.                    |
| 1600009  | Over max number notifications per second. |

**示例:**

3035
```ts
3036
// 被代理应用的包名
F
fangJinliang1 已提交
3037
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3038
// 用户ID
F
fangJinliang1 已提交
3039
let userId = 100;
F
fangJinliang1 已提交
3040
// NotificationRequest对象
F
fangJinliang1 已提交
3041
let request = {
3042 3043
    id: 1,
    content: {
3044
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3045 3046 3047 3048 3049 3050
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3051
};
3052

3053
notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
F
fangJinliang1 已提交
3054
	console.info("publishAsBundle success");
3055 3056 3057
});
```

3058
## notificationManager.cancelAsBundle
3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077

cancelAsBundle(id: number, representativeBundle: string, userId: number, callback: AsyncCallback\<void\>): void

取消代理通知(callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名               | 类型          | 必填 | 说明                     |
| -------------------- | ------------- | ---- | ------------------------ |
| id                   | number        | 是   | 通知ID。                 |
| representativeBundle | string        | 是   | 被代理应用的包名。       |
F
fangJinliang1 已提交
3078
| userId               | number        | 是   | 用户ID。       |
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092
| callback             | AsyncCallback | 是   | 取消代理通知的回调方法。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |
| 1600008  | The user is not exist.              |

**示例:**

3093
```ts
F
fangJinliang1 已提交
3094
// cancelAsBundle
3095 3096 3097 3098 3099 3100 3101 3102
function cancelAsBundleCallback(err) {
    if (err) {
        console.info("cancelAsBundle failed " + JSON.stringify(err));
    } else {
        console.info("cancelAsBundle success");
    }
}
// 被代理应用的包名
F
fangJinliang1 已提交
3103
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3104
// 用户ID
F
fangJinliang1 已提交
3105
let userId = 100;
3106

3107
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
3108 3109
```

3110
## notificationManager.cancelAsBundle
3111 3112 3113

cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise\<void\>

F
fangJinliang1 已提交
3114
取消代理通知(Promise形式)。
3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名               | 类型   | 必填 | 说明               |
| -------------------- | ------ | ---- | ------------------ |
| id                   | number | 是   | 通知ID。           |
| representativeBundle | string | 是   | 被代理应用的包名。 |
F
fangJinliang1 已提交
3130
| userId               | number | 是   | 用户ID。 |
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |
| 1600008  | The user is not exist.              |

**示例:**

3144
```ts
3145
// 被代理应用的包名
F
fangJinliang1 已提交
3146
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3147
// 用户ID
F
fangJinliang1 已提交
3148
let userId = 100;
3149

3150
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
3151 3152 3153 3154
	console.info("cancelAsBundle success");
});
```

3155
## notificationManager.setNotificationEnableSlot 
3156 3157 3158

setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback\<void>): void

F
fangJinliang1 已提交
3159
设置指定应用的指定渠道类型的使能状态(Callback形式)。
3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
3171
| bundle   | [BundleOption](#bundleoption) | 是   | 应用的包信息。           |
3172 3173
| type     | [SlotType](#slottype)         | 是   | 指定渠道类型。         |
| enable   | boolean                       | 是   | 使能状态。             |
F
fangJinliang1 已提交
3174
| callback | AsyncCallback\<void\>         | 是   | 设置渠道使能回调函数。 |
3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3187
```ts
F
fangJinliang1 已提交
3188
// setNotificationEnableSlot
3189 3190 3191 3192 3193 3194 3195 3196
function setNotificationEnableSlotCallback(err) {
    if (err) {
        console.info("setNotificationEnableSlot failed " + JSON.stringify(err));
    } else {
        console.info("setNotificationEnableSlot success");
    }
};

3197
notificationManager.setNotificationEnableSlot(
3198
    { bundle: "ohos.samples.notification", },
3199
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3200 3201 3202 3203
    true,
    setNotificationEnableSlotCallback);
```

3204
## notificationManager.setNotificationEnableSlot
3205 3206 3207

setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise\<void> 

F
fangJinliang1 已提交
3208
设置指定应用的指定渠道类型的使能状态(Promise形式)。
3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3220 3221
| bundle | [BundleOption](#bundleoption) | 是   | 应用的包信息。   |
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234
| enable | boolean                       | 是   | 使能状态。     |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3235
```ts
F
fangJinliang1 已提交
3236
// setNotificationEnableSlot
3237
notificationManager.setNotificationEnableSlot(
3238
    { bundle: "ohos.samples.notification", },
3239
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3240
    true).then(() => {
F
fangJinliang1 已提交
3241
        console.info("setNotificationEnableSlot success");
3242 3243 3244
    });
```

3245
## notificationManager.isNotificationSlotEnabled
3246 3247 3248

isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback\<boolean\>): void

F
fangJinliang1 已提交
3249
获取指定应用的指定渠道类型的使能状态(Callback形式)。
3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
3261 3262 3263
| bundle   | [BundleOption](#bundleoption) | 是   | 应用的包信息。           |
| type     | [SlotType](#slottype)         | 是   | 渠道类型。         |
| callback | AsyncCallback\<boolean\>         | 是   | 获取渠道使能状态回调函数。 |
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3276
```ts
F
fangJinliang1 已提交
3277
// isNotificationSlotEnabled
3278 3279 3280 3281 3282 3283 3284 3285
function getEnableSlotCallback(err, data) {
    if (err) {
        console.info("isNotificationSlotEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isNotificationSlotEnabled success");
    }
};

3286
notificationManager.isNotificationSlotEnabled(
3287
    { bundle: "ohos.samples.notification", },
3288
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3289 3290 3291
    getEnableSlotCallback);
```

3292
## notificationManager.isNotificationSlotEnabled
3293 3294 3295

isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\<boolean\>  

F
fangJinliang1 已提交
3296
获取指定应用的指定渠道类型的使能状态(Promise形式)。
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3308 3309
| bundle | [BundleOption](#bundleoption) | 是   | 应用的包信息。   |
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回指定类型的渠道使能状态。 |

**错误码:**

| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3328
```ts
F
fangJinliang1 已提交
3329
// isNotificationSlotEnabled
3330 3331
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => {
F
fangJinliang1 已提交
3332 3333
    console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
3334 3335 3336
```


3337
## notificationManager.setSyncNotificationEnabledWithoutApp
3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352

setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback\<void\>): void

设置是否将通知同步到未安装应用程序的设备(callback形式)。

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:** 

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3353 3354
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
| callback | AsyncCallback\<void\>    | 是   | 设置是否将通知同步到未安装应用程序的设备的回调函数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3368
```ts
3369 3370 3371
let userId = 100;
let enable = true;

F
fangJinliang1 已提交
3372
function callback(err) {
3373 3374 3375 3376 3377 3378 3379
    if (err) {
        console.info("setSyncNotificationEnabledWithoutApp failed " + JSON.stringify(err));
    } else {
        console.info("setSyncNotificationEnabledWithoutApp success");
    }
}

3380
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);
3381 3382 3383
```


3384
## notificationManager.setSyncNotificationEnabledWithoutApp
3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399

setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise\<void>

设置是否将通知同步到未安装应用程序的设备(Promise形式)。

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3400 3401
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回设置是否将通知同步到未安装应用程序的设备的结果。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3420
```ts
3421 3422 3423
let userId = 100;
let enable = true;

3424
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
F
fangJinliang1 已提交
3425 3426 3427 3428
    console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err) => {
    console.info('setSyncNotificationEnabledWithoutApp, err:' + JSON.stringify(err));
});
3429 3430 3431
```


3432
## notificationManager.getSyncNotificationEnabledWithoutApp
3433 3434 3435

getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback\<boolean>): void

F
fangJinliang1 已提交
3436
获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。
3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3448 3449
| userId | number | 是   | 用户ID。   |
| callback | AsyncCallback\<boolean\>         | 是   | 获取同步通知到未安装应用程序设备的开关是否开启的回调函数。 |
3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3462
```ts
3463 3464
let userId = 100;

Z
zhongjianfei 已提交
3465
function getSyncNotificationEnabledWithoutAppCallback(err, data) {
3466
    if (err) {
F
fangJinliang1 已提交
3467
        console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
3468
    } else {
F
fangJinliang1 已提交
3469
        console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
3470 3471 3472
    }
}

3473
notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);
3474 3475 3476
```


3477
## notificationManager.getSyncNotificationEnabledWithoutApp
3478 3479 3480

getSyncNotificationEnabledWithoutApp(userId: number): Promise\<boolean>

F
fangJinliang1 已提交
3481
获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。
3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492

**系统能力**:SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3493
| userId | number | 是   | 用户ID。   |
3494 3495 3496

**返回值:**

F
fangJinliang1 已提交
3497 3498 3499
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 |
3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3512
```ts
3513
let userId = 100;
3514
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => {
F
fangJinliang1 已提交
3515 3516 3517 3518
    console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err) => {
    console.info('getSyncNotificationEnabledWithoutApp, err:' + err);
});
3519 3520 3521 3522 3523 3524 3525 3526 3527
```


## DoNotDisturbDate

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

**系统API**:此接口为系统接口,三方应用不支持调用。

F
fangJinliang1 已提交
3528 3529 3530 3531 3532
| 名称  | 类型                                  | 可读 | 可写 | 说明                   |
| ----- | ------------------------------------- | ---- | ---- | ---------------------- |
| type  | [DoNotDisturbType](#donotdisturbtype) | 是   | 是   | 免打扰设置的时间类型。 |
| begin | Date                                  | 是   | 是   | 免打扰设置的起点时间。 |
| end   | Date                                  | 是   | 是   | 免打扰设置的终点时间。 |
3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576

## DoNotDisturbType

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

**系统API**: 此接口为系统接口,三方应用不支持调用。

| 名称         | 值               | 说明                                       |
| ------------ | ---------------- | ------------------------------------------ |
| TYPE_NONE    | 0 | 非通知勿扰类型。                           |
| TYPE_ONCE    | 1 | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
| TYPE_DAILY   | 2 | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
| TYPE_CLEARLY | 3 | 以设置时间段(明确年月日时分)执行勿扰。     |


## ContentType

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
| NOTIFICATION_CONTENT_BASIC_TEXT   | NOTIFICATION_CONTENT_BASIC_TEXT | 普通类型通知。     |
| NOTIFICATION_CONTENT_LONG_TEXT    | NOTIFICATION_CONTENT_LONG_TEXT | 长文本类型通知。   |
| NOTIFICATION_CONTENT_PICTURE      | NOTIFICATION_CONTENT_PICTURE | 图片类型通知。     |
| NOTIFICATION_CONTENT_CONVERSATION | NOTIFICATION_CONTENT_CONVERSATION | 社交类型通知。     |
| NOTIFICATION_CONTENT_MULTILINE    | NOTIFICATION_CONTENT_MULTILINE | 多行文本类型通知。 |

## SlotLevel

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
| LEVEL_NONE                        | 0           | 表示关闭通知功能。     |
| LEVEL_MIN                         | 1           | 表示通知功能已启用,但状态栏中不显示通知图标,且没有横幅或提示音。 |
| LEVEL_LOW                         | 2           | 表示通知功能已启用,且状态栏中显示通知图标,但没有横幅或提示音。 |
| LEVEL_DEFAULT                     | 3           | 表示通知功能已启用,状态栏中显示通知图标,没有横幅但有提示音。 |
| LEVEL_HIGH                        | 4           | 表示通知功能已启用,状态栏中显示通知图标,有横幅和提示音。 |


## BundleOption

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3577 3578 3579 3580
| 名称   | 类型   | 可读 | 可写 | 说明   |
| ------ | ------ |---- | --- |  ------ |
| bundle | string | 是  | 是  | 应用的包信息。 |
| uid    | number | 是  | 是  | 用户ID。 |
3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601


## SlotType

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

| 名称                 | 值       | 说明       |
| -------------------- | -------- | ---------- |
| UNKNOWN_TYPE         | 0 | 未知类型。 |
| SOCIAL_COMMUNICATION | 1 | 社交类型。 |
| SERVICE_INFORMATION  | 2 | 服务类型。 |
| CONTENT_INFORMATION  | 3 | 内容类型。 |
| OTHER_TYPES          | 0xFFFF | 其他类型。 |


## NotificationActionButton

描述通知中显示的操作按钮。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3602 3603 3604 3605 3606 3607
| 名称      | 类型                                            | 可读 | 可写 | 说明                      |
| --------- | ----------------------------------------------- | --- | ---- | ------------------------- |
| title     | string                                          | 是  | 是  | 按钮标题。                  |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md)   | 是  | 是  | 点击按钮时触发的WantAgent。 |
| extras    | { [key: string]: any }                          | 是  | 是  | 按钮扩展信息。              |
| userInput | [NotificationUserInput](#notificationuserinput) | 是  | 是  | 用户输入对象实例。          |
3608 3609 3610 3611 3612 3613 3614 3615


## NotificationBasicContent

描述普通文本通知。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3616 3617 3618 3619 3620
| 名称           | 类型   | 可读 | 可写 | 说明                               |
| -------------- | ------ | ---- | ---- | ---------------------------------- |
| title          | string | 是   | 是   | 通知标题。                         |
| text           | string | 是   | 是   | 通知内容。                         |
| additionalText | string | 是   | 是   | 通知附加内容,是对通知内容的补充。 |
3621 3622 3623 3624 3625 3626 3627 3628


## NotificationLongTextContent

描述长文本通知。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3629 3630 3631 3632 3633 3634 3635 3636
| 名称           | 类型   | 可读 | 可写 | 说明                             |
| -------------- | ------ | ---- | --- | -------------------------------- |
| title          | string | 是  | 是  | 通知标题。                         |
| text           | string | 是  | 是  | 通知内容。                         |
| additionalText | string | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
| longText       | string | 是  | 是  | 通知的长文本。                     |
| briefText      | string | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | string | 是  | 是  | 通知展开时的标题。                 |
3637 3638 3639 3640 3641 3642 3643 3644


## NotificationMultiLineContent

描述多行文本通知。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3645 3646 3647 3648 3649 3650 3651 3652
| 名称           | 类型            | 可读 | 可写 | 说明                             |
| -------------- | --------------- | --- | --- | -------------------------------- |
| title          | string          | 是  | 是  | 通知标题。                         |
| text           | string          | 是  | 是  | 通知内容。                         |
| additionalText | string          | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
| briefText      | string          | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| longTitle      | string          | 是  | 是  | 通知展开时的标题。                 |
| lines          | Array\<string\> | 是  | 是  | 通知的多行文本。                   |
3653 3654 3655 3656 3657 3658 3659 3660


## NotificationPictureContent

描述附有图片的通知。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3661 3662 3663 3664 3665 3666 3667 3668
| 名称           | 类型           | 可读 | 可写 | 说明                             |
| -------------- | -------------- | ---- | --- | -------------------------------- |
| title          | string         | 是  | 是  | 通知标题。                         |
| text           | string         | 是  | 是  | 通知内容。                         |
| additionalText | string         | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
| briefText      | string         | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | string         | 是  | 是  | 通知展开时的标题。                 |
| picture        | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知的图片内容。                   |
3669 3670 3671 3672 3673 3674 3675 3676


## NotificationContent

描述通知类型。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3677 3678 3679 3680 3681 3682 3683
| 名称        | 类型                                                         | 可读 | 可写 | 说明               |
| ----------- | ------------------------------------------------------------ | ---- | --- | ------------------ |
| contentType | [ContentType](#contenttype)                                  | 是  | 是  | 通知内容类型。       |
| normal      | [NotificationBasicContent](#notificationbasiccontent)        | 是  | 是  | 基本类型通知内容。   |
| longText    | [NotificationLongTextContent](#notificationlongtextcontent)  | 是  | 是  | 长文本类型通知内容。 |
| multiLine   | [NotificationMultiLineContent](#notificationmultilinecontent) | 是  | 是  | 多行类型通知内容。   |
| picture     | [NotificationPictureContent](#notificationpicturecontent)    | 是  | 是  | 图片类型通知内容。   |
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693


## NotificationFlagStatus

描述通知标志状态。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

**系统接口**:此接口为系统接口,三方应用不支持调用。

F
fangJinliang1 已提交
3694
| 名称           | 值  | 说明                               |
3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
| -------------- | --- | --------------------------------- |
| TYPE_NONE      | 0   | 默认标志。                         |
| TYPE_OPEN      | 1   | 通知标志打开。                     |
| TYPE_CLOSE     | 2   | 通知标志关闭。                     |


## NotificationFlags

描述通知标志的实例。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3707 3708 3709 3710
| 名称             | 类型                    | 可读 | 可写 | 说明                               |
| ---------------- | ---------------------- | ---- | ---- | --------------------------------- |
| soundEnabled     | [NotificationFlagStatus](#notificationflagstatus) | 是   | 否   | 是否启用声音提示。                  |
| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是   | 否   | 是否启用振动提醒功能。               |
3711 3712 3713 3714 3715 3716 3717 3718


## NotificationRequest

描述通知的请求。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757
| 名称                  | 类型                                          | 可读 | 可写 | 说明                       |
| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- |
| content               | [NotificationContent](#notificationcontent)   | 是  | 是  | 通知内容。                   |
| id                    | number                                        | 是  | 是  | 通知ID。                     |
| slotType              | [SlotType](#slottype)                         | 是  | 是  | 通道类型。                   |
| isOngoing             | boolean                                       | 是  | 是  | 是否进行时通知。             |
| isUnremovable         | boolean                                       | 是  | 是  | 是否可移除。                 |
| deliveryTime          | number                                        | 是  | 是  | 通知发送时间。               |
| tapDismissed          | boolean                                       | 是  | 是  | 通知是否自动清除。           |
| autoDeletedTime       | number                                        | 是  | 是  | 自动清除的时间。             |
| wantAgent             | [WantAgent](js-apis-app-ability-wantAgent.md) | 是  | 是  | 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](#notificationactionbutton)\>             | 是  | 是  | 通知按钮,最多两个按钮。     |
| smallIcon             | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知小图标。可选字段,大小不超过30KB。 |
| largeIcon             | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知大图标。可选字段,大小不超过30KB。 |
| creatorBundleName     | string                                        | 是  | 否  | 创建通知的包名。             |
| creatorUid            | number                                        | 是  | 否  | 创建通知的UID。              |
| creatorPid            | number                                        | 是  | 否  | 创建通知的PID。              |
| creatorUserId| number                                    | 是  | 否  | 创建通知的UserId。           |
| hashCode              | string                                        | 是  | 否  | 通知唯一标识。               |
| classification        | string                                        | 是  | 是  | 通知分类。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| groupName| string                                        | 是  | 是  | 组通知名称。                 |
| template | [NotificationTemplate](#notificationtemplate) | 是  | 是  | 通知模板。                   |
| isRemoveAllowed | boolean                                | 是  | 否  | 通知是否能被移除。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| source   | number                                        | 是  | 否  | 通知源。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| distributedOption   | [DistributedOptions](#distributedoptions)                 | 是  | 是  | 分布式通知的选项。          |
| deviceId | string                                        | 是  | 否  | 通知源的deviceId。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。          |
| notificationFlags | [NotificationFlags](#notificationflags)                    | 是  | 否  | 获取NotificationFlags。          |
| removalWantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是  | 是  | 当移除通知时,通知将被重定向到的WantAgent实例。          |
| badgeNumber | number                    | 是  | 是  | 应用程序图标上显示的通知数。          |
3758 3759 3760 3761 3762 3763 3764 3765


## DistributedOptions

描述分布式选项。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3766 3767 3768 3769 3770 3771
| 名称                   | 类型            | 可读 | 可写 | 说明                               |
| ---------------------- | -------------- | ---- | ---- | ---------------------------------- |
| isDistributed          | boolean        | 是   | 是   | 是否为分布式通知。                  |
| supportDisplayDevices  | Array\<string> | 是   | 是   | 可以同步通知到的设备列表。         |
| supportOperateDevices  | Array\<string> | 是   | 是   | 可以打开通知的设备列表。              |
| remindType             | number         | 是   | 否   | 通知的提醒方式。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                    |
3772 3773 3774 3775 3776 3777 3778 3779


## NotificationSlot

描述通知槽

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
| 名称                 | 类型                  | 可读 | 可写 | 说明                                       |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| type                 | [SlotType](#slottype) | 是  | 是  | 通道类型。                                   |
| level                | number                | 是  | 是  | 通知级别,不设置则根据通知渠道类型有默认值。 |
| desc                 | string                | 是  | 是  | 通知渠道描述信息。                           |
| badgeFlag            | boolean               | 是  | 是  | 是否显示角标。                               |
| bypassDnd            | boolean               | 是  | 是  | 置是否在系统中绕过免打扰模式。               |
| lockscreenVisibility | number                | 是  | 是  | 在锁定屏幕上显示通知的模式。                 |
| vibrationEnabled     | boolean               | 是  | 是  | 是否可振动。                                 |
| sound                | string                | 是  | 是  | 通知提示音。                                 |
| lightEnabled         | boolean               | 是  | 是  | 是否闪灯。                                   |
| lightColor           | number                | 是  | 是  | 通知灯颜色。                                 |
| vibrationValues      | Array\<number\>       | 是  | 是  | 通知振动样式。                               |
| enabled<sup>9+</sup> | boolean               | 是  | 否  | 此通知插槽中的启停状态。                      |
3794 3795 3796 3797 3798 3799 3800 3801


## NotificationTemplate

通知模板。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3802
| 名称 | 类型                    | 可读 | 可写 | 说明       |
3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
| ---- | ---------------------- | ---- | ---- | ---------- |
| name | string                 | 是   | 是   | 模板名称。 |
| data | {[key:string]: Object} | 是   | 是   | 模板数据。 |


## NotificationUserInput

保存用户输入的通知消息。

**系统能力**:SystemCapability.Notification.Notification

F
fangJinliang1 已提交
3814 3815 3816
| 名称     | 类型   | 可读 | 可写 | 说明                          |
| -------- | ------ | --- | ---- | ----------------------------- |
| inputKey | string | 是  | 是  | 用户输入时用于标识此输入的key。 |
3817 3818 3819 3820 3821 3822 3823 3824


## DeviceRemindType

**系统能力**:SystemCapability.Notification.Notification

**系统API**: 此接口为系统接口,三方应用不支持调用。

F
fangJinliang1 已提交
3825
| 名称                 | 值  | 说明                               |
3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |


## SourceType

**系统能力**:SystemCapability.Notification.Notification

**系统API**: 此接口为系统接口,三方应用不支持调用。

F
fangJinliang1 已提交
3839
| 名称                 | 值  | 说明                  |
3840 3841 3842 3843
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
| TYPE_TIMER           | 2   | 计划通知。            |