js-apis-notificationManager.md 147.1 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
import Base from '@ohos.base';
14 15
```

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

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

发布通知(callback形式)。

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

**参数:**

F
fangJinliang1 已提交
26
| 参数名     | 类型                                        | 必填 | 说明                                        |
27
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
28
| request  | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
F
fangJinliang1 已提交
29
| callback | AsyncCallback\<void\>                       | 是   | 发布通知的回调方法。                        |
30 31 32

**错误码:**

F
fangJinliang1 已提交
33 34
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

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
| 1600012  | No memory space.                          |
44 45 46

**示例:**

47
```ts
48
//publish回调
49
function publishCallback(err: Base.BusinessError) {
50
    if (err) {
51
        console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
52 53 54 55 56
    } else {
        console.info("publish success");
    }
}
//通知Request对象
57
let notificationRequest: notificationManager.NotificationRequest = {
58 59
    id: 1,
    content: {
60
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
61 62 63 64 65 66
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
67
};
68
notificationManager.publish(notificationRequest, publishCallback);
69 70
```

71
## notificationManager.publish
72 73 74 75 76 77 78 79 80

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

发布通知(Promise形式)。

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

**参数:**

F
fangJinliang1 已提交
81
| 参数名     | 类型                                        | 必填 | 说明                                        |
82
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
83
| request  | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
84 85 86

**错误码:**

F
fangJinliang1 已提交
87 88
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

89 90 91 92 93 94 95 96
| 错误码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. |
97
| 1600012  | No memory space.                          |
98 99 100

**示例:**

101
```ts
F
fangJinliang1 已提交
102
// 通知Request对象
103
let notificationRequest: notificationManager.NotificationRequest = {
104
    id: 1,
105
    content: {
106
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
107 108 109 110 111 112
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
113
};
114
notificationManager.publish(notificationRequest).then(() => {
F
fangJinliang1 已提交
115
	console.info("publish success");
116 117 118 119
});

```

120
## notificationManager.publish
121 122 123

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

F
fangJinliang1 已提交
124
发布通知给指定的用户(callback形式)。
125 126 127 128 129 130 131 132 133

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

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

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

**参数:**

F
fangJinliang1 已提交
134
| 参数名     | 类型                                        | 必填 | 说明                                        |
135
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
136
| request  | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
F
fangJinliang1 已提交
137
| userId   | number                                      | 是   | 用户ID。                           |
138 139 140 141
| callback | AsyncCallback\<void\>                       | 是   | 被指定的回调方法。                           |

**错误码:**

F
fangJinliang1 已提交
142 143
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

144 145 146 147 148 149 150 151 152
| 错误码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. |
153
| 1600012  | No memory space.                          |
154 155 156

**示例:**

157
```ts
F
fangJinliang1 已提交
158
// publish回调
159
function publishCallback(err: Base.BusinessError) {
160
    if (err) {
161
        console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
162 163 164 165
    } else {
        console.info("publish success");
    }
}
F
fangJinliang1 已提交
166
// 用户ID
167
let userId: number = 1;
F
fangJinliang1 已提交
168
// 通知Request对象
169
let notificationRequest: notificationManager.NotificationRequest = {
170 171
    id: 1,
    content: {
172
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
173 174 175 176 177 178
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
179
};
180
notificationManager.publish(notificationRequest, userId, publishCallback);
181 182
```

183
## notificationManager.publish
184 185 186

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

F
fangJinliang1 已提交
187
发布通知给指定的用户(Promise形式)。
188 189 190 191 192 193 194 195 196

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

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

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

**参数:**

F
fangJinliang1 已提交
197
| 参数名     |  类型                                        | 必填 | 说明                                        |
198
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
199
| request  | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
F
fangJinliang1 已提交
200
| userId   | number                                      | 是   | 用户ID。                           |
201 202 203

**错误码:**

F
fangJinliang1 已提交
204 205
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

206 207 208 209 210 211 212 213 214
| 错误码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. |
215
| 1600012  | No memory space.                          |
216 217 218

**示例:**

219
```ts
220
let notificationRequest: notificationManager.NotificationRequest = {
221
    id: 1,
222
    content: {
223
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
224 225 226 227 228 229
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
230
};
231

232
let userId: number = 1;
233

234
notificationManager.publish(notificationRequest, userId).then(() => {
F
fangJinliang1 已提交
235
	console.info("publish success");
236 237 238 239
});
```


240
## notificationManager.cancel
241 242 243

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

F
fangJinliang1 已提交
244
通过通知ID和通知标签取消已发布的通知(callback形式)。
245 246 247 248 249

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

**参数:**

F
fangJinliang1 已提交
250
| 参数名     | 类型                  | 必填 | 说明                 |
251 252 253 254 255 256 257
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| label    | string                | 是   | 通知标签。             |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

F
fangJinliang1 已提交
258 259
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

260 261 262 263 264 265 266 267 268
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

269
```ts
F
fangJinliang1 已提交
270
// cancel回调
271
function cancelCallback(err: Base.BusinessError) {
272
    if (err) {
273
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
274 275 276 277
    } else {
        console.info("cancel success");
    }
}
278
notificationManager.cancel(0, "label", cancelCallback);
279 280
```

281
## notificationManager.cancel
282 283 284

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

F
fangJinliang1 已提交
285
取消与指定通知ID相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
286 287 288 289 290

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

**参数:**

F
fangJinliang1 已提交
291
| 参数名  | 类型   | 必填 | 说明     |
292 293 294 295 296 297
| ----- | ------ | ---- | -------- |
| id    | number | 是   | 通知ID。   |
| label | string | 否   | 通知标签。 |

**错误码:**

F
fangJinliang1 已提交
298 299
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

300 301 302 303 304 305 306 307 308
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

309 310
```ts
notificationManager.cancel(0).then(() => {
F
fangJinliang1 已提交
311
	console.info("cancel success");
312 313 314
});
```

315
## notificationManager.cancel
316 317 318

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

F
fangJinliang1 已提交
319
取消与指定通知ID相匹配的已发布通知(callback形式)。
320 321 322 323 324

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

**参数:**

F
fangJinliang1 已提交
325
| 参数名     | 类型                  | 必填 | 说明                 |
326 327 328 329 330 331
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

F
fangJinliang1 已提交
332 333
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

334 335 336 337 338 339 340 341 342
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

343
```ts
F
fangJinliang1 已提交
344
// cancel回调
345
function cancelCallback(err: Base.BusinessError) {
346
    if (err) {
347
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
348 349 350 351
    } else {
        console.info("cancel success");
    }
}
352
notificationManager.cancel(0, cancelCallback);
353 354
```

355
## notificationManager.cancelAll
356 357 358 359 360 361 362 363 364

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

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

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

**错误码:**

F
fangJinliang1 已提交
365 366
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

367 368 369 370 371 372 373 374
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**参数:**

F
fangJinliang1 已提交
375
| 参数名     | 类型                  | 必填 | 说明                 |
376 377 378 379 380
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**示例:**

381
```ts
F
fangJinliang1 已提交
382
// cancel回调
383
function cancelAllCallback(err: Base.BusinessError) {
384
    if (err) {
385
        console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
386 387 388 389
    } else {
        console.info("cancelAll success");
    }
}
390
notificationManager.cancelAll(cancelAllCallback);
391 392
```

393
## notificationManager.cancelAll
394 395 396 397 398 399 400 401 402

cancelAll(): Promise\<void\>

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

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

**错误码:**

F
fangJinliang1 已提交
403 404
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

405 406 407 408 409 410 411 412
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

413 414
```ts
notificationManager.cancelAll().then(() => {
F
fangJinliang1 已提交
415
	console.info("cancelAll success");
416 417 418
});
```

419
## notificationManager.addSlot
420 421 422 423 424 425 426 427 428 429 430 431 432

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
433
| 参数名     | 类型                  | 必填 | 说明                 |
434
| -------- | --------------------- | ---- | -------------------- |
435
| slot     | [NotificationSlot](js-apis-inner-notification-notificationSlot.md)       | 是   | 要创建的通知通道对象。 |
436 437 438 439
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

F
fangJinliang1 已提交
440 441
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

442 443 444 445 446
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
447
| 1600012  | No memory space.                          |
448 449 450

**示例:**

451
```ts
F
fangJinliang1 已提交
452
// addslot回调
453
function addSlotCallBack(err: Base.BusinessError) {
454
    if (err) {
455
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
456 457 458 459
    } else {
        console.info("addSlot success");
    }
}
F
fangJinliang1 已提交
460
// 通知slot对象
461
let notificationSlot: notificationManager.NotificationSlot = {
462
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
463
};
464
notificationManager.addSlot(notificationSlot, addSlotCallBack);
465 466
```

467
## notificationManager.addSlot
468 469 470 471 472 473 474 475 476 477 478 479 480

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
481
| 参数名 | 类型             | 必填 | 说明                 |
482
| ---- | ---------------- | ---- | -------------------- |
483
| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是   | 要创建的通知通道对象。 |
484 485 486

**错误码:**

F
fangJinliang1 已提交
487 488
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

489 490 491 492 493
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
494
| 1600012  | No memory space.                          |
495 496 497

**示例:**

498
```ts
F
fangJinliang1 已提交
499
// 通知slot对象
500
let notificationSlot: notificationManager.NotificationSlot = {
501
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
502
};
503
notificationManager.addSlot(notificationSlot).then(() => {
F
fangJinliang1 已提交
504
	console.info("addSlot success");
505 506 507
});
```

508
## notificationManager.addSlot
509 510 511

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

F
fangJinliang1 已提交
512
创建指定类型的通知通道(callback形式)。
513 514 515 516 517

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

**参数:**

F
fangJinliang1 已提交
518
| 参数名     | 类型                  | 必填 | 说明                   |
519 520 521 522 523 524
| -------- | --------------------- | ---- | ---------------------- |
| type     | [SlotType](#slottype)              | 是   | 要创建的通知通道的类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。   |

**错误码:**

F
fangJinliang1 已提交
525 526
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

527 528 529 530 531
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
532
| 1600012  | No memory space.                    |
533 534 535

**示例:**

536
```ts
F
fangJinliang1 已提交
537
// addslot回调
538
function addSlotCallBack(err: Base.BusinessError) {
539
    if (err) {
540
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
541 542 543 544
    } else {
        console.info("addSlot success");
    }
}
545
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);
546 547
```

548
## notificationManager.addSlot
549 550 551

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

F
fangJinliang1 已提交
552
创建指定类型的通知通道(Promise形式)。
553 554 555 556 557

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

**参数:**

F
fangJinliang1 已提交
558
| 参数名 | 类型     | 必填 | 说明                   |
559 560 561 562 563
| ---- | -------- | ---- | ---------------------- |
| type | [SlotType](#slottype) | 是   | 要创建的通知通道的类型。 |

**错误码:**

F
fangJinliang1 已提交
564 565
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

566 567 568 569 570
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
571
| 1600012  | No memory space.                    |
572 573 574

**示例:**

575 576
```ts
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
F
fangJinliang1 已提交
577
	console.info("addSlot success");
578 579 580
});
```

581
## notificationManager.addSlots
582 583 584 585 586 587 588 589 590 591 592 593 594

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
595
| 参数名     | 类型                      | 必填 | 说明                     |
596
| -------- | ------------------------- | ---- | ------------------------ |
597
| slots    | Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\> | 是   | 要创建的通知通道对象数组。 |
598 599 600 601
| callback | AsyncCallback\<void\>     | 是   | 表示被指定的回调方法。     |

**错误码:**

F
fangJinliang1 已提交
602 603
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

604 605 606 607 608
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
609
| 1600012  | No memory space.                          |
610 611 612

**示例:**

613
```ts
F
fangJinliang1 已提交
614
// addSlots回调
615
function addSlotsCallBack(err: Base.BusinessError) {
616
    if (err) {
617
        console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
618 619 620 621
    } else {
        console.info("addSlots success");
    }
}
F
fangJinliang1 已提交
622
// 通知slot对象
623
let notificationSlot: notificationManager.NotificationSlot = {
624
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
625
};
F
fangJinliang1 已提交
626
// 通知slot array 对象
627
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
628 629
notificationSlotArray[0] = notificationSlot;

630
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
631 632
```

633
## notificationManager.addSlots
634 635 636 637 638 639 640 641 642 643 644 645 646

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
647
| 参数名  | 类型                      | 必填 | 说明                     |
648
| ----- | ------------------------- | ---- | ------------------------ |
649
| slots | Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\> | 是   | 要创建的通知通道对象数组。 |
650 651 652

**错误码:**

F
fangJinliang1 已提交
653 654
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

655 656 657 658 659
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
660
| 1600012  | No memory space.                          |
661 662 663

**示例:**

664
```ts
F
fangJinliang1 已提交
665
// 通知slot对象
666
let notificationSlot: notificationManager.NotificationSlot = {
667
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
668
};
F
fangJinliang1 已提交
669
// 通知slot array 对象
670
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
671 672
notificationSlotArray[0] = notificationSlot;

673
notificationManager.addSlots(notificationSlotArray).then(() => {
F
fangJinliang1 已提交
674
	console.info("addSlots success");
675 676 677
});
```

678
## notificationManager.getSlot
679 680 681

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

F
fangJinliang1 已提交
682
获取一个指定类型的通知通道(callback形式)。
683 684 685 686 687

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

**参数:**

F
fangJinliang1 已提交
688
| 参数名     | 类型                              | 必填 | 说明                                                        |
689
| -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
F
fangJinliang1 已提交
690
| slotType | [SlotType](#slottype)                          | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
691
| callback | AsyncCallback\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\> | 是   | 表示被指定的回调方法。                                        |
692 693 694

**错误码:**

F
fangJinliang1 已提交
695 696
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

697 698 699 700 701 702 703 704
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

705
```ts
F
fangJinliang1 已提交
706
// getSlot回调
707
function getSlotCallback(err: Base.BusinessError, data: notificationManager.NotificationSlot) {
708
    if (err) {
709
        console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
710
    } else {
711
        console.info(`getSlot success, data is ${JSON.stringify(data)}`);
712 713
    }
}
714
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
715
notificationManager.getSlot(slotType, getSlotCallback);
716 717
```

718
## notificationManager.getSlot
719 720 721

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

F
fangJinliang1 已提交
722
获取一个指定类型的通知通道(Promise形式)。
723 724 725 726 727

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

**参数:**

F
fangJinliang1 已提交
728
| 参数名     | 类型     | 必填 | 说明                                                        |
729
| -------- | -------- | ---- | ----------------------------------------------------------- |
F
fangJinliang1 已提交
730
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
731 732 733 734 735 736 737 738 739

**返回值:**

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

**错误码:**

F
fangJinliang1 已提交
740 741
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

742 743 744 745 746 747 748 749
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

750
```ts
751 752 753 754
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;

notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
  console.info("getSlot success, data: " + JSON.stringify(data));
755 756 757
});
```

758
## notificationManager.getSlots
759

760
getSlots(callback: AsyncCallback\<Array\<NotificationSlot>>): void
761 762 763 764 765 766 767

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

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

**参数:**

F
fangJinliang1 已提交
768 769
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

F
fangJinliang1 已提交
770
| 参数名     | 类型                              | 必填 | 说明                 |
771
| -------- | --------------------------------- | ---- | -------------------- |
772
| callback | AsyncCallback\<Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\>\> | 是   | 以callback形式返回获取此应用程序的所有通知通道的结果。 |
773 774 775 776 777 778 779 780 781 782 783

**错误码:**

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

**示例:**

784
```ts
F
fangJinliang1 已提交
785
// getSlots回调
786 787 788 789 790 791
function getSlotsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
  if (err) {
    console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`getSlots success, data is ${JSON.stringify(data)}`);
  }
792
}
793
notificationManager.getSlots(getSlotsCallback);
794 795
```

796
## notificationManager.getSlots
797

798
getSlots(): Promise\<Array\<NotificationSlot>>
799 800 801 802 803 804 805 806 807

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

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

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
808
| Promise\<Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\>\> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 |
809 810 811

**错误码:**

F
fangJinliang1 已提交
812 813
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

814 815 816 817 818 819 820 821
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

822
```ts
823
notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
F
fangJinliang1 已提交
824
	console.info("getSlots success, data: " + JSON.stringify(data));
825 826 827
});
```

828
## notificationManager.removeSlot
829 830 831

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

F
fangJinliang1 已提交
832
删除指定类型的通知通道(callback形式)。
833 834 835 836 837

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

**参数:**

F
fangJinliang1 已提交
838
| 参数名     | 类型                  | 必填 | 说明                                                        |
839 840 841 842 843 844
| -------- | --------------------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype)              | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。                                        |

**错误码:**

F
fangJinliang1 已提交
845 846
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

847 848 849 850 851 852 853 854
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

855
```ts
F
fangJinliang1 已提交
856
// removeSlot回调
857 858 859 860 861 862
function removeSlotCallback(err: Base.BusinessError) {
  if (err) {
    console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("removeSlot success");
  }
863
}
864
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
865
notificationManager.removeSlot(slotType, removeSlotCallback);
866 867
```

868
## notificationManager.removeSlot
869 870 871

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

F
fangJinliang1 已提交
872
删除指定类型的通知通道(Promise形式)。
873 874 875 876 877

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

**参数:**

F
fangJinliang1 已提交
878
| 参数名     | 类型     | 必填 | 说明                                                        |
879 880 881 882 883
| -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |

**错误码:**

F
fangJinliang1 已提交
884 885
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

886 887 888 889 890 891 892 893
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

894
```ts
895
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
896
notificationManager.removeSlot(slotType).then(() => {
F
fangJinliang1 已提交
897
	console.info("removeSlot success");
898 899 900
});
```

901
## notificationManager.removeAllSlots
902 903 904 905 906 907 908 909 910

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

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

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

**参数:**

F
fangJinliang1 已提交
911
| 参数名     | 类型                  | 必填 | 说明                 |
912 913 914 915 916
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

F
fangJinliang1 已提交
917 918
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

919 920 921 922 923 924 925 926
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

927
```ts
928
function removeAllCallBack(err: Base.BusinessError) {
929
    if (err) {
930
        console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
931 932 933 934
    } else {
        console.info("removeAllSlots success");
    }
}
935
notificationManager.removeAllSlots(removeAllCallBack);
936 937
```

938
## notificationManager.removeAllSlots
939 940 941 942 943 944 945 946 947

removeAllSlots(): Promise\<void\>

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

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

**错误码:**

F
fangJinliang1 已提交
948 949
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

950 951 952 953 954 955 956 957
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

958 959
```ts
notificationManager.removeAllSlots().then(() => {
F
fangJinliang1 已提交
960
	console.info("removeAllSlots success");
961 962 963
});
```

964
## notificationManager.setNotificationEnable
965 966 967

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

F
fangJinliang1 已提交
968
设定指定应用的通知使能状态(Callback形式)。
969 970 971 972 973 974 975 976 977

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

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

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

**参数:**

F
fangJinliang1 已提交
978
| 参数名     | 类型                  | 必填 | 说明                 |
979
| -------- | --------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
980
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)   | 是   | 指定应用的包信息。        |
981 982 983 984 985
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知使能回调函数。 |

**错误码:**

F
fangJinliang1 已提交
986 987
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

988 989 990 991 992 993 994 995 996
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

997
```ts
998
function setNotificationEnableCallback(err: Base.BusinessError) {
999
    if (err) {
1000
        console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`);
1001
    } else {
1002
        console.info("setNotificationEnableCallback success");
1003 1004
    }
}
1005
let bundle: notificationManager.BundleOption = {
1006
    bundle: "bundleName1",
F
fangJinliang1 已提交
1007
};
1008
notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback);
1009 1010
```

1011
## notificationManager.setNotificationEnable
1012 1013 1014

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

F
fangJinliang1 已提交
1015
设定指定应用的通知使能状态(Promise形式)。
1016 1017 1018 1019 1020 1021 1022 1023 1024

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

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

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

**参数:**

F
fangJinliang1 已提交
1025
| 参数名   | 类型         | 必填 | 说明       |
1026
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1027
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1028 1029 1030 1031
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

F
fangJinliang1 已提交
1032 1033
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1034 1035 1036 1037 1038 1039 1040 1041 1042
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1043
```ts
1044
let bundle: notificationManager.BundleOption = {
1045
    bundle: "bundleName1",
F
fangJinliang1 已提交
1046
};
1047
notificationManager.setNotificationEnable(bundle, false).then(() => {
F
fangJinliang1 已提交
1048
	console.info("setNotificationEnable success");
1049 1050 1051
});
```

1052
## notificationManager.isNotificationEnabled
1053 1054 1055

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

F
fangJinliang1 已提交
1056
获取指定应用的通知使能状态(Callback形式)。
1057 1058 1059 1060 1061 1062 1063 1064 1065

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

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

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

**参数:**

F
fangJinliang1 已提交
1066
| 参数名     | 类型                  | 必填 | 说明                     |
1067
| -------- | --------------------- | ---- | ------------------------ |
Y
yuyaozhi 已提交
1068
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 指定应用的包信息。            |
1069
| callback | AsyncCallback\<boolean\> | 是   | 获取通知使能状态回调函数。 |
1070 1071 1072

**错误码:**

F
fangJinliang1 已提交
1073 1074
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1075 1076 1077 1078 1079 1080 1081 1082 1083
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1084
```ts
1085
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
1086
    if (err) {
1087
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
1088
    } else {
1089
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
1090 1091
    }
}
1092 1093

let bundle: notificationManager.BundleOption = {
1094
    bundle: "bundleName1",
F
fangJinliang1 已提交
1095
};
1096

1097
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
1098 1099
```

1100
## notificationManager.isNotificationEnabled
1101 1102 1103

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

F
fangJinliang1 已提交
1104
获取指定应用的通知使能状态(Promise形式)。
1105 1106 1107 1108 1109 1110 1111 1112 1113

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

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

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

**参数:**

F
fangJinliang1 已提交
1114
| 参数名   | 类型         | 必填 | 说明       |
1115
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1116
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1117 1118 1119

**返回值:**

F
fangJinliang1 已提交
1120 1121 1122
| 类型               | 说明                                                |
| ------------------ | --------------------------------------------------- |
| Promise\<boolean\> | 以Promise形式返回获取指定应用的通知使能状态的结果。 |
1123 1124 1125

**错误码:**

F
fangJinliang1 已提交
1126 1127
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1128 1129 1130 1131 1132 1133 1134 1135 1136
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1137
```ts
1138
let bundle: notificationManager.BundleOption = {
1139
    bundle: "bundleName1",
F
fangJinliang1 已提交
1140
};
1141
notificationManager.isNotificationEnabled(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
1142
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1143 1144 1145
});
```

1146
## notificationManager.isNotificationEnabled
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
1160
| 参数名     | 类型                  | 必填 | 说明                     |
1161
| -------- | --------------------- | ---- | ------------------------ |
1162
| callback | AsyncCallback\<boolean\> | 是   | 获取通知使能状态回调函数。 |
1163 1164 1165

**错误码:**

F
fangJinliang1 已提交
1166 1167
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1168 1169 1170 1171 1172 1173 1174 1175
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1176
```ts
1177
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
1178
    if (err) {
1179
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
1180
    } else {
1181
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
1182 1183 1184
    }
}

1185
notificationManager.isNotificationEnabled(isNotificationEnabledCallback);
1186 1187
```

1188
## notificationManager.isNotificationEnabled
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199

isNotificationEnabled(): Promise\<boolean\>

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

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

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

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

1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
**返回值:**

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

**错误码:**

错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

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

**示例:**

```ts
1219
notificationManager.isNotificationEnabled().then((data: boolean) => {
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
```

## notificationManager.isNotificationEnabled

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

获取制定用户ID下的通知使能状态(Callback形式)。

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

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

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

**参数:**

| 参数名     | 类型                  | 必填 | 说明                     |
| -------- | --------------------- | ---- | ------------------------ |
| userId   | number                | 是   | 指定的用户ID。 |
| callback | AsyncCallback\<boolean\> | 是   | 获取通知使能状态回调函数。 |

**错误码:**

错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

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

**示例:**

```ts
1257
function isNotificationEnabledCallback(err: Base.BusinessError, data: boolean) {
1258 1259 1260
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
1261
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
1262 1263 1264
    }
}

1265
let userId: number = 1;
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281

notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback);
```

## notificationManager.isNotificationEnabled

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

获取制定用户下的通知使能状态(Promise形式)。

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

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

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

1282 1283
**参数:**

F
fangJinliang1 已提交
1284
| 参数名   | 类型         | 必填 | 说明       |
1285
| ------ | ------------ | ---- | ---------- |
1286
| userId | number       | 是   | 指定的用户ID。 |
1287 1288 1289 1290 1291 1292 1293 1294 1295

**返回值:**

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

**错误码:**

F
fangJinliang1 已提交
1296 1297
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1298 1299 1300 1301 1302
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
1303
| 1600008  | The user is not exist..                  |
1304 1305 1306

**示例:**

1307
```ts
1308
let userId: number = 1;
1309

1310
notificationManager.isNotificationEnabled(userId).then((data: boolean) => {
F
fangJinliang1 已提交
1311
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1312 1313 1314
});
```

1315
## notificationManager.displayBadge
1316 1317 1318

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

F
fangJinliang1 已提交
1319
设定指定应用的角标使能状态(Callback形式)。
1320 1321 1322 1323 1324 1325 1326 1327 1328

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

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

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

**参数:**

F
fangJinliang1 已提交
1329
| 参数名     | 类型                  | 必填 | 说明                 |
1330
| -------- | --------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
1331
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 指定应用的包信息。           |
1332 1333 1334 1335 1336
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定角标使能回调函数。 |

**错误码:**

F
fangJinliang1 已提交
1337 1338
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1339 1340 1341 1342 1343 1344 1345 1346 1347
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1348
```ts
1349
function displayBadgeCallback(err: Base.BusinessError) {
1350
    if (err) {
1351
        console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
1352 1353 1354 1355
    } else {
        console.info("displayBadge success");
    }
}
1356
let bundle: notificationManager.BundleOption = {
1357
    bundle: "bundleName1",
F
fangJinliang1 已提交
1358
};
1359
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
1360 1361
```

1362
## notificationManager.displayBadge
1363 1364 1365

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

F
fangJinliang1 已提交
1366
设定指定应用的角标使能状态(Promise形式)。
1367 1368 1369 1370 1371 1372 1373 1374 1375

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

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

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

**参数:**

F
fangJinliang1 已提交
1376
| 参数名   | 类型         | 必填 | 说明       |
1377
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1378
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1379 1380 1381 1382
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

F
fangJinliang1 已提交
1383 1384
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1385 1386 1387 1388 1389 1390 1391 1392 1393
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1394
```ts
1395
let bundle: notificationManager.BundleOption = {
1396
    bundle: "bundleName1",
F
fangJinliang1 已提交
1397
};
1398
notificationManager.displayBadge(bundle, false).then(() => {
F
fangJinliang1 已提交
1399
	console.info("displayBadge success");
1400 1401 1402
});
```

1403
## notificationManager.isBadgeDisplayed
1404 1405 1406

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

F
fangJinliang1 已提交
1407
获取指定应用的角标使能状态(Callback形式)。
1408 1409 1410 1411 1412 1413 1414 1415 1416

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

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

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

**参数:**

F
fangJinliang1 已提交
1417
| 参数名     | 类型                  | 必填 | 说明                     |
1418
| -------- | --------------------- | ---- | ------------------------ |
Y
yuyaozhi 已提交
1419
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 指定应用的包信息。               |
1420
| callback | AsyncCallback\<boolean\> | 是   | 获取角标使能状态回调函数。 |
1421 1422 1423

**错误码:**

F
fangJinliang1 已提交
1424 1425
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1426 1427 1428 1429 1430 1431 1432 1433 1434
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1435
```ts
1436
function isBadgeDisplayedCallback(err: Base.BusinessError, data: boolean) {
1437
    if (err) {
1438
        console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
1439
    } else {
1440
        console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`);
1441 1442
    }
}
1443
let bundle: notificationManager.BundleOption = {
1444
    bundle: "bundleName1",
F
fangJinliang1 已提交
1445
};
1446
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
1447 1448
```

1449
## notificationManager.isBadgeDisplayed
1450 1451 1452

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

F
fangJinliang1 已提交
1453
获取指定应用的角标使能状态(Promise形式)。
1454 1455 1456 1457 1458 1459 1460 1461 1462

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

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

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

**参数:**

F
fangJinliang1 已提交
1463
| 参数名   | 类型         | 必填 | 说明       |
1464
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1465
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1466 1467 1468 1469 1470

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
1471
| Promise\<boolean\> | 以Promise形式返回获取指定应用的角标使能状态。 |
1472 1473 1474

**错误码:**

F
fangJinliang1 已提交
1475 1476
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1477 1478 1479 1480 1481 1482 1483 1484 1485
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1486
```ts
1487 1488
let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
F
fangJinliang1 已提交
1489
};
1490 1491

notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
1492
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
1493 1494 1495
});
```

F
fangJinliang1 已提交
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
## notificationManager.setBadgeNumber<sup>10+</sup>

setBadgeNumber(badgeNumber: number): Promise\<void\>

设定角标个数,在应用的桌面图标上呈现(Promise形式)。

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

**参数:**

| 参数名      | 类型   | 必填 | 说明       |
| ----------- | ------ | ---- | ---------- |
| badgeNumber | number | 是   | 角标个数。 |

**错误码:**

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
1517
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1518 1519 1520 1521

**示例:**

```ts
1522 1523
let badgeNumber: number = 10;

F
fangJinliang1 已提交
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
notificationManager.setBadgeNumber(badgeNumber).then(() => {
	console.info("displayBadge success");
});
```

## notificationManager.setBadgeNumber<sup>10+</sup>

setBadgeNumber(badgeNumber: number, callback: AsyncCallback\<void\>): void

设定角标个数,在应用的桌面图标上呈现(Callback形式)。

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

**参数:**

| 参数名      | 类型                  | 必填 | 说明               |
| ----------- | --------------------- | ---- | ------------------ |
| badgeNumber | number                | 是   | 角标个数。         |
| callback    | AsyncCallback\<void\> | 是   | 设定角标回调函数。 |

**错误码:**

错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
1553
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1554 1555 1556 1557

**示例:**

```ts
1558
function setBadgeNumberCallback(err: Base.BusinessError) {
F
fangJinliang1 已提交
1559 1560 1561 1562 1563 1564 1565
    if (err) {
        console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("displayBadge success");
    }
}

1566
let badgeNumber: number = 10;
F
fangJinliang1 已提交
1567 1568 1569
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
```

1570
## notificationManager.setSlotByBundle
1571 1572 1573

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

F
fangJinliang1 已提交
1574
设定指定应用的通知通道(Callback形式)。
1575 1576 1577 1578 1579 1580 1581 1582 1583

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

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

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

**参数:**

F
fangJinliang1 已提交
1584
| 参数名     | 类型                  | 必填 | 说明                 |
1585
| -------- | --------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
1586
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 指定应用的包信息。           |
1587
| slot     | [NotificationSlot](js-apis-inner-notification-notificationSlot.md)      | 是   | 通知通道。             |
1588 1589 1590 1591
| callback | AsyncCallback\<void\> | 是   | 设定通知通道回调函数。 |

**错误码:**

F
fangJinliang1 已提交
1592 1593
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1594 1595 1596 1597 1598 1599 1600 1601 1602
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1603
```ts
1604
function setSlotByBundleCallback(err: Base.BusinessError) {
1605
    if (err) {
1606
        console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1607 1608 1609 1610
    } else {
        console.info("setSlotByBundle success");
    }
}
1611
let bundle: notificationManager.BundleOption = {
1612
    bundle: "bundleName1",
F
fangJinliang1 已提交
1613
};
1614
let notificationSlot: notificationManager.NotificationSlot = {
1615
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1616
};
1617
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
1618 1619
```

1620
## notificationManager.setSlotByBundle
1621 1622 1623

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

F
fangJinliang1 已提交
1624
设定指定应用的通知通道(Promise形式)。
1625 1626 1627 1628 1629 1630 1631 1632 1633

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

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

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

**参数:**

F
fangJinliang1 已提交
1634
| 参数名   | 类型         | 必填 | 说明       |
1635
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1636
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1637
| slot   | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是   | 通知通道。 |
1638 1639 1640

**错误码:**

F
fangJinliang1 已提交
1641 1642
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1643 1644 1645 1646 1647 1648 1649 1650 1651
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1652
```ts
1653
let bundle: notificationManager.BundleOption = {
1654
    bundle: "bundleName1",
F
fangJinliang1 已提交
1655
};
1656 1657

let notificationSlot: notificationManager.NotificationSlot = {
1658
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1659
};
1660

1661
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
F
fangJinliang1 已提交
1662
	console.info("setSlotByBundle success");
1663 1664 1665
});
```

1666
## notificationManager.getSlotsByBundle
1667

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

F
fangJinliang1 已提交
1670
获取指定应用的所有通知通道(Callback形式)。
1671 1672 1673 1674 1675 1676 1677 1678 1679

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

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

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

**参数:**

F
fangJinliang1 已提交
1680
| 参数名     | 类型                                     | 必填 | 说明                 |
1681
| -------- | ---------------------------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
1682
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)                             | 是   | 指定应用的包信息。           |
1683
| callback | AsyncCallback\<Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)>> | 是   | 获取通知通道回调函数。 |
1684 1685 1686

**错误码:**

F
fangJinliang1 已提交
1687 1688
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1689 1690 1691 1692 1693 1694 1695 1696 1697
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1698
```ts
1699
function getSlotsByBundleCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) {
1700
    if (err) {
1701
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1702
    } else {
1703
        console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`);
1704 1705
    }
}
1706
let bundle: notificationManager.BundleOption = {
1707
    bundle: "bundleName1",
F
fangJinliang1 已提交
1708
};
1709
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
1710 1711
```

1712
## notificationManager.getSlotsByBundle
1713

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

F
fangJinliang1 已提交
1716
获取指定应用的所有通知通道(Promise形式)。
1717 1718 1719 1720 1721 1722 1723 1724 1725

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

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

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

**参数:**

F
fangJinliang1 已提交
1726
| 参数名   | 类型         | 必填 | 说明       |
1727
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1728
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1729 1730 1731 1732 1733

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
1734
| Promise\<Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)>> | 以Promise形式返回获取指定应用的通知通道。 |
1735 1736 1737

**错误码:**

F
fangJinliang1 已提交
1738 1739
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1740 1741 1742 1743 1744 1745 1746 1747 1748
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1749
```ts
1750
let bundle: notificationManager.BundleOption = {
1751
    bundle: "bundleName1",
F
fangJinliang1 已提交
1752
};
1753 1754

notificationManager.getSlotsByBundle(bundle).then((data: Array<notificationManager.NotificationSlot>) => {
F
fangJinliang1 已提交
1755
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
1756 1757 1758
});
```

1759
## notificationManager.getSlotNumByBundle
1760 1761 1762

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

F
fangJinliang1 已提交
1763
获取指定应用的通知通道数量(Callback形式)。
1764 1765 1766 1767 1768 1769 1770 1771 1772

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

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

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

**参数:**

F
fangJinliang1 已提交
1773
| 参数名     | 类型                      | 必填 | 说明                   |
1774
| -------- | ------------------------- | ---- | ---------------------- |
Y
yuyaozhi 已提交
1775
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)              | 是   | 指定应用的包信息。             |
F
fangJinliang1 已提交
1776
| callback | AsyncCallback\<number\> | 是   | 获取通知通道数量回调函数。 |
1777 1778 1779

**错误码:**

F
fangJinliang1 已提交
1780 1781
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1782 1783 1784 1785 1786 1787 1788 1789 1790
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1791
```ts
1792
function getSlotNumByBundleCallback(err: Base.BusinessError, data: number) {
1793
    if (err) {
1794
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1795
    } else {
1796
        console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`);
1797 1798
    }
}
1799 1800 1801

let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
F
fangJinliang1 已提交
1802
};
1803

1804
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
1805 1806
```

1807
## notificationManager.getSlotNumByBundle
1808 1809 1810

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

F
fangJinliang1 已提交
1811
获取指定应用的通知通道数量(Promise形式)。
1812 1813 1814 1815 1816 1817 1818 1819 1820

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

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

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

**参数:**

F
fangJinliang1 已提交
1821
| 参数名   | 类型         | 必填 | 说明       |
1822
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1823
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1824 1825 1826 1827 1828

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
1829
| Promise\<number\> | 以Promise形式返回获取指定应用的通知通道数量。 |
1830 1831 1832

**错误码:**

F
fangJinliang1 已提交
1833 1834
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1835 1836 1837 1838 1839 1840 1841 1842 1843
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1844
```ts
1845 1846
let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
F
fangJinliang1 已提交
1847
};
1848 1849

notificationManager.getSlotNumByBundle(bundle).then((data: number) => {
F
fangJinliang1 已提交
1850
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
1851 1852 1853 1854
});
```


1855
## notificationManager.getAllActiveNotifications
1856

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

F
fangJinliang1 已提交
1859
获取当前未删除的所有通知(Callback形式)。
1860 1861 1862 1863 1864 1865 1866 1867 1868

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

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

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

**参数:**

F
fangJinliang1 已提交
1869
| 参数名     | 类型                                                         | 必填 | 说明                 |
1870
| -------- | ------------------------------------------------------------ | ---- | -------------------- |
1871
| callback | AsyncCallback\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)>> | 是   | 获取活动通知回调函数。 |
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882

**错误码:**

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

**示例:**

1883
```ts
1884
function getAllActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
1885
    if (err) {
1886
        console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
1887
    } else {
1888
        console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`);
1889 1890 1891
    }
}

1892
notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);
1893 1894
```

1895
## notificationManager.getAllActiveNotifications
1896

1897
getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\>
1898

F
fangJinliang1 已提交
1899
获取当前未删除的所有通知(Promise形式)。
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910

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

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

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

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
1911
| Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\> | 以Promise形式返回获取活动通知。 |
1912 1913 1914

**错误码:**

F
fangJinliang1 已提交
1915 1916
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1917 1918 1919 1920 1921 1922 1923 1924
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1925
```ts
1926
notificationManager.getAllActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
F
fangJinliang1 已提交
1927
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
1928 1929 1930
});
```

1931
## notificationManager.getActiveNotificationCount
1932 1933 1934

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

F
fangJinliang1 已提交
1935
获取当前应用未删除的通知数(Callback形式)。
1936 1937 1938 1939 1940

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

**参数:**

F
fangJinliang1 已提交
1941
| 参数名     | 类型                   | 必填 | 说明                   |
1942
| -------- | ---------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
1943
| callback | AsyncCallback\<number\> | 是   | 获取未删除通知数回调函数。 |
1944 1945 1946

**错误码:**

F
fangJinliang1 已提交
1947 1948
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1949 1950 1951 1952 1953 1954 1955 1956
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1957
```ts
1958
function getActiveNotificationCountCallback(err: Base.BusinessError, data: number) {
1959
    if (err) {
1960
        console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
1961
    } else {
1962
        console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`);
1963 1964 1965
    }
}

1966
notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);
1967 1968
```

1969
## notificationManager.getActiveNotificationCount
1970 1971 1972

getActiveNotificationCount(): Promise\<number\>

F
fangJinliang1 已提交
1973
获取当前应用未删除的通知数(Promise形式)。
1974 1975 1976 1977 1978

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

**返回值:**

F
fangJinliang1 已提交
1979 1980 1981
| 类型              | 说明                                        |
| ----------------- | ------------------------------------------- |
| Promise\<number\> | 以Promise形式返回获取当前应用未删除通知数。 |
1982 1983 1984

**错误码:**

F
fangJinliang1 已提交
1985 1986
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

1987 1988 1989 1990 1991 1992 1993 1994
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1995
```ts
1996
notificationManager.getActiveNotificationCount().then((data: number) => {
F
fangJinliang1 已提交
1997
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
1998 1999 2000
});
```

2001
## notificationManager.getActiveNotifications
2002

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

F
fangJinliang1 已提交
2005
获取当前应用未删除的通知列表(Callback形式)。
2006 2007 2008 2009 2010

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

**参数:**

F
fangJinliang1 已提交
2011
| 参数名     | 类型                                                         | 必填 | 说明                           |
2012
| -------- | ------------------------------------------------------------ | ---- | ------------------------------ |
2013
| callback | AsyncCallback\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)>> | 是   | 获取当前应用通知列表回调函数。 |
2014 2015 2016

**错误码:**

F
fangJinliang1 已提交
2017 2018
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2019 2020 2021 2022 2023 2024 2025 2026
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2027
```ts
2028
function getActiveNotificationsCallback(err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) {
2029
    if (err) {
2030
        console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
2031 2032 2033 2034 2035
    } else {
        console.info("getActiveNotifications success");
    }
}

2036
notificationManager.getActiveNotifications(getActiveNotificationsCallback);
2037 2038
```

2039
## notificationManager.getActiveNotifications
2040

2041
getActiveNotifications(): Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\>
2042

F
fangJinliang1 已提交
2043
获取当前应用未删除的通知列表(Promise形式)。
2044 2045 2046 2047 2048

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

**返回值:**

F
fangJinliang1 已提交
2049 2050
| 类型                                                         | 说明                                    |
| ------------------------------------------------------------ | --------------------------------------- |
2051
| Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\> | 以Promise形式返回获取当前应用通知列表。 |
2052 2053 2054

**错误码:**

F
fangJinliang1 已提交
2055 2056
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2057 2058 2059 2060 2061 2062 2063 2064
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2065
```ts
2066
notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
F
fangJinliang1 已提交
2067
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
2068 2069 2070
});
```

2071
## notificationManager.cancelGroup
2072 2073 2074

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

F
fangJinliang1 已提交
2075
取消本应用指定组下的通知(Callback形式)。
2076 2077 2078 2079 2080

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

**参数:**

F
fangJinliang1 已提交
2081
| 参数名      | 类型                  | 必填 | 说明                         |
2082
| --------- | --------------------- | ---- | ---------------------------- |
2083
| groupName | string                | 是   | 通知组名称,此名称需要在发布通知时通过[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)对象指定。 |
F
fangJinliang1 已提交
2084
| callback  | AsyncCallback\<void\> | 是   | 取消本应用指定组下通知的回调函数。 |
2085 2086 2087

**错误码:**

F
fangJinliang1 已提交
2088 2089
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2090 2091 2092 2093 2094 2095 2096 2097
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2098
```ts
2099
function cancelGroupCallback(err: Base.BusinessError) {
2100
    if (err) {
2101
        console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
2102 2103 2104 2105 2106
    } else {
        console.info("cancelGroup success");
    }
}

2107
let groupName: string = "GroupName";
2108

2109
notificationManager.cancelGroup(groupName, cancelGroupCallback);
2110 2111
```

2112
## notificationManager.cancelGroup
2113 2114 2115

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

F
fangJinliang1 已提交
2116
取消本应用指定组下的通知(Promise形式)。
2117 2118 2119 2120 2121

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

**参数:**

F
fangJinliang1 已提交
2122
| 参数名      | 类型   | 必填 | 说明           |
2123
| --------- | ------ | ---- | -------------- |
F
fangJinliang1 已提交
2124
| groupName | string | 是   | 通知组名称。 |
2125 2126 2127

**错误码:**

F
fangJinliang1 已提交
2128 2129
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2130 2131 2132 2133 2134 2135 2136 2137
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2138
```ts
2139
let groupName: string = "GroupName";
2140
notificationManager.cancelGroup(groupName).then(() => {
F
fangJinliang1 已提交
2141
	console.info("cancelGroup success");
2142 2143 2144
});
```

2145
## notificationManager.removeGroupByBundle
2146 2147 2148

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

F
fangJinliang1 已提交
2149
删除指定应用的指定组下的通知(Callback形式)。
2150 2151 2152 2153 2154 2155 2156 2157 2158

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

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

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

**参数:**

F
fangJinliang1 已提交
2159
| 参数名      | 类型                  | 必填 | 说明                         |
2160
| --------- | --------------------- | ---- | ---------------------------- |
Y
yuyaozhi 已提交
2161
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 应用的包信息。                   |
F
fangJinliang1 已提交
2162 2163
| groupName | string                | 是   | 通知组名称。               |
| callback  | AsyncCallback\<void\> | 是   | 删除指定应用指定组下通知的回调函数。 |
2164 2165 2166

**错误码:**

F
fangJinliang1 已提交
2167 2168
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2169 2170 2171 2172 2173 2174 2175 2176 2177
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2178
```ts
2179
function removeGroupByBundleCallback(err: Base.BusinessError) {
2180
    if (err) {
2181
        console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
2182 2183 2184 2185 2186
    } else {
        console.info("removeGroupByBundle success");
    }
}

2187 2188
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
2189

2190
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
2191 2192
```

2193
## notificationManager.removeGroupByBundle
2194 2195 2196

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

F
fangJinliang1 已提交
2197
删除指定应用的指定组下的通知(Promise形式)。
2198 2199 2200 2201 2202 2203 2204 2205 2206

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

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

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

**参数:**

F
fangJinliang1 已提交
2207
| 参数名      | 类型         | 必填 | 说明           |
2208
| --------- | ------------ | ---- | -------------- |
Y
yuyaozhi 已提交
2209
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。     |
F
fangJinliang1 已提交
2210
| groupName | string       | 是   | 通知组名称。 |
2211 2212 2213

**错误码:**

F
fangJinliang1 已提交
2214 2215
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2216 2217 2218 2219 2220 2221 2222 2223 2224
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2225
```ts
2226 2227 2228
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";

2229
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
F
fangJinliang1 已提交
2230
	console.info("removeGroupByBundle success");
2231 2232 2233
});
```

2234
## notificationManager.setDoNotDisturbDate
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2248
| 参数名     | 类型                  | 必填 | 说明                   |
2249 2250 2251 2252 2253 2254
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

F
fangJinliang1 已提交
2255 2256
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2257 2258 2259 2260 2261
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2262
| 1600012  | No memory space.                          |
2263 2264 2265

**示例:**

2266
```ts
2267
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
2268
    if (err) {
2269
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2270 2271 2272 2273 2274
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

2275
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2276
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2277 2278
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2279
};
2280

2281
notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
2282 2283
```

2284
## notificationManager.setDoNotDisturbDate
2285 2286 2287

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

F
fangJinliang1 已提交
2288
设置免打扰时间(Promise形式)。
2289 2290 2291 2292 2293 2294 2295 2296 2297

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

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

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

**参数:**

F
fangJinliang1 已提交
2298
| 参数名 | 类型             | 必填 | 说明           |
2299 2300 2301 2302 2303
| ---- | ---------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |

**错误码:**

F
fangJinliang1 已提交
2304 2305
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2306 2307 2308 2309 2310
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2311
| 1600012  | No memory space.                          |
2312 2313 2314

**示例:**

2315
```ts
2316
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2317
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2318 2319
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2320
};
2321
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
F
fangJinliang1 已提交
2322
	console.info("setDoNotDisturbDate success");
2323 2324 2325 2326
});
```


2327
## notificationManager.setDoNotDisturbDate
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2341
| 参数名     | 类型                  | 必填 | 说明                   |
2342 2343
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
F
fangJinliang1 已提交
2344
| userId   | number                | 是   | 设置免打扰时间的用户ID。 |
2345 2346 2347 2348
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

F
fangJinliang1 已提交
2349 2350
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2351 2352 2353 2354 2355 2356
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2357
| 1600012  | No memory space.                          |
2358 2359 2360

**示例:**

2361
```ts
2362
function setDoNotDisturbDateCallback(err: Base.BusinessError) {
2363
    if (err) {
2364
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2365 2366 2367 2368 2369
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

2370
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2371
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2372 2373
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2374
};
2375

2376
let userId: number = 1;
2377

2378
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
2379 2380
```

2381
## notificationManager.setDoNotDisturbDate
2382 2383 2384

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

F
fangJinliang1 已提交
2385
指定用户设置免打扰时间(Promise形式)。
2386 2387 2388 2389 2390 2391 2392 2393 2394

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

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

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

**参数:**

F
fangJinliang1 已提交
2395
| 参数名   | 类型             | 必填 | 说明           |
2396 2397
| ------ | ---------------- | ---- | -------------- |
| date   | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |
F
fangJinliang1 已提交
2398
| userId | number           | 是   | 设置免打扰时间的用户ID。 |
2399 2400 2401

**错误码:**

F
fangJinliang1 已提交
2402 2403
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2404 2405 2406 2407 2408 2409
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2410
| 1600012  | No memory space.                          |
2411 2412 2413

**示例:**

2414
```ts
2415
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2416
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2417 2418
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2419
};
2420

2421
let userId: number = 1;
2422

2423
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
F
fangJinliang1 已提交
2424
	console.info("setDoNotDisturbDate success");
2425 2426 2427 2428
});
```


2429
## notificationManager.getDoNotDisturbDate
2430 2431 2432

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

F
fangJinliang1 已提交
2433
查询免打扰时间(Callback形式)。
2434 2435 2436 2437 2438 2439 2440 2441 2442

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

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

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

**参数:**

F
fangJinliang1 已提交
2443
| 参数名     | 类型                              | 必填 | 说明                   |
2444 2445 2446 2447 2448
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |

**错误码:**

F
fangJinliang1 已提交
2449 2450
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2451 2452 2453 2454 2455
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2456
| 1600012  | No memory space.                          |
2457 2458 2459

**示例:**

2460
```ts
2461
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
2462
    if (err) {
2463
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2464
    } else {
2465
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
2466 2467 2468
    }
}

2469
notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);
2470 2471
```

2472
## notificationManager.getDoNotDisturbDate
2473 2474 2475

getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>

F
fangJinliang1 已提交
2476
查询免打扰时间(Promise形式)。
2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487

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

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

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

**返回值:**

| 类型                                             | 说明                                      |
| ------------------------------------------------ | ----------------------------------------- |
F
fangJinliang1 已提交
2488
| Promise\<[DoNotDisturbDate](#donotdisturbdate)\> | 以Promise形式返回获取查询到的免打扰时间。 |
2489 2490 2491

**错误码:**

F
fangJinliang1 已提交
2492 2493
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2494 2495 2496 2497 2498
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2499
| 1600012  | No memory space.                          |
2500 2501 2502

**示例:**

2503
```ts
2504 2505
notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => {
  console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2506 2507 2508 2509
});
```


2510
## notificationManager.getDoNotDisturbDate
2511 2512 2513

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

F
fangJinliang1 已提交
2514
查询指定用户的免打扰时间(Callback形式)。
2515 2516 2517 2518 2519 2520 2521 2522 2523

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

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

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

**参数:**

F
fangJinliang1 已提交
2524
| 参数名     | 类型                              | 必填 | 说明                   |
2525 2526
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |
F
fangJinliang1 已提交
2527
| userId   | number                            | 是   | 用户ID。 |
2528 2529 2530

**错误码:**

F
fangJinliang1 已提交
2531 2532
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2533 2534 2535 2536 2537 2538
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2539
| 1600012  | No memory space.                          |
2540 2541 2542

**示例:**

2543
```ts
2544
function getDoNotDisturbDateCallback(err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) {
2545
    if (err) {
2546
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2547
    } else {
2548
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
2549 2550 2551
    }
}

2552
let userId: number = 1;
2553

2554
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
2555 2556
```

2557
## notificationManager.getDoNotDisturbDate
2558 2559 2560

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

F
fangJinliang1 已提交
2561
查询指定用户的免打扰时间(Promise形式)。
2562 2563 2564 2565 2566 2567 2568 2569 2570

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

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

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

**参数:**

F
fangJinliang1 已提交
2571
| 参数名     | 类型                              | 必填 | 说明                   |
2572
| -------- | --------------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
2573
| userId   | number                            | 是   | 用户ID。 |
2574 2575 2576 2577 2578

**返回值:**

| 类型                                             | 说明                                      |
| ------------------------------------------------ | ----------------------------------------- |
F
fangJinliang1 已提交
2579
| Promise\<[DoNotDisturbDate](#donotdisturbdate)\> | 以Promise形式返回获取查询到的免打扰时间。 |
2580 2581 2582

**错误码:**

F
fangJinliang1 已提交
2583 2584
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2585 2586 2587 2588 2589 2590
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2591
| 1600012  | No memory space.                          |
2592 2593 2594

**示例:**

2595
```ts
2596
let userId: number = 1;
2597

2598
notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => {
F
fangJinliang1 已提交
2599
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2600 2601 2602 2603
});
```


F
fangJinliang1 已提交
2604
## notificationManager.isSupportDoNotDisturbMode
2605

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

F
fangJinliang1 已提交
2608
查询是否支持免打扰功能(Callback形式)。
2609 2610 2611 2612 2613 2614 2615 2616 2617

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

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

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

**参数:**

F
fangJinliang1 已提交
2618
| 参数名     | 类型                     | 必填 | 说明                             |
2619
| -------- | ------------------------ | ---- | -------------------------------- |
F
fangJinliang1 已提交
2620
| callback | AsyncCallback\<boolean\> | 是   | 查询是否支持免打扰功能回调函数。 |
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631

**错误码:**

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

**示例:**

2632
```ts
2633
function isSupportDoNotDisturbModeCallback(err: Base.BusinessError, data: boolean) {
2634
    if (err) {
2635
        console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
2636
    } else {
F
fangJinliang1 已提交
2637
        console.info("isSupportDoNotDisturbMode success");
2638 2639 2640
    }
}

F
fangJinliang1 已提交
2641
notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);
2642 2643
```

F
fangJinliang1 已提交
2644
## notificationManager.isSupportDoNotDisturbMode
2645

F
fangJinliang1 已提交
2646
isSupportDoNotDisturbMode(): Promise\<boolean\>
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659

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

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

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

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

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
F
fangJinliang1 已提交
2660
| Promise\<boolean\> | 以Promise形式返回获取是否支持免打扰功能的结果。 |
2661 2662 2663

**错误码:**

F
fangJinliang1 已提交
2664 2665
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2666 2667 2668 2669 2670 2671 2672 2673
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2674
```ts
2675
notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => {
F
fangJinliang1 已提交
2676
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
2677 2678 2679
});
```

2680
## notificationManager.isSupportTemplate
2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696

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

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

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

**参数:**

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

**错误码:**

F
fangJinliang1 已提交
2697 2698
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2699 2700 2701 2702 2703 2704 2705 2706 2707
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2708 2709
let templateName: string = 'process';
function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) {
2710
    if (err) {
2711
        console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
2712 2713 2714 2715 2716
    } else {
        console.info("isSupportTemplate success");
    }
}

2717
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);
2718 2719
```

2720
## notificationManager.isSupportTemplate
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

F
fangJinliang1 已提交
2742 2743
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2744 2745 2746 2747 2748 2749 2750 2751 2752
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2753
let templateName: string = 'process';
2754

2755
notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
2756 2757 2758 2759
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
```

2760
## notificationManager.requestEnableNotification
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775

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

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

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

**参数:**

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

**错误码:**

F
fangJinliang1 已提交
2776 2777
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2778 2779 2780 2781 2782 2783 2784 2785 2786
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2787
function requestEnableNotificationCallback(err: Base.BusinessError) {
2788
    if (err) {
2789
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
2790 2791 2792 2793 2794
    } else {
        console.info("requestEnableNotification success");
    }
};

2795
notificationManager.requestEnableNotification(requestEnableNotificationCallback);
2796 2797
```

2798
## notificationManager.requestEnableNotification
2799 2800 2801 2802 2803 2804 2805 2806 2807

requestEnableNotification(): Promise\<void\>

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

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

**错误码:**

F
fangJinliang1 已提交
2808 2809
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2810 2811 2812 2813 2814 2815 2816 2817 2818
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2819
notificationManager.requestEnableNotification().then(() => {
F
fangJinliang1 已提交
2820 2821
    console.info("requestEnableNotification success");
});
2822 2823 2824 2825
```



2826
## notificationManager.setDistributedEnable
2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841

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

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

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2842
| enable   | boolean                  | 是   | 是否支持。 |
2843 2844 2845 2846
| callback | AsyncCallback\<void\> | 是   | 设置设备是否支持分布式通知的回调函数。 |

**错误码:**

F
fangJinliang1 已提交
2847 2848
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2849 2850 2851 2852 2853 2854 2855 2856 2857 2858
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2859
function setDistributedEnableCallback(err: Base.BusinessError) {
2860
    if (err) {
2861
        console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
2862 2863 2864 2865 2866
    } else {
        console.info("setDistributedEnable success");
    }
};

2867
let enable: boolean = true;
2868

2869
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
2870 2871
```

2872
## notificationManager.setDistributedEnable
2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887

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

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

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2888
| enable   | boolean                  | 是   | 是否支持。 |
2889 2890 2891

**错误码:**

F
fangJinliang1 已提交
2892 2893
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2894 2895 2896 2897 2898 2899 2900 2901 2902 2903
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2904
let enable: boolean = true;
2905

2906
notificationManager.setDistributedEnable(enable).then(() => {
2907 2908
    console.info("setDistributedEnable success");
});
2909 2910 2911
```


2912
## notificationManager.isDistributedEnabled
2913 2914 2915

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

F
fangJinliang1 已提交
2916
查询设备是否支持分布式通知(Callback形式)。
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927

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

**参数:**

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

**错误码:**

F
fangJinliang1 已提交
2928 2929
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2930 2931 2932 2933 2934 2935 2936 2937 2938 2939
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2940
function isDistributedEnabledCallback(err: Base.BusinessError, data: boolean) {
2941
    if (err) {
2942
        console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
2943
    } else {
F
fangJinliang1 已提交
2944
        console.info("isDistributedEnabled success " + JSON.stringify(data));
2945 2946 2947
    }
};

2948
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);
2949 2950 2951 2952
```



2953
## notificationManager.isDistributedEnabled
2954 2955 2956

isDistributedEnabled(): Promise\<boolean>

F
fangJinliang1 已提交
2957
查询设备是否支持分布式通知(Promise形式)。
2958 2959 2960 2961 2962

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

**返回值:**

F
fangJinliang1 已提交
2963 2964 2965
| 类型               | 说明                                          |
| ------------------ | --------------------------------------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。 |
2966 2967 2968

**错误码:**

F
fangJinliang1 已提交
2969 2970
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

2971 2972 2973 2974 2975 2976 2977 2978 2979 2980
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2981
notificationManager.isDistributedEnabled()
2982
    .then((data: boolean) => {
F
fangJinliang1 已提交
2983
        console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
2984 2985 2986 2987
    });
```


2988
## notificationManager.setDistributedEnableByBundle
2989 2990 2991

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

F
fangJinliang1 已提交
2992
设置指定应用是否支持分布式通知(Callback形式)。
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Y
yuyaozhi 已提交
3004
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)             | 是   | 应用的包信息。                   |
3005 3006 3007 3008 3009
| enable   | boolean                  | 是   | 是否支持。                       |
| callback | AsyncCallback\<void\> | 是   | 应用程序是否支持分布式通知的回调函数。 |

**错误码:**

F
fangJinliang1 已提交
3010 3011
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
| 错误码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
3023
function setDistributedEnableByBundleCallback(err: Base.BusinessError) {
3024
    if (err) {
3025
        console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
3026 3027 3028 3029 3030
    } else {
        console.info("enableDistributedByBundle success");
    }
};

3031
let bundle: notificationManager.BundleOption = {
3032
    bundle: "bundleName1",
F
fangJinliang1 已提交
3033
};
3034

3035
let enable: boolean = true;
3036

3037
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
3038 3039 3040 3041
```



3042
## notificationManager.setDistributedEnableByBundle
3043 3044 3045

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

F
fangJinliang1 已提交
3046
设置指定应用是否支持分布式通知(Promise形式)。
3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Y
yuyaozhi 已提交
3058
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)             | 是   | 应用的包。                |
3059 3060 3061 3062
| enable   | boolean                  | 是   | 是否支持。                  |

**错误码:**

F
fangJinliang1 已提交
3063 3064
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
| 错误码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
3076
let bundle: notificationManager.BundleOption = {
3077
    bundle: "bundleName1",
F
fangJinliang1 已提交
3078
};
3079

3080
let enable: boolean = true;
3081

3082 3083 3084
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
    console.info("setDistributedEnableByBundle success");
});
3085 3086
```

3087
## notificationManager.isDistributedEnabledByBundle
3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102

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

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

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Y
yuyaozhi 已提交
3103
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)             | 是   | 应用的包。                     |
F
fangJinliang1 已提交
3104
| callback | AsyncCallback\<boolean\> | 是   | 查询指定应用是否支持分布式通知的回调函数。 |
3105 3106 3107

**错误码:**

F
fangJinliang1 已提交
3108 3109
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120
| 错误码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
3121
function isDistributedEnabledByBundleCallback(err: Base.BusinessError, data: boolean) {
3122
    if (err) {
3123
        console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
3124
    } else {
F
fangJinliang1 已提交
3125
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
3126 3127 3128
    }
};

3129
let bundle: notificationManager.BundleOption = {
3130
    bundle: "bundleName1",
F
fangJinliang1 已提交
3131
};
3132

3133
notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
3134 3135
```

3136
## notificationManager.isDistributedEnabledByBundle
3137 3138 3139

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

F
fangJinliang1 已提交
3140
查询指定应用是否支持分布式通知(Promise形式)。
3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Y
yuyaozhi 已提交
3152
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)             | 是   | 应用的包。                |
3153 3154 3155

**返回值:**

F
fangJinliang1 已提交
3156 3157 3158
| 类型               | 说明                                              |
| ------------------ | ------------------------------------------------- |
| Promise\<boolean\> | Promise方式返回指定应用是否支持分布式通知的结果。 |
3159 3160 3161

**错误码:**

F
fangJinliang1 已提交
3162 3163
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
| 错误码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
3175
let bundle: notificationManager.BundleOption = {
3176
    bundle: "bundleName1",
F
fangJinliang1 已提交
3177
};
3178

3179
notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
3180 3181
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
3182 3183 3184
```


3185
## notificationManager.getDeviceRemindType
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200

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

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

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

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

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

**参数:**

| 参数名   | 类型                               | 必填 | 说明                       |
| -------- | --------------------------------- | ---- | -------------------------- |
F
fangJinliang1 已提交
3201
| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype)\> | 是   | 获取通知提醒方式的回调函数。 |
3202 3203 3204

**错误码:**

F
fangJinliang1 已提交
3205 3206
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3207 3208 3209 3210 3211 3212 3213 3214 3215
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
3216
function getDeviceRemindTypeCallback(err: Base.BusinessError, data: notificationManager.DeviceRemindType) {
3217
    if (err) {
3218
        console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
3219
    } else {
3220
        console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`);
3221 3222 3223
    }
};

3224
notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);
3225 3226
```

3227
## notificationManager.getDeviceRemindType
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242

getDeviceRemindType(): Promise\<DeviceRemindType\>

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

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

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

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

**返回值:**

| 类型               | 说明            |
| ------------------ | --------------- |
F
fangJinliang1 已提交
3243
| Promise\<[DeviceRemindType](#deviceremindtype)\> | Promise方式返回获取通知提醒方式的结果。 |
3244 3245 3246

**错误码:**

F
fangJinliang1 已提交
3247 3248
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3249 3250 3251 3252 3253 3254 3255 3256 3257
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
3258
notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => {
F
fangJinliang1 已提交
3259 3260
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
3261 3262 3263
```


3264
## notificationManager.publishAsBundle
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277

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 已提交
3278 3279
| 参数名               | 类型                                        | 必填 | 说明                                     |
| -------------------- | ------------------------------------------- | ---- | ---------------------------------------- |
3280
| request              | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
F
fangJinliang1 已提交
3281 3282 3283
| representativeBundle | string                                      | 是   | 被代理应用的包名。                       |
| userId               | number                                      | 是   | 用户ID。                                 |
| callback             | AsyncCallback                               | 是   | 发布代理通知的回调方法。                 |
3284 3285 3286

**错误码:**

F
fangJinliang1 已提交
3287 3288
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3289 3290 3291 3292 3293 3294 3295 3296 3297
| 错误码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. |
3298
| 1600012  | No memory space.                          |
3299 3300 3301

**示例:**

3302
```ts
3303
//publishAsBundle回调
3304
function callback(err: Base.BusinessError) {
3305
    if (err) {
3306
        console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
3307 3308 3309 3310 3311
    } else {
        console.info("publishAsBundle success");
    }
}
// 被代理应用的包名
3312
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3313
// 用户ID
3314
let userId: number = 100;
F
fangJinliang1 已提交
3315
// NotificationRequest对象
3316
let request: notificationManager.NotificationRequest = {
3317 3318
    id: 1,
    content: {
3319
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3320 3321 3322 3323 3324 3325
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3326
};
3327

3328
notificationManager.publishAsBundle(request, representativeBundle, userId, callback);
3329 3330
```

3331
## notificationManager.publishAsBundle
3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347

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

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

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

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

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

**参数:**


| 参数名               | 类型                                        | 必填 | 说明                                          |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
3348
| request              | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
3349
| representativeBundle | string                                      | 是   | 被代理应用的包名。                            |
F
fangJinliang1 已提交
3350
| userId               | number                                      | 是   | 用户ID。                            |
3351 3352 3353

**错误码:**

F
fangJinliang1 已提交
3354 3355
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3356 3357 3358 3359 3360 3361 3362 3363 3364
| 错误码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. |
3365
| 1600012  | No memory space.                          |
3366 3367 3368

**示例:**

3369
```ts
3370
// 被代理应用的包名
3371
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3372
// 用户ID
3373
let userId: number = 100;
F
fangJinliang1 已提交
3374
// NotificationRequest对象
3375
let request: notificationManager.NotificationRequest = {
3376 3377
    id: 1,
    content: {
3378
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3379 3380 3381 3382 3383 3384
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3385
};
3386

3387
notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
F
fangJinliang1 已提交
3388
	console.info("publishAsBundle success");
3389 3390 3391
});
```

3392
## notificationManager.cancelAsBundle
3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411

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 已提交
3412
| userId               | number        | 是   | 用户ID。       |
3413 3414 3415 3416
| callback             | AsyncCallback | 是   | 取消代理通知的回调方法。 |

**错误码:**

F
fangJinliang1 已提交
3417 3418
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3419 3420 3421 3422 3423 3424 3425 3426 3427 3428
| 错误码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.              |

**示例:**

3429
```ts
F
fangJinliang1 已提交
3430
// cancelAsBundle
3431
function cancelAsBundleCallback(err: Base.BusinessError) {
3432
    if (err) {
3433
        console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
3434 3435 3436 3437 3438
    } else {
        console.info("cancelAsBundle success");
    }
}
// 被代理应用的包名
3439
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3440
// 用户ID
3441
let userId: number = 100;
3442

3443
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
3444 3445
```

3446
## notificationManager.cancelAsBundle
3447 3448 3449

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

F
fangJinliang1 已提交
3450
取消代理通知(Promise形式)。
3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465

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

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

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

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

**参数:**

| 参数名               | 类型   | 必填 | 说明               |
| -------------------- | ------ | ---- | ------------------ |
| id                   | number | 是   | 通知ID。           |
| representativeBundle | string | 是   | 被代理应用的包名。 |
F
fangJinliang1 已提交
3466
| userId               | number | 是   | 用户ID。 |
3467 3468 3469

**错误码:**

F
fangJinliang1 已提交
3470 3471
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3472 3473 3474 3475 3476 3477 3478 3479 3480 3481
| 错误码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.              |

**示例:**

3482
```ts
3483
// 被代理应用的包名
3484
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3485
// 用户ID
3486
let userId: number = 100;
3487

3488
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
3489 3490 3491 3492
	console.info("cancelAsBundle success");
});
```

3493
## notificationManager.setNotificationEnableSlot 
3494 3495 3496

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

F
fangJinliang1 已提交
3497
设置指定应用的指定渠道类型的使能状态(Callback形式)。
3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508

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

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

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

**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
Y
yuyaozhi 已提交
3509
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。           |
3510 3511
| type     | [SlotType](#slottype)         | 是   | 指定渠道类型。         |
| enable   | boolean                       | 是   | 使能状态。             |
F
fangJinliang1 已提交
3512
| callback | AsyncCallback\<void\>         | 是   | 设置渠道使能回调函数。 |
3513 3514 3515

**错误码:**

F
fangJinliang1 已提交
3516 3517
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3518 3519 3520 3521 3522 3523 3524 3525 3526
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3527
```ts
F
fangJinliang1 已提交
3528
// setNotificationEnableSlot
3529
function setNotificationEnableSlotCallback(err: Base.BusinessError) {
3530
    if (err) {
3531
        console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
3532 3533 3534 3535 3536
    } else {
        console.info("setNotificationEnableSlot success");
    }
};

3537
notificationManager.setNotificationEnableSlot(
3538
    { bundle: "ohos.samples.notification", },
3539
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3540 3541 3542 3543
    true,
    setNotificationEnableSlotCallback);
```

3544
## notificationManager.setNotificationEnableSlot
3545 3546 3547

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

F
fangJinliang1 已提交
3548
设置指定应用的指定渠道类型的使能状态(Promise形式)。
3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
Y
yuyaozhi 已提交
3560
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。   |
F
fangJinliang1 已提交
3561
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3562 3563 3564 3565
| enable | boolean                       | 是   | 使能状态。     |

**错误码:**

F
fangJinliang1 已提交
3566 3567
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3568 3569 3570 3571 3572 3573 3574 3575 3576
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3577
```ts
F
fangJinliang1 已提交
3578
// setNotificationEnableSlot
3579
notificationManager.setNotificationEnableSlot(
3580
    { bundle: "ohos.samples.notification", },
3581
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3582
    true).then(() => {
F
fangJinliang1 已提交
3583
        console.info("setNotificationEnableSlot success");
3584 3585 3586
    });
```

3587
## notificationManager.isNotificationSlotEnabled
3588 3589 3590

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

F
fangJinliang1 已提交
3591
获取指定应用的指定渠道类型的使能状态(Callback形式)。
3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602

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

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

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

**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
Y
yuyaozhi 已提交
3603
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。           |
F
fangJinliang1 已提交
3604 3605
| type     | [SlotType](#slottype)         | 是   | 渠道类型。         |
| callback | AsyncCallback\<boolean\>         | 是   | 获取渠道使能状态回调函数。 |
3606 3607 3608

**错误码:**

F
fangJinliang1 已提交
3609 3610
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3611 3612 3613 3614 3615 3616 3617 3618 3619
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3620
```ts
F
fangJinliang1 已提交
3621
// isNotificationSlotEnabled
3622
function getEnableSlotCallback(err: Base.BusinessError, data: boolean) {
3623
    if (err) {
3624
        console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
3625
    } else {
3626
        console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`);
3627 3628 3629
    }
};

3630
notificationManager.isNotificationSlotEnabled(
3631
    { bundle: "ohos.samples.notification", },
3632
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3633 3634 3635
    getEnableSlotCallback);
```

3636
## notificationManager.isNotificationSlotEnabled
3637 3638 3639

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

F
fangJinliang1 已提交
3640
获取指定应用的指定渠道类型的使能状态(Promise形式)。
3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
Y
yuyaozhi 已提交
3652
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。   |
F
fangJinliang1 已提交
3653
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3654 3655 3656 3657 3658 3659 3660 3661 3662

**返回值:**

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

**错误码:**

F
fangJinliang1 已提交
3663 3664
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3665 3666 3667 3668 3669 3670 3671 3672 3673
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3674
```ts
F
fangJinliang1 已提交
3675
// isNotificationSlotEnabled
3676
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
3677
    notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => {
F
fangJinliang1 已提交
3678 3679
    console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
3680 3681 3682
```


3683
## notificationManager.setSyncNotificationEnabledWithoutApp
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698

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

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

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

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

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

**参数:** 

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3699 3700
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
3701 3702 3703 3704
| callback | AsyncCallback\<void\>    | 是   | 设置是否将通知同步到未安装应用程序的设备的回调函数。 |

**错误码:**

F
fangJinliang1 已提交
3705 3706
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3707 3708 3709 3710 3711 3712 3713 3714 3715
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3716
```ts
3717 3718
let userId: number = 100;
let enable: boolean = true;
3719

3720
function callback(err: Base.BusinessError) {
3721
    if (err) {
3722
        console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
3723 3724 3725 3726 3727
    } else {
        console.info("setSyncNotificationEnabledWithoutApp success");
    }
}

3728
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);
3729 3730 3731
```


3732
## notificationManager.setSyncNotificationEnabledWithoutApp
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747

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

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

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3748 3749
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
3750 3751 3752 3753 3754 3755 3756 3757 3758

**返回值:**

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

**错误码:**

F
fangJinliang1 已提交
3759 3760
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3761 3762 3763 3764 3765 3766 3767 3768 3769
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3770
```ts
3771 3772
let userId: number = 100;
let enable: boolean = true;
3773

3774
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
F
fangJinliang1 已提交
3775 3776
    console.info('setSyncNotificationEnabledWithoutApp success');
});
3777 3778 3779
```


3780
## notificationManager.getSyncNotificationEnabledWithoutApp
3781 3782 3783

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

F
fangJinliang1 已提交
3784
获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。
3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3796 3797
| userId | number | 是   | 用户ID。   |
| callback | AsyncCallback\<boolean\>         | 是   | 获取同步通知到未安装应用程序设备的开关是否开启的回调函数。 |
3798 3799 3800

**错误码:**

F
fangJinliang1 已提交
3801 3802
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3803 3804 3805 3806 3807 3808 3809 3810 3811
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3812
```ts
3813
let userId: number = 100;
3814

3815
function getSyncNotificationEnabledWithoutAppCallback(err: Base.BusinessError, data: boolean) {
3816
    if (err) {
F
fangJinliang1 已提交
3817
        console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
3818
    } else {
F
fangJinliang1 已提交
3819
        console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
3820 3821 3822
    }
}

3823
notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);
3824 3825 3826
```


3827
## notificationManager.getSyncNotificationEnabledWithoutApp
3828 3829 3830

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

F
fangJinliang1 已提交
3831
获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。
3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3843
| userId | number | 是   | 用户ID。   |
3844 3845 3846

**返回值:**

F
fangJinliang1 已提交
3847 3848 3849
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 |
3850 3851 3852

**错误码:**

F
fangJinliang1 已提交
3853 3854
错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

3855 3856 3857 3858 3859 3860 3861 3862 3863
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3864
```ts
3865 3866 3867 3868
let userId: number = 100;

notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => {
  console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
F
fangJinliang1 已提交
3869
});
3870 3871
```

3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
## notificationManager.on<sup>10+</sup>

on(type: 'checkNotification', callback: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void;

注册通知监听回调。通知服务将通知信息回调给校验程序,校验程序返回校验结果决定该通知是否发布,如营销类通知发布频率控制等。

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
X
xinking129 已提交
3888
| type | string | 是   | 回调函数类型名,固定为'checkNotification'。 |
X
xinking129 已提交
3889
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)    | 是   | 消息验证函数指针。 |
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909

**错误码:**

错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |

**示例:**

```ts
try{
    notificationManager.on("checkNotification", OnCheckNotification);
} catch (error){
    console.info(`notificationManager.on error: ${JSON.stringify(error)}`);
}
function OnCheckNotification(info : notificationManager.NotificationCheckInfo) {
    console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`);
    if(info.notificationId == 1){
3910 3911
        let result: notificationManager.NotificationCheckResult =  { code: 1, message: "testMsg1"};
        return result;
3912
    } else {
3913 3914
        let result: notificationManager.NotificationCheckResult =   { code: 0, message: "testMsg0"};
        return result;
3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934
    }
}
```

## notificationManager.off<sup>10+</sup>

off(type: 'checkNotification', callback?: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void;

取消通知监听回调。

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
X
xinking129 已提交
3935
| type | string                                                       | 是   | 回调函数类型名,固定为'checkNotification'。 |
X
xinking129 已提交
3936
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)  | 否   | 消息验证函数指针。 |
3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954

**错误码:**

错误码详细介绍请参考[errcode-notification](../errorcodes/errorcode-notification.md)

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |

**示例:**

```ts
try{
    notificationManager.off("checkNotification");
} catch (error){
    console.info(`notificationManager.off error: ${JSON.stringify(error)}`);
}
```
3955 3956 3957 3958 3959 3960 3961

## DoNotDisturbDate

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

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

3962 3963 3964 3965 3966
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | ---- | ---------------------- |
| type  | [DoNotDisturbType](#donotdisturbtype) | 是   | 免打扰设置的时间类型。 |
| begin | Date                                  | 是   | 免打扰设置的起点时间。 |
| end   | Date                                  | 是   | 免打扰设置的终点时间。 |
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986

## DoNotDisturbType

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

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

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


## ContentType

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

| 名称                              | 值          | 说明               |
X
XKK 已提交
3987 3988 3989 3990 3991 3992
| --------------------------------- | ----------- |------------------|
| 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 | 多行文本类型通知。        |
3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027

## SlotLevel

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

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


## SlotType

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

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




## DeviceRemindType

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

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

F
fangJinliang1 已提交
4028
| 名称                 | 值  | 说明                               |
4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |


## SourceType

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

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

F
fangJinliang1 已提交
4042
| 名称                 | 值  | 说明                  |
4043 4044 4045 4046
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
| TYPE_TIMER           | 2   | 计划通知。            |
4047 4048 4049 4050 4051 4052 4053 4054 4055

## NotificationCheckInfo<sup>10+</sup>

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

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

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

4056 4057 4058 4059 4060
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | --- | ---------------------- |
| bundleName  | string                          | 是   | bundle名称。 |
| notificationId | number                       | 是   | 通知Id。     |
| contentType   | [ContentType](#contenttype)   | 是   | 通知类型。   |
4061 4062 4063 4064 4065 4066 4067 4068 4069

## NotificationCheckResult<sup>10+</sup>

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

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

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

4070 4071 4072 4073
| 名称    | 类型                                  | 必填 | 说明                   |
| ------- | ------------------------------------ | ---- | ---------------------- |
| code    | number                               | 是   | 0-display, 1-no display。 |
| message | string                               | 是   | 结果信息。    |