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

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

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

## 导入模块

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

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

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

发布通知(callback形式)。

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

**参数:**

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

**错误码:**

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

34 35 36 37 38 39 40 41
| 错误码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. |
42
| 1600012  | No memory space.                          |
43 44 45

**示例:**

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

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

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

发布通知(Promise形式)。

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

```

119
## notificationManager.publish
120 121 122

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

182
## notificationManager.publish
183 184 185

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

F
fangJinliang1 已提交
231
let userId = 1;
232

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


239
## notificationManager.cancel
240 241 242

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

280
## notificationManager.cancel
281 282 283

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

314
## notificationManager.cancel
315 316 317

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

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

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

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

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

**错误码:**

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

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

**参数:**

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

**示例:**

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

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

cancelAll(): Promise\<void\>

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

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

**错误码:**

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

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

**示例:**

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

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

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

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

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

507
## notificationManager.addSlot
508 509 510

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

547
## notificationManager.addSlot
548 549 550

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

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

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

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

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

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

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

677
## notificationManager.getSlot
678 679 680

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

717
## notificationManager.getSlot
718 719 720

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

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

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

**示例:**

749 750 751
```ts
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data) => {
F
fangJinliang1 已提交
752
	console.info("getSlot success, data: " + JSON.stringify(data));
753 754 755
});
```

756
## notificationManager.getSlots
757

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

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

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

**参数:**

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

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

**错误码:**

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

**示例:**

782
```ts
F
fangJinliang1 已提交
783
// getSlots回调
784 785
function getSlotsCallback(err,data) {
    if (err) {
786
        console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
787 788 789 790
    } else {
        console.info("getSlots success");
    }
}
791
notificationManager.getSlots(getSlotsCallback);
792 793
```

794
## notificationManager.getSlots
795

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

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

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

**返回值:**

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

**错误码:**

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

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

**示例:**

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

826
## notificationManager.removeSlot
827 828 829

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

866
## notificationManager.removeSlot
867 868 869

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

899
## notificationManager.removeAllSlots
900 901 902 903 904 905 906 907 908

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

936
## notificationManager.removeAllSlots
937 938 939 940 941 942 943 944 945

removeAllSlots(): Promise\<void\>

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

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

**错误码:**

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

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

**示例:**

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

962
## notificationManager.setNotificationEnable
963 964 965

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

1009
## notificationManager.setNotificationEnable
1010 1011 1012

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

1050
## notificationManager.isNotificationEnabled
1051 1052 1053

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

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

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

1082
```ts
1083 1084
function isNotificationEnabledCallback(err, data) {
    if (err) {
1085
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
1086 1087 1088 1089
    } else {
        console.info("isNotificationEnabled success");
    }
}
F
fangJinliang1 已提交
1090
let bundle = {
1091
    bundle: "bundleName1",
F
fangJinliang1 已提交
1092
};
1093
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
1094 1095
```

1096
## notificationManager.isNotificationEnabled
1097 1098 1099

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

F
fangJinliang1 已提交
1100
获取指定应用的通知使能状态(Promise形式)。
1101 1102 1103 1104 1105 1106 1107 1108 1109

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

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

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

**示例:**

1133
```ts
F
fangJinliang1 已提交
1134
let bundle = {
1135
    bundle: "bundleName1",
F
fangJinliang1 已提交
1136
};
1137
notificationManager.isNotificationEnabled(bundle).then((data) => {
F
fangJinliang1 已提交
1138
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1139 1140 1141
});
```

1142
## notificationManager.isNotificationEnabled
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155

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

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

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

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

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

**参数:**

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

**错误码:**

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

1164 1165 1166 1167 1168 1169 1170 1171
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1172
```ts
1173 1174
function isNotificationEnabledCallback(err, data) {
    if (err) {
1175
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
1176 1177 1178 1179 1180
    } else {
        console.info("isNotificationEnabled success");
    }
}

1181
notificationManager.isNotificationEnabled(isNotificationEnabledCallback);
1182 1183
```

1184
## notificationManager.isNotificationEnabled
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195

isNotificationEnabled(): Promise\<boolean\>

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

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

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

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

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 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 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
**返回值:**

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

**错误码:**

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

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

**示例:**

```ts
notificationManager.isNotificationEnabled().then((data) => {
	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
function isNotificationEnabledCallback(err, data) {
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isNotificationEnabled success");
    }
}

let userId = 1;

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

## notificationManager.isNotificationEnabled

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

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

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

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

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

1278 1279
**参数:**

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

**返回值:**

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

**错误码:**

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

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

**示例:**

1303
```ts
1304 1305 1306
let userId = 1;

notificationManager.isNotificationEnabled(userId).then((data) => {
F
fangJinliang1 已提交
1307
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
1308 1309 1310
});
```

1311
## notificationManager.displayBadge
1312 1313 1314

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

F
fangJinliang1 已提交
1315
设定指定应用的角标使能状态(Callback形式)。
1316 1317 1318 1319 1320 1321 1322 1323 1324

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

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

1358
## notificationManager.displayBadge
1359 1360 1361

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

F
fangJinliang1 已提交
1362
设定指定应用的角标使能状态(Promise形式)。
1363 1364 1365 1366 1367 1368 1369 1370 1371

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

1390
```ts
F
fangJinliang1 已提交
1391
let bundle = {
1392
    bundle: "bundleName1",
F
fangJinliang1 已提交
1393
};
1394
notificationManager.displayBadge(bundle, false).then(() => {
F
fangJinliang1 已提交
1395
	console.info("displayBadge success");
1396 1397 1398
});
```

1399
## notificationManager.isBadgeDisplayed
1400 1401 1402

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

F
fangJinliang1 已提交
1403
获取指定应用的角标使能状态(Callback形式)。
1404 1405 1406 1407 1408 1409 1410 1411 1412

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

1431
```ts
1432 1433
function isBadgeDisplayedCallback(err, data) {
    if (err) {
1434
        console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
1435 1436 1437 1438
    } else {
        console.info("isBadgeDisplayed success");
    }
}
F
fangJinliang1 已提交
1439
let bundle = {
1440
    bundle: "bundleName1",
F
fangJinliang1 已提交
1441
};
1442
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
1443 1444
```

1445
## notificationManager.isBadgeDisplayed
1446 1447 1448

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

F
fangJinliang1 已提交
1449
获取指定应用的角标使能状态(Promise形式)。
1450 1451 1452 1453 1454 1455 1456 1457 1458

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

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

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

**示例:**

1482
```ts
F
fangJinliang1 已提交
1483
let bundle = {
1484
    bundle: "bundleName1",
F
fangJinliang1 已提交
1485
};
1486
notificationManager.isBadgeDisplayed(bundle).then((data) => {
F
fangJinliang1 已提交
1487
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
1488 1489 1490
});
```

F
fangJinliang1 已提交
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
## 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.          |
1512
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

**示例:**

```ts
let badgeNumber = 10
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.          |
1547
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563

**示例:**

```ts
function setBadgeNumberCallback(err) {
    if (err) {
        console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("displayBadge success");
    }
}

let badgeNumber = 10
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
```

1564
## notificationManager.setSlotByBundle
1565 1566 1567

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

F
fangJinliang1 已提交
1568
设定指定应用的通知通道(Callback形式)。
1569 1570 1571 1572 1573 1574 1575 1576 1577

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

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

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

**参数:**

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

**错误码:**

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

1588 1589 1590 1591 1592 1593 1594 1595 1596
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1597
```ts
1598 1599
function setSlotByBundleCallback(err) {
    if (err) {
1600
        console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1601 1602 1603 1604
    } else {
        console.info("setSlotByBundle success");
    }
}
F
fangJinliang1 已提交
1605
let bundle = {
1606
    bundle: "bundleName1",
F
fangJinliang1 已提交
1607 1608
};
let notificationSlot = {
1609
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1610
};
1611
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
1612 1613
```

1614
## notificationManager.setSlotByBundle
1615 1616 1617

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

F
fangJinliang1 已提交
1618
设定指定应用的通知通道(Promise形式)。
1619 1620 1621 1622 1623 1624 1625 1626 1627

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

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

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

**参数:**

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

**错误码:**

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

1637 1638 1639 1640 1641 1642 1643 1644 1645
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1646
```ts
F
fangJinliang1 已提交
1647
let bundle = {
1648
    bundle: "bundleName1",
F
fangJinliang1 已提交
1649 1650
};
let notificationSlot = {
1651
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1652
};
1653
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
F
fangJinliang1 已提交
1654
	console.info("setSlotByBundle success");
1655 1656 1657
});
```

1658
## notificationManager.getSlotsByBundle
1659

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

F
fangJinliang1 已提交
1662
获取指定应用的所有通知通道(Callback形式)。
1663 1664 1665 1666 1667 1668 1669 1670 1671

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

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

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

**参数:**

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

**错误码:**

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

1681 1682 1683 1684 1685 1686 1687 1688 1689
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1690
```ts
1691 1692
function getSlotsByBundleCallback(err, data) {
    if (err) {
1693
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1694 1695 1696 1697
    } else {
        console.info("getSlotsByBundle success");
    }
}
F
fangJinliang1 已提交
1698
let bundle = {
1699
    bundle: "bundleName1",
F
fangJinliang1 已提交
1700
};
1701
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
1702 1703
```

1704
## notificationManager.getSlotsByBundle
1705

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

F
fangJinliang1 已提交
1708
获取指定应用的所有通知通道(Promise形式)。
1709 1710 1711 1712 1713 1714 1715 1716 1717

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

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

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

**参数:**

F
fangJinliang1 已提交
1718
| 参数名   | 类型         | 必填 | 说明       |
1719
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1720
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1721 1722 1723 1724 1725

**返回值:**

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

**错误码:**

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

1732 1733 1734 1735 1736 1737 1738 1739 1740
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1741
```ts
F
fangJinliang1 已提交
1742
let bundle = {
1743
    bundle: "bundleName1",
F
fangJinliang1 已提交
1744
};
1745
notificationManager.getSlotsByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
1746
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
1747 1748 1749
});
```

1750
## notificationManager.getSlotNumByBundle
1751 1752 1753

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

F
fangJinliang1 已提交
1754
获取指定应用的通知通道数量(Callback形式)。
1755 1756 1757 1758 1759 1760 1761 1762 1763

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

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

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

**参数:**

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

**错误码:**

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

1773 1774 1775 1776 1777 1778 1779 1780 1781
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1782
```ts
1783 1784
function getSlotNumByBundleCallback(err, data) {
    if (err) {
1785
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1786 1787 1788 1789
    } else {
        console.info("getSlotNumByBundle success");
    }
}
F
fangJinliang1 已提交
1790
let bundle = {
1791
    bundle: "bundleName1",
F
fangJinliang1 已提交
1792
};
1793
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
1794 1795
```

1796
## notificationManager.getSlotNumByBundle
1797 1798 1799

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

F
fangJinliang1 已提交
1800
获取指定应用的通知通道数量(Promise形式)。
1801 1802 1803 1804 1805 1806 1807 1808 1809

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

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

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

**参数:**

F
fangJinliang1 已提交
1810
| 参数名   | 类型         | 必填 | 说明       |
1811
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1812
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1813 1814 1815 1816 1817

**返回值:**

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

**错误码:**

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

1824 1825 1826 1827 1828 1829 1830 1831 1832
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1833
```ts
F
fangJinliang1 已提交
1834
let bundle = {
1835
    bundle: "bundleName1",
F
fangJinliang1 已提交
1836
};
1837
notificationManager.getSlotNumByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
1838
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
1839 1840 1841 1842
});
```


1843
## notificationManager.getAllActiveNotifications
1844

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

F
fangJinliang1 已提交
1847
获取当前未删除的所有通知(Callback形式)。
1848 1849 1850 1851 1852 1853 1854 1855 1856

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

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

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

**参数:**

F
fangJinliang1 已提交
1857
| 参数名     | 类型                                                         | 必填 | 说明                 |
1858
| -------- | ------------------------------------------------------------ | ---- | -------------------- |
1859
| callback | AsyncCallback\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)>> | 是   | 获取活动通知回调函数。 |
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870

**错误码:**

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

**示例:**

1871
```ts
1872 1873
function getAllActiveNotificationsCallback(err, data) {
    if (err) {
1874
        console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
1875 1876 1877 1878 1879
    } else {
        console.info("getAllActiveNotifications success");
    }
}

1880
notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);
1881 1882
```

1883
## notificationManager.getAllActiveNotifications
1884

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

F
fangJinliang1 已提交
1887
获取当前未删除的所有通知(Promise形式)。
1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898

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

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

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

**返回值:**

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

**错误码:**

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

1905 1906 1907 1908 1909 1910 1911 1912
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1913 1914
```ts
notificationManager.getAllActiveNotifications().then((data) => {
F
fangJinliang1 已提交
1915
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
1916 1917 1918
});
```

1919
## notificationManager.getActiveNotificationCount
1920 1921 1922

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

F
fangJinliang1 已提交
1923
获取当前应用未删除的通知数(Callback形式)。
1924 1925 1926 1927 1928

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

**参数:**

F
fangJinliang1 已提交
1929
| 参数名     | 类型                   | 必填 | 说明                   |
1930
| -------- | ---------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
1931
| callback | AsyncCallback\<number\> | 是   | 获取未删除通知数回调函数。 |
1932 1933 1934

**错误码:**

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

1937 1938 1939 1940 1941 1942 1943 1944
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1945
```ts
1946 1947
function getActiveNotificationCountCallback(err, data) {
    if (err) {
1948
        console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
1949 1950 1951 1952 1953
    } else {
        console.info("getActiveNotificationCount success");
    }
}

1954
notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);
1955 1956
```

1957
## notificationManager.getActiveNotificationCount
1958 1959 1960

getActiveNotificationCount(): Promise\<number\>

F
fangJinliang1 已提交
1961
获取当前应用未删除的通知数(Promise形式)。
1962 1963 1964 1965 1966

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

**返回值:**

F
fangJinliang1 已提交
1967 1968 1969
| 类型              | 说明                                        |
| ----------------- | ------------------------------------------- |
| Promise\<number\> | 以Promise形式返回获取当前应用未删除通知数。 |
1970 1971 1972

**错误码:**

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

1975 1976 1977 1978 1979 1980 1981 1982
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1983 1984
```ts
notificationManager.getActiveNotificationCount().then((data) => {
F
fangJinliang1 已提交
1985
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
1986 1987 1988
});
```

1989
## notificationManager.getActiveNotifications
1990

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

F
fangJinliang1 已提交
1993
获取当前应用未删除的通知列表(Callback形式)。
1994 1995 1996 1997 1998

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

**参数:**

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

**错误码:**

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

2007 2008 2009 2010 2011 2012 2013 2014
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2015
```ts
2016 2017
function getActiveNotificationsCallback(err, data) {
    if (err) {
2018
        console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
2019 2020 2021 2022 2023
    } else {
        console.info("getActiveNotifications success");
    }
}

2024
notificationManager.getActiveNotifications(getActiveNotificationsCallback);
2025 2026
```

2027
## notificationManager.getActiveNotifications
2028

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

F
fangJinliang1 已提交
2031
获取当前应用未删除的通知列表(Promise形式)。
2032 2033 2034 2035 2036

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

**返回值:**

F
fangJinliang1 已提交
2037 2038
| 类型                                                         | 说明                                    |
| ------------------------------------------------------------ | --------------------------------------- |
2039
| Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\> | 以Promise形式返回获取当前应用通知列表。 |
2040 2041 2042

**错误码:**

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

2045 2046 2047 2048 2049 2050 2051 2052
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2053 2054
```ts
notificationManager.getActiveNotifications().then((data) => {
F
fangJinliang1 已提交
2055
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
2056 2057 2058
});
```

2059
## notificationManager.cancelGroup
2060 2061 2062

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

F
fangJinliang1 已提交
2063
取消本应用指定组下的通知(Callback形式)。
2064 2065 2066 2067 2068

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

**参数:**

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

**错误码:**

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

2078 2079 2080 2081 2082 2083 2084 2085
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2086
```ts
2087 2088
function cancelGroupCallback(err) {
    if (err) {
2089
        console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
2090 2091 2092 2093 2094
    } else {
        console.info("cancelGroup success");
    }
}

F
fangJinliang1 已提交
2095
let groupName = "GroupName";
2096

2097
notificationManager.cancelGroup(groupName, cancelGroupCallback);
2098 2099
```

2100
## notificationManager.cancelGroup
2101 2102 2103

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

F
fangJinliang1 已提交
2104
取消本应用指定组下的通知(Promise形式)。
2105 2106 2107 2108 2109

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

**参数:**

F
fangJinliang1 已提交
2110
| 参数名      | 类型   | 必填 | 说明           |
2111
| --------- | ------ | ---- | -------------- |
F
fangJinliang1 已提交
2112
| groupName | string | 是   | 通知组名称。 |
2113 2114 2115

**错误码:**

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

2118 2119 2120 2121 2122 2123 2124 2125
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2126
```ts
F
fangJinliang1 已提交
2127
let groupName = "GroupName";
2128
notificationManager.cancelGroup(groupName).then(() => {
F
fangJinliang1 已提交
2129
	console.info("cancelGroup success");
2130 2131 2132
});
```

2133
## notificationManager.removeGroupByBundle
2134 2135 2136

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

F
fangJinliang1 已提交
2137
删除指定应用的指定组下的通知(Callback形式)。
2138 2139 2140 2141 2142 2143 2144 2145 2146

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

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

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

**参数:**

F
fangJinliang1 已提交
2147
| 参数名      | 类型                  | 必填 | 说明                         |
2148
| --------- | --------------------- | ---- | ---------------------------- |
Y
yuyaozhi 已提交
2149
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 应用的包信息。                   |
F
fangJinliang1 已提交
2150 2151
| groupName | string                | 是   | 通知组名称。               |
| callback  | AsyncCallback\<void\> | 是   | 删除指定应用指定组下通知的回调函数。 |
2152 2153 2154

**错误码:**

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

2157 2158 2159 2160 2161 2162 2163 2164 2165
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2166
```ts
2167 2168
function removeGroupByBundleCallback(err) {
    if (err) {
2169
        console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
2170 2171 2172 2173 2174
    } else {
        console.info("removeGroupByBundle success");
    }
}

F
fangJinliang1 已提交
2175 2176
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
2177

2178
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
2179 2180
```

2181
## notificationManager.removeGroupByBundle
2182 2183 2184

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

F
fangJinliang1 已提交
2185
删除指定应用的指定组下的通知(Promise形式)。
2186 2187 2188 2189 2190 2191 2192 2193 2194

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

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

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

**参数:**

F
fangJinliang1 已提交
2195
| 参数名      | 类型         | 必填 | 说明           |
2196
| --------- | ------------ | ---- | -------------- |
Y
yuyaozhi 已提交
2197
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。     |
F
fangJinliang1 已提交
2198
| groupName | string       | 是   | 通知组名称。 |
2199 2200 2201

**错误码:**

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

2204 2205 2206 2207 2208 2209 2210 2211 2212
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2213
```ts
F
fangJinliang1 已提交
2214 2215
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
2216
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
F
fangJinliang1 已提交
2217
	console.info("removeGroupByBundle success");
2218 2219 2220
});
```

2221
## notificationManager.setDoNotDisturbDate
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2235
| 参数名     | 类型                  | 必填 | 说明                   |
2236 2237 2238 2239 2240 2241
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

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

2244 2245 2246 2247 2248
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2249
| 1600012  | No memory space.                          |
2250 2251 2252

**示例:**

2253
```ts
2254 2255
function setDoNotDisturbDateCallback(err) {
    if (err) {
2256
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2257 2258 2259 2260 2261
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
2262
let doNotDisturbDate = {
2263
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2264 2265
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2266
};
2267

2268
notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
2269 2270
```

2271
## notificationManager.setDoNotDisturbDate
2272 2273 2274

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

F
fangJinliang1 已提交
2275
设置免打扰时间(Promise形式)。
2276 2277 2278 2279 2280 2281 2282 2283 2284

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

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

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

**参数:**

F
fangJinliang1 已提交
2285
| 参数名 | 类型             | 必填 | 说明           |
2286 2287 2288 2289 2290
| ---- | ---------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |

**错误码:**

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

2293 2294 2295 2296 2297
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2298
| 1600012  | No memory space.                          |
2299 2300 2301

**示例:**

2302
```ts
F
fangJinliang1 已提交
2303
let doNotDisturbDate = {
2304
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2305 2306
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2307
};
2308
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
F
fangJinliang1 已提交
2309
	console.info("setDoNotDisturbDate success");
2310 2311 2312 2313
});
```


2314
## notificationManager.setDoNotDisturbDate
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2328
| 参数名     | 类型                  | 必填 | 说明                   |
2329 2330
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
F
fangJinliang1 已提交
2331
| userId   | number                | 是   | 设置免打扰时间的用户ID。 |
2332 2333 2334 2335
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

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

2338 2339 2340 2341 2342 2343
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2344
| 1600012  | No memory space.                          |
2345 2346 2347

**示例:**

2348
```ts
2349 2350
function setDoNotDisturbDateCallback(err) {
    if (err) {
2351
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2352 2353 2354 2355 2356
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
2357
let doNotDisturbDate = {
2358
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2359 2360
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2361
};
2362

F
fangJinliang1 已提交
2363
let userId = 1;
2364

2365
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
2366 2367
```

2368
## notificationManager.setDoNotDisturbDate
2369 2370 2371

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

F
fangJinliang1 已提交
2372
指定用户设置免打扰时间(Promise形式)。
2373 2374 2375 2376 2377 2378 2379 2380 2381

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

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

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

**参数:**

F
fangJinliang1 已提交
2382
| 参数名   | 类型             | 必填 | 说明           |
2383 2384
| ------ | ---------------- | ---- | -------------- |
| date   | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |
F
fangJinliang1 已提交
2385
| userId | number           | 是   | 设置免打扰时间的用户ID。 |
2386 2387 2388

**错误码:**

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

2391 2392 2393 2394 2395 2396
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2397
| 1600012  | No memory space.                          |
2398 2399 2400

**示例:**

2401
```ts
F
fangJinliang1 已提交
2402
let doNotDisturbDate = {
2403
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2404 2405
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2406
};
2407

F
fangJinliang1 已提交
2408
let userId = 1;
2409

2410
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
F
fangJinliang1 已提交
2411
	console.info("setDoNotDisturbDate success");
2412 2413 2414 2415
});
```


2416
## notificationManager.getDoNotDisturbDate
2417 2418 2419

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

F
fangJinliang1 已提交
2420
查询免打扰时间(Callback形式)。
2421 2422 2423 2424 2425 2426 2427 2428 2429

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

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

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

**参数:**

F
fangJinliang1 已提交
2430
| 参数名     | 类型                              | 必填 | 说明                   |
2431 2432 2433 2434 2435
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |

**错误码:**

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

2438 2439 2440 2441 2442
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2443
| 1600012  | No memory space.                          |
2444 2445 2446

**示例:**

2447
```ts
2448 2449
function getDoNotDisturbDateCallback(err,data) {
    if (err) {
2450
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2451 2452 2453 2454 2455
    } else {
        console.info("getDoNotDisturbDate success");
    }
}

2456
notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);
2457 2458
```

2459
## notificationManager.getDoNotDisturbDate
2460 2461 2462

getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>

F
fangJinliang1 已提交
2463
查询免打扰时间(Promise形式)。
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474

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

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

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

**返回值:**

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

**错误码:**

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

2481 2482 2483 2484 2485
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2486
| 1600012  | No memory space.                          |
2487 2488 2489

**示例:**

2490 2491
```ts
notificationManager.getDoNotDisturbDate().then((data) => {
F
fangJinliang1 已提交
2492
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2493 2494 2495 2496
});
```


2497
## notificationManager.getDoNotDisturbDate
2498 2499 2500

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

F
fangJinliang1 已提交
2501
查询指定用户的免打扰时间(Callback形式)。
2502 2503 2504 2505 2506 2507 2508 2509 2510

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

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

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

**参数:**

F
fangJinliang1 已提交
2511
| 参数名     | 类型                              | 必填 | 说明                   |
2512 2513
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |
F
fangJinliang1 已提交
2514
| userId   | number                            | 是   | 用户ID。 |
2515 2516 2517

**错误码:**

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

2520 2521 2522 2523 2524 2525
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2526
| 1600012  | No memory space.                          |
2527 2528 2529

**示例:**

2530
```ts
2531 2532
function getDoNotDisturbDateCallback(err,data) {
    if (err) {
2533
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2534 2535 2536 2537 2538
    } else {
        console.info("getDoNotDisturbDate success");
    }
}

F
fangJinliang1 已提交
2539
let userId = 1;
2540

2541
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
2542 2543
```

2544
## notificationManager.getDoNotDisturbDate
2545 2546 2547

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

F
fangJinliang1 已提交
2548
查询指定用户的免打扰时间(Promise形式)。
2549 2550 2551 2552 2553 2554 2555 2556 2557

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

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

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

**参数:**

F
fangJinliang1 已提交
2558
| 参数名     | 类型                              | 必填 | 说明                   |
2559
| -------- | --------------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
2560
| userId   | number                            | 是   | 用户ID。 |
2561 2562 2563 2564 2565

**返回值:**

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

**错误码:**

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

2572 2573 2574 2575 2576 2577
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2578
| 1600012  | No memory space.                          |
2579 2580 2581

**示例:**

2582
```ts
F
fangJinliang1 已提交
2583
let userId = 1;
2584

2585
notificationManager.getDoNotDisturbDate(userId).then((data) => {
F
fangJinliang1 已提交
2586
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2587 2588 2589 2590
});
```


F
fangJinliang1 已提交
2591
## notificationManager.isSupportDoNotDisturbMode
2592

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

F
fangJinliang1 已提交
2595
查询是否支持免打扰功能(Callback形式)。
2596 2597 2598 2599 2600 2601 2602 2603 2604

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

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

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

**参数:**

F
fangJinliang1 已提交
2605
| 参数名     | 类型                     | 必填 | 说明                             |
2606
| -------- | ------------------------ | ---- | -------------------------------- |
F
fangJinliang1 已提交
2607
| callback | AsyncCallback\<boolean\> | 是   | 查询是否支持免打扰功能回调函数。 |
2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618

**错误码:**

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

**示例:**

2619
```ts
F
fangJinliang1 已提交
2620
function isSupportDoNotDisturbModeCallback(err,data) {
2621
    if (err) {
2622
        console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
2623
    } else {
F
fangJinliang1 已提交
2624
        console.info("isSupportDoNotDisturbMode success");
2625 2626 2627
    }
}

F
fangJinliang1 已提交
2628
notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);
2629 2630
```

F
fangJinliang1 已提交
2631
## notificationManager.isSupportDoNotDisturbMode
2632

F
fangJinliang1 已提交
2633
isSupportDoNotDisturbMode(): Promise\<boolean\>
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646

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

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

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

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

**返回值:**

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

**错误码:**

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

2653 2654 2655 2656 2657 2658 2659 2660
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2661
```ts
F
fangJinliang1 已提交
2662
notificationManager.isSupportDoNotDisturbMode().then((data) => {
F
fangJinliang1 已提交
2663
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
2664 2665 2666
});
```

2667
## notificationManager.isSupportTemplate
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683

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

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

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

**参数:**

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

**错误码:**

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

2686 2687 2688 2689 2690 2691 2692 2693 2694
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
F
fangJinliang1 已提交
2695
let templateName = 'process';
2696 2697
function isSupportTemplateCallback(err, data) {
    if (err) {
2698
        console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
2699 2700 2701 2702 2703
    } else {
        console.info("isSupportTemplate success");
    }
}

2704
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);
2705 2706
```

2707
## notificationManager.isSupportTemplate
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

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

2731 2732 2733 2734 2735 2736 2737 2738 2739
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
F
fangJinliang1 已提交
2740
let templateName = 'process';
2741

2742
notificationManager.isSupportTemplate(templateName).then((data) => {
2743 2744 2745 2746
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
```

2747
## notificationManager.requestEnableNotification
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762

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

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

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

**参数:**

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

**错误码:**

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

2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
function requestEnableNotificationCallback(err) {
    if (err) {
2776
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
2777 2778 2779 2780 2781
    } else {
        console.info("requestEnableNotification success");
    }
};

2782
notificationManager.requestEnableNotification(requestEnableNotificationCallback);
2783 2784
```

2785
## notificationManager.requestEnableNotification
2786 2787 2788 2789 2790 2791 2792 2793 2794

requestEnableNotification(): Promise\<void\>

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

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

**错误码:**

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

2797 2798 2799 2800 2801 2802 2803 2804 2805
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
2806
notificationManager.requestEnableNotification().then(() => {
F
fangJinliang1 已提交
2807 2808
    console.info("requestEnableNotification success");
});
2809 2810 2811 2812
```



2813
## notificationManager.setDistributedEnable
2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828

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

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

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

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

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

**参数:**

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

**错误码:**

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

2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2846
function setDistributedEnableCallback(err) {
2847
    if (err) {
2848
        console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
2849 2850 2851 2852 2853
    } else {
        console.info("setDistributedEnable success");
    }
};

F
fangJinliang1 已提交
2854
let enable = true;
2855

2856
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
2857 2858
```

2859
## notificationManager.setDistributedEnable
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874

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

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

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
2875
| enable   | boolean                  | 是   | 是否支持。 |
2876 2877 2878

**错误码:**

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

2881 2882 2883 2884 2885 2886 2887 2888 2889 2890
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
F
fangJinliang1 已提交
2891
let enable = true;
2892

2893
notificationManager.setDistributedEnable(enable).then(() => {
F
fangJinliang1 已提交
2894
        console.info("setDistributedEnable success");
2895 2896 2897 2898
    });
```


2899
## notificationManager.isDistributedEnabled
2900 2901 2902

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

F
fangJinliang1 已提交
2903
查询设备是否支持分布式通知(Callback形式)。
2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914

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

**参数:**

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

**错误码:**

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

2917 2918 2919 2920 2921 2922 2923 2924 2925 2926
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
F
fangJinliang1 已提交
2927
function isDistributedEnabledCallback(err, data) {
2928
    if (err) {
2929
        console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
2930
    } else {
F
fangJinliang1 已提交
2931
        console.info("isDistributedEnabled success " + JSON.stringify(data));
2932 2933 2934
    }
};

2935
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);
2936 2937 2938 2939
```



2940
## notificationManager.isDistributedEnabled
2941 2942 2943

isDistributedEnabled(): Promise\<boolean>

F
fangJinliang1 已提交
2944
查询设备是否支持分布式通知(Promise形式)。
2945 2946 2947 2948 2949

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

**返回值:**

F
fangJinliang1 已提交
2950 2951 2952
| 类型               | 说明                                          |
| ------------------ | --------------------------------------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。 |
2953 2954 2955

**错误码:**

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

2958 2959 2960 2961 2962 2963 2964 2965 2966 2967
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

```javascript
2968
notificationManager.isDistributedEnabled()
2969
    .then((data) => {
F
fangJinliang1 已提交
2970
        console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
2971 2972 2973 2974
    });
```


2975
## notificationManager.setDistributedEnableByBundle
2976 2977 2978

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

F
fangJinliang1 已提交
2979
设置指定应用是否支持分布式通知(Callback形式)。
2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990

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

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

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

**参数:**

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

**错误码:**

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

2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
function setDistributedEnableByBundleCallback(err) {
    if (err) {
3012
        console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
3013 3014 3015 3016 3017
    } else {
        console.info("enableDistributedByBundle success");
    }
};

F
fangJinliang1 已提交
3018
let bundle = {
3019
    bundle: "bundleName1",
F
fangJinliang1 已提交
3020
};
3021

F
fangJinliang1 已提交
3022
let enable = true
3023

3024
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
3025 3026 3027 3028
```



3029
## notificationManager.setDistributedEnableByBundle
3030 3031 3032

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

F
fangJinliang1 已提交
3033
设置指定应用是否支持分布式通知(Promise形式)。
3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044

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

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

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

**参数:**

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

**错误码:**

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

3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
F
fangJinliang1 已提交
3063
let bundle = {
3064
    bundle: "bundleName1",
F
fangJinliang1 已提交
3065
};
3066

F
fangJinliang1 已提交
3067
let enable = true
3068

3069 3070 3071
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
    console.info("setDistributedEnableByBundle success");
});
3072 3073
```

3074
## notificationManager.isDistributedEnabledByBundle
3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089

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

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

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

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

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

**参数:**

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

**错误码:**

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

3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107
| 错误码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
3108
function isDistributedEnabledByBundleCallback(err, data) {
3109
    if (err) {
3110
        console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
3111
    } else {
F
fangJinliang1 已提交
3112
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
3113 3114 3115
    }
};

F
fangJinliang1 已提交
3116
let bundle = {
3117
    bundle: "bundleName1",
F
fangJinliang1 已提交
3118
};
3119

3120
notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
3121 3122
```

3123
## notificationManager.isDistributedEnabledByBundle
3124 3125 3126

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

F
fangJinliang1 已提交
3127
查询指定应用是否支持分布式通知(Promise形式)。
3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138

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

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

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

**参数:**

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

**返回值:**

F
fangJinliang1 已提交
3143 3144 3145
| 类型               | 说明                                              |
| ------------------ | ------------------------------------------------- |
| Promise\<boolean\> | Promise方式返回指定应用是否支持分布式通知的结果。 |
3146 3147 3148

**错误码:**

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

3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 1600010  | Distributed operation failed.            |
| 17700001 | The specified bundle name was not found. |

**示例:**

```javascript
F
fangJinliang1 已提交
3162
let bundle = {
3163
    bundle: "bundleName1",
F
fangJinliang1 已提交
3164
};
3165

3166
notificationManager.isDistributedEnabledByBundle(bundle).then((data) => {
F
fangJinliang1 已提交
3167 3168
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
3169 3170 3171
```


3172
## notificationManager.getDeviceRemindType
3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187

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

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

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

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

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

**参数:**

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

**错误码:**

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

3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
function getDeviceRemindTypeCallback(err, data) {
    if (err) {
3205
        console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
3206 3207 3208 3209 3210
    } else {
        console.info("getDeviceRemindType success");
    }
};

3211
notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);
3212 3213
```

3214
## notificationManager.getDeviceRemindType
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229

getDeviceRemindType(): Promise\<DeviceRemindType\>

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

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

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

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

**返回值:**

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

**错误码:**

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

3236 3237 3238 3239 3240 3241 3242 3243 3244
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

```javascript
3245
notificationManager.getDeviceRemindType().then((data) => {
F
fangJinliang1 已提交
3246 3247
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
3248 3249 3250
```


3251
## notificationManager.publishAsBundle
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264

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

**错误码:**

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

3276 3277 3278 3279 3280 3281 3282 3283 3284
| 错误码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. |
3285
| 1600012  | No memory space.                          |
3286 3287 3288

**示例:**

3289
```ts
3290
//publishAsBundle回调
F
fangJinliang1 已提交
3291
function callback(err) {
3292
    if (err) {
3293
        console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
3294 3295 3296 3297 3298
    } else {
        console.info("publishAsBundle success");
    }
}
// 被代理应用的包名
F
fangJinliang1 已提交
3299
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3300
// 用户ID
F
fangJinliang1 已提交
3301
let userId = 100;
F
fangJinliang1 已提交
3302 3303
// NotificationRequest对象
let request = {
3304 3305
    id: 1,
    content: {
3306
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3307 3308 3309 3310 3311 3312
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3313
};
3314

3315
notificationManager.publishAsBundle(request, representativeBundle, userId, callback);
3316 3317
```

3318
## notificationManager.publishAsBundle
3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334

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

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

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

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

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

**参数:**


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

**错误码:**

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

3343 3344 3345 3346 3347 3348 3349 3350 3351
| 错误码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. |
3352
| 1600012  | No memory space.                          |
3353 3354 3355

**示例:**

3356
```ts
3357
// 被代理应用的包名
F
fangJinliang1 已提交
3358
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3359
// 用户ID
F
fangJinliang1 已提交
3360
let userId = 100;
F
fangJinliang1 已提交
3361
// NotificationRequest对象
F
fangJinliang1 已提交
3362
let request = {
3363 3364
    id: 1,
    content: {
3365
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3366 3367 3368 3369 3370 3371
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3372
};
3373

3374
notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
F
fangJinliang1 已提交
3375
	console.info("publishAsBundle success");
3376 3377 3378
});
```

3379
## notificationManager.cancelAsBundle
3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398

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 已提交
3399
| userId               | number        | 是   | 用户ID。       |
3400 3401 3402 3403
| callback             | AsyncCallback | 是   | 取消代理通知的回调方法。 |

**错误码:**

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

3406 3407 3408 3409 3410 3411 3412 3413 3414 3415
| 错误码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.              |

**示例:**

3416
```ts
F
fangJinliang1 已提交
3417
// cancelAsBundle
3418 3419
function cancelAsBundleCallback(err) {
    if (err) {
3420
        console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
3421 3422 3423 3424 3425
    } else {
        console.info("cancelAsBundle success");
    }
}
// 被代理应用的包名
F
fangJinliang1 已提交
3426
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3427
// 用户ID
F
fangJinliang1 已提交
3428
let userId = 100;
3429

3430
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
3431 3432
```

3433
## notificationManager.cancelAsBundle
3434 3435 3436

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

F
fangJinliang1 已提交
3437
取消代理通知(Promise形式)。
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452

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

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

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

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

**参数:**

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

**错误码:**

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

3459 3460 3461 3462 3463 3464 3465 3466 3467 3468
| 错误码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.              |

**示例:**

3469
```ts
3470
// 被代理应用的包名
F
fangJinliang1 已提交
3471
let representativeBundle = "com.example.demo";
F
fangJinliang1 已提交
3472
// 用户ID
F
fangJinliang1 已提交
3473
let userId = 100;
3474

3475
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
3476 3477 3478 3479
	console.info("cancelAsBundle success");
});
```

3480
## notificationManager.setNotificationEnableSlot 
3481 3482 3483

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

F
fangJinliang1 已提交
3484
设置指定应用的指定渠道类型的使能状态(Callback形式)。
3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495

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

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

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

**参数:**

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

**错误码:**

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

3505 3506 3507 3508 3509 3510 3511 3512 3513
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3514
```ts
F
fangJinliang1 已提交
3515
// setNotificationEnableSlot
3516 3517
function setNotificationEnableSlotCallback(err) {
    if (err) {
3518
        console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
3519 3520 3521 3522 3523
    } else {
        console.info("setNotificationEnableSlot success");
    }
};

3524
notificationManager.setNotificationEnableSlot(
3525
    { bundle: "ohos.samples.notification", },
3526
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3527 3528 3529 3530
    true,
    setNotificationEnableSlotCallback);
```

3531
## notificationManager.setNotificationEnableSlot
3532 3533 3534

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

F
fangJinliang1 已提交
3535
设置指定应用的指定渠道类型的使能状态(Promise形式)。
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546

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

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

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

**参数:**

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

**错误码:**

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

3555 3556 3557 3558 3559 3560 3561 3562 3563
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3564
```ts
F
fangJinliang1 已提交
3565
// setNotificationEnableSlot
3566
notificationManager.setNotificationEnableSlot(
3567
    { bundle: "ohos.samples.notification", },
3568
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3569
    true).then(() => {
F
fangJinliang1 已提交
3570
        console.info("setNotificationEnableSlot success");
3571 3572 3573
    });
```

3574
## notificationManager.isNotificationSlotEnabled
3575 3576 3577

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

F
fangJinliang1 已提交
3578
获取指定应用的指定渠道类型的使能状态(Callback形式)。
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589

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

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

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

**参数:**

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

**错误码:**

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

3598 3599 3600 3601 3602 3603 3604 3605 3606
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3607
```ts
F
fangJinliang1 已提交
3608
// isNotificationSlotEnabled
3609 3610
function getEnableSlotCallback(err, data) {
    if (err) {
3611
        console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
3612 3613 3614 3615 3616
    } else {
        console.info("isNotificationSlotEnabled success");
    }
};

3617
notificationManager.isNotificationSlotEnabled(
3618
    { bundle: "ohos.samples.notification", },
3619
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3620 3621 3622
    getEnableSlotCallback);
```

3623
## notificationManager.isNotificationSlotEnabled
3624 3625 3626

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

F
fangJinliang1 已提交
3627
获取指定应用的指定渠道类型的使能状态(Promise形式)。
3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
Y
yuyaozhi 已提交
3639
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。   |
F
fangJinliang1 已提交
3640
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3641 3642 3643 3644 3645 3646 3647 3648 3649

**返回值:**

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

**错误码:**

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

3652 3653 3654 3655 3656 3657 3658 3659 3660
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3661
```ts
F
fangJinliang1 已提交
3662
// isNotificationSlotEnabled
3663 3664
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => {
F
fangJinliang1 已提交
3665 3666
    console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
3667 3668 3669
```


3670
## notificationManager.setSyncNotificationEnabledWithoutApp
3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685

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

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

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

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

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

**参数:** 

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

**错误码:**

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

3694 3695 3696 3697 3698 3699 3700 3701 3702
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3703
```ts
3704 3705 3706
let userId = 100;
let enable = true;

F
fangJinliang1 已提交
3707
function callback(err) {
3708
    if (err) {
3709
        console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
3710 3711 3712 3713 3714
    } else {
        console.info("setSyncNotificationEnabledWithoutApp success");
    }
}

3715
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);
3716 3717 3718
```


3719
## notificationManager.setSyncNotificationEnabledWithoutApp
3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734

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

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

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3735 3736
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
3737 3738 3739 3740 3741 3742 3743 3744 3745

**返回值:**

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

**错误码:**

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

3748 3749 3750 3751 3752 3753 3754 3755 3756
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3757
```ts
3758 3759 3760
let userId = 100;
let enable = true;

3761
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
F
fangJinliang1 已提交
3762 3763
    console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err) => {
3764
    console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
F
fangJinliang1 已提交
3765
});
3766 3767 3768
```


3769
## notificationManager.getSyncNotificationEnabledWithoutApp
3770 3771 3772

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

F
fangJinliang1 已提交
3773
获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。
3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784

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

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

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

**参数:**

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

**错误码:**

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

3792 3793 3794 3795 3796 3797 3798 3799 3800
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3801
```ts
3802 3803
let userId = 100;

Z
zhongjianfei 已提交
3804
function getSyncNotificationEnabledWithoutAppCallback(err, data) {
3805
    if (err) {
F
fangJinliang1 已提交
3806
        console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
3807
    } else {
F
fangJinliang1 已提交
3808
        console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
3809 3810 3811
    }
}

3812
notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);
3813 3814 3815
```


3816
## notificationManager.getSyncNotificationEnabledWithoutApp
3817 3818 3819

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

F
fangJinliang1 已提交
3820
获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
3832
| userId | number | 是   | 用户ID。   |
3833 3834 3835

**返回值:**

F
fangJinliang1 已提交
3836 3837 3838
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 |
3839 3840 3841

**错误码:**

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

3844 3845 3846 3847 3848 3849 3850 3851 3852
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

3853
```ts
3854
let userId = 100;
3855
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => {
F
fangJinliang1 已提交
3856 3857 3858 3859
    console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err) => {
    console.info('getSyncNotificationEnabledWithoutApp, err:' + err);
});
3860 3861
```

3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877
## 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 已提交
3878
| type | string | 是   | 回调函数类型名,固定为'checkNotification'。 |
X
xinking129 已提交
3879
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)    | 是   | 消息验证函数指针。 |
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922

**错误码:**

错误码详细介绍请参考[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){
        return { code: 1, message: "testMsg1"}
    } else {
        return { code: 0, message: "testMsg0"}
    }
}
```

## 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 已提交
3923
| type | string                                                       | 是   | 回调函数类型名,固定为'checkNotification'。 |
X
xinking129 已提交
3924
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)  | 否   | 消息验证函数指针。 |
3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942

**错误码:**

错误码详细介绍请参考[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)}`);
}
```
3943 3944 3945 3946 3947 3948 3949

## DoNotDisturbDate

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

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

3950 3951 3952 3953 3954
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | ---- | ---------------------- |
| type  | [DoNotDisturbType](#donotdisturbtype) | 是   | 免打扰设置的时间类型。 |
| begin | Date                                  | 是   | 免打扰设置的起点时间。 |
| end   | Date                                  | 是   | 免打扰设置的终点时间。 |
3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015

## DoNotDisturbType

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

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

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


## ContentType

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

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

## SlotLevel

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

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


## 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 已提交
4016
| 名称                 | 值  | 说明                               |
4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |


## SourceType

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

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

F
fangJinliang1 已提交
4030
| 名称                 | 值  | 说明                  |
4031 4032 4033 4034
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
| TYPE_TIMER           | 2   | 计划通知。            |
4035 4036 4037 4038 4039 4040 4041 4042 4043

## NotificationCheckInfo<sup>10+</sup>

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

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

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

4044 4045 4046 4047 4048
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | --- | ---------------------- |
| bundleName  | string                          | 是   | bundle名称。 |
| notificationId | number                       | 是   | 通知Id。     |
| contentType   | [ContentType](#contenttype)   | 是   | 通知类型。   |
4049 4050 4051 4052 4053 4054 4055 4056 4057

## NotificationCheckResult<sup>10+</sup>

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

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

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

4058 4059 4060 4061
| 名称    | 类型                                  | 必填 | 说明                   |
| ------- | ------------------------------------ | ---- | ---------------------- |
| code    | number                               | 是   | 0-display, 1-no display。 |
| message | string                               | 是   | 结果信息。    |