js-apis-notificationManager.md 157.5 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
X
xuzhihao 已提交
47 48
import Base from '@ohos.base';

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

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

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

发布通知(Promise形式)。

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

**参数:**

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

**错误码:**

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

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

**示例:**

102
```ts
X
xuzhihao 已提交
103 104
import Base from '@ohos.base';

F
fangJinliang1 已提交
105
// 通知Request对象
106
let notificationRequest: notificationManager.NotificationRequest = {
107
    id: 1,
108
    content: {
109
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
110 111 112 113 114 115
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
116
};
117
notificationManager.publish(notificationRequest).then(() => {
F
fangJinliang1 已提交
118
	console.info("publish success");
X
xuzhihao 已提交
119 120
}).catch((err: Base.BusinessError) => {
    console.error(`publish fail: ${JSON.stringify(err)}`);
121 122 123 124
});

```

125
## notificationManager.publish
126 127 128

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

F
fangJinliang1 已提交
129
发布通知给指定的用户(callback形式)。
130 131 132 133 134 135 136 137 138

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

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

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

**参数:**

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

**错误码:**

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

149 150 151 152 153 154 155 156 157
| 错误码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. |
158
| 1600012  | No memory space.                          |
159 160 161

**示例:**

162
```ts
X
xuzhihao 已提交
163 164
import Base from '@ohos.base';

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

190
## notificationManager.publish
191 192 193

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

F
fangJinliang1 已提交
194
发布通知给指定的用户(Promise形式)。
195 196 197 198 199 200 201 202 203

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

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

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

**参数:**

F
fangJinliang1 已提交
204
| 参数名     |  类型                                        | 必填 | 说明                                        |
205
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
206
| request  | [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
F
fangJinliang1 已提交
207
| userId   | number                                      | 是   | 用户ID。                           |
208 209 210

**错误码:**

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

213 214 215 216 217 218 219 220 221
| 错误码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. |
222
| 1600012  | No memory space.                          |
223 224 225

**示例:**

226
```ts
X
xuzhihao 已提交
227 228
import Base from '@ohos.base';

229
let notificationRequest: notificationManager.NotificationRequest = {
230
    id: 1,
231
    content: {
232
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
233 234 235 236 237 238
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
239
};
240

241
let userId: number = 1;
242

243
notificationManager.publish(notificationRequest, userId).then(() => {
F
fangJinliang1 已提交
244
	console.info("publish success");
X
xuzhihao 已提交
245 246
}).catch((err: Base.BusinessError) => {
    console.error(`publish fail: ${JSON.stringify(err)}`);
247 248 249 250
});
```


251
## notificationManager.cancel
252 253 254

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

F
fangJinliang1 已提交
255
通过通知ID和通知标签取消已发布的通知(callback形式)。
256 257 258 259 260

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

**参数:**

F
fangJinliang1 已提交
261
| 参数名     | 类型                  | 必填 | 说明                 |
262 263 264 265 266 267 268
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| label    | string                | 是   | 通知标签。             |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

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

271 272 273 274 275 276 277 278 279
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

280
```ts
X
xuzhihao 已提交
281 282
import Base from '@ohos.base';

F
fangJinliang1 已提交
283
// cancel回调
X
xuzhihao 已提交
284
let cancelCallback = (err: Base.BusinessError) => {
285
    if (err) {
286
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
287 288 289 290
    } else {
        console.info("cancel success");
    }
}
291
notificationManager.cancel(0, "label", cancelCallback);
292 293
```

294
## notificationManager.cancel
295 296 297

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

F
fangJinliang1 已提交
298
取消与指定通知ID相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
299 300 301 302 303

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

**参数:**

F
fangJinliang1 已提交
304
| 参数名  | 类型   | 必填 | 说明     |
305 306
| ----- | ------ | ---- | -------- |
| id    | number | 是   | 通知ID。   |
W
wangkailong 已提交
307
| label | string | 否   | 通知标签,默认为空。 |
308 309 310

**错误码:**

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

313 314 315 316 317 318 319 320 321
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

322
```ts
X
xuzhihao 已提交
323 324
import Base from '@ohos.base';

325
notificationManager.cancel(0).then(() => {
F
fangJinliang1 已提交
326
	console.info("cancel success");
X
xuzhihao 已提交
327 328
}).catch((err: Base.BusinessError) => {
    console.error(`cancel fail: ${JSON.stringify(err)}`);
329 330 331
});
```

332
## notificationManager.cancel
333 334 335

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

F
fangJinliang1 已提交
336
取消与指定通知ID相匹配的已发布通知(callback形式)。
337 338 339 340 341

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

**参数:**

F
fangJinliang1 已提交
342
| 参数名     | 类型                  | 必填 | 说明                 |
343 344 345 346 347 348
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

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

351 352 353 354 355 356 357 358 359
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600007  | The notification is not exist.      |

**示例:**

360
```ts
X
xuzhihao 已提交
361 362
import Base from '@ohos.base';

F
fangJinliang1 已提交
363
// cancel回调
X
xuzhihao 已提交
364
let cancelCallback = (err: Base.BusinessError) => {
365
    if (err) {
366
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
367 368 369 370
    } else {
        console.info("cancel success");
    }
}
371
notificationManager.cancel(0, cancelCallback);
372 373
```

374
## notificationManager.cancelAll
375 376 377 378 379 380 381 382 383

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

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

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

**错误码:**

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

386 387 388 389 390 391 392 393
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**参数:**

F
fangJinliang1 已提交
394
| 参数名     | 类型                  | 必填 | 说明                 |
395 396 397 398 399
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**示例:**

400
```ts
X
xuzhihao 已提交
401 402
import Base from '@ohos.base';

F
fangJinliang1 已提交
403
// cancel回调
X
xuzhihao 已提交
404
let cancelAllCallback = (err: Base.BusinessError) => {
405
    if (err) {
406
        console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
407 408 409 410
    } else {
        console.info("cancelAll success");
    }
}
411
notificationManager.cancelAll(cancelAllCallback);
412 413
```

414
## notificationManager.cancelAll
415 416 417 418 419 420 421 422 423

cancelAll(): Promise\<void\>

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

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

**错误码:**

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

426 427 428 429 430 431 432 433
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

434
```ts
X
xuzhihao 已提交
435 436
import Base from '@ohos.base';

437
notificationManager.cancelAll().then(() => {
F
fangJinliang1 已提交
438
	console.info("cancelAll success");
X
xuzhihao 已提交
439 440
}).catch((err: Base.BusinessError) => {
    console.error(`cancelAll fail: ${JSON.stringify(err)}`);
441 442 443
});
```

444
## notificationManager.addSlot
445 446 447 448 449 450 451 452 453 454 455 456 457

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
458
| 参数名     | 类型                  | 必填 | 说明                 |
459
| -------- | --------------------- | ---- | -------------------- |
460
| slot     | [NotificationSlot](js-apis-inner-notification-notificationSlot.md)       | 是   | 要创建的通知通道对象。 |
461 462 463 464
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

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

467 468 469 470 471
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
472
| 1600012  | No memory space.                          |
473 474 475

**示例:**

476
```ts
X
xuzhihao 已提交
477 478
import Base from '@ohos.base';

F
fangJinliang1 已提交
479
// addslot回调
X
xuzhihao 已提交
480
let addSlotCallBack = (err: Base.BusinessError) => {
481
    if (err) {
482
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
483 484 485 486
    } else {
        console.info("addSlot success");
    }
}
F
fangJinliang1 已提交
487
// 通知slot对象
488
let notificationSlot: notificationManager.NotificationSlot = {
489
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
490
};
491
notificationManager.addSlot(notificationSlot, addSlotCallBack);
492 493
```

494
## notificationManager.addSlot
495 496 497 498 499 500 501 502 503 504 505 506 507

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
508
| 参数名 | 类型             | 必填 | 说明                 |
509
| ---- | ---------------- | ---- | -------------------- |
510
| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是   | 要创建的通知通道对象。 |
511 512 513

**错误码:**

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

516 517 518 519 520
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
521
| 1600012  | No memory space.                          |
522 523 524

**示例:**

525
```ts
X
xuzhihao 已提交
526 527
import Base from '@ohos.base';

F
fangJinliang1 已提交
528
// 通知slot对象
529
let notificationSlot: notificationManager.NotificationSlot = {
530
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
531
};
532
notificationManager.addSlot(notificationSlot).then(() => {
F
fangJinliang1 已提交
533
	console.info("addSlot success");
X
xuzhihao 已提交
534 535
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
536 537 538
});
```

539
## notificationManager.addSlot
540 541 542

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

F
fangJinliang1 已提交
543
创建指定类型的通知通道(callback形式)。
544 545 546 547 548

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

**参数:**

F
fangJinliang1 已提交
549
| 参数名     | 类型                  | 必填 | 说明                   |
550 551 552 553 554 555
| -------- | --------------------- | ---- | ---------------------- |
| type     | [SlotType](#slottype)              | 是   | 要创建的通知通道的类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。   |

**错误码:**

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

558 559 560 561 562
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
563
| 1600012  | No memory space.                    |
564 565 566

**示例:**

567
```ts
X
xuzhihao 已提交
568 569
import Base from '@ohos.base';

F
fangJinliang1 已提交
570
// addslot回调
X
xuzhihao 已提交
571
let addSlotCallBack = (err: Base.BusinessError) => {
572
    if (err) {
573
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
574 575 576 577
    } else {
        console.info("addSlot success");
    }
}
578
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);
579 580
```

581
## notificationManager.addSlot
582 583 584

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

F
fangJinliang1 已提交
585
创建指定类型的通知通道(Promise形式)。
586 587 588 589 590

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

**参数:**

F
fangJinliang1 已提交
591
| 参数名 | 类型     | 必填 | 说明                   |
592 593 594 595 596
| ---- | -------- | ---- | ---------------------- |
| type | [SlotType](#slottype) | 是   | 要创建的通知通道的类型。 |

**错误码:**

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

599 600 601 602 603
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
604
| 1600012  | No memory space.                    |
605 606 607

**示例:**

608
```ts
X
xuzhihao 已提交
609 610
import Base from '@ohos.base';

611
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
F
fangJinliang1 已提交
612
	console.info("addSlot success");
X
xuzhihao 已提交
613 614
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
615 616 617
});
```

618
## notificationManager.addSlots
619 620 621 622 623 624 625 626 627 628 629 630 631

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

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

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

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

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

**参数:**

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

**错误码:**

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

641 642 643 644 645
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
646
| 1600012  | No memory space.                          |
647 648 649

**示例:**

650
```ts
X
xuzhihao 已提交
651 652
import Base from '@ohos.base';

F
fangJinliang1 已提交
653
// addSlots回调
X
xuzhihao 已提交
654
let addSlotsCallBack = (err: Base.BusinessError) => {
655
    if (err) {
656
        console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
657 658 659 660
    } else {
        console.info("addSlots success");
    }
}
F
fangJinliang1 已提交
661
// 通知slot对象
662
let notificationSlot: notificationManager.NotificationSlot = {
663
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
664
};
F
fangJinliang1 已提交
665
// 通知slot array 对象
666
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
667 668
notificationSlotArray[0] = notificationSlot;

669
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
670 671
```

672
## notificationManager.addSlots
673 674 675 676 677 678 679 680 681 682 683 684 685

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
686
| 参数名  | 类型                      | 必填 | 说明                     |
687
| ----- | ------------------------- | ---- | ------------------------ |
688
| slots | Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\> | 是   | 要创建的通知通道对象数组。 |
689 690 691

**错误码:**

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

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

**示例:**

703
```ts
X
xuzhihao 已提交
704 705
import Base from '@ohos.base';

F
fangJinliang1 已提交
706
// 通知slot对象
707
let notificationSlot: notificationManager.NotificationSlot = {
708
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
709
};
F
fangJinliang1 已提交
710
// 通知slot array 对象
711
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
712 713
notificationSlotArray[0] = notificationSlot;

714
notificationManager.addSlots(notificationSlotArray).then(() => {
F
fangJinliang1 已提交
715
	console.info("addSlots success");
X
xuzhihao 已提交
716 717
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
718 719 720
});
```

721
## notificationManager.getSlot
722 723 724

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

F
fangJinliang1 已提交
725
获取一个指定类型的通知通道(callback形式)。
726 727 728 729 730

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

**参数:**

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

**错误码:**

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

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

**示例:**

748
```ts
X
xuzhihao 已提交
749 750
import Base from '@ohos.base';

F
fangJinliang1 已提交
751
// getSlot回调
X
xuzhihao 已提交
752
let getSlotCallback = (err: Base.BusinessError, data: notificationManager.NotificationSlot) => {
753
    if (err) {
754
        console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
755
    } else {
756
        console.info(`getSlot success, data is ${JSON.stringify(data)}`);
757 758
    }
}
759
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
760
notificationManager.getSlot(slotType, getSlotCallback);
761 762
```

763
## notificationManager.getSlot
764 765 766

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

F
fangJinliang1 已提交
767
获取一个指定类型的通知通道(Promise形式)。
768 769 770 771 772

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

**参数:**

F
fangJinliang1 已提交
773
| 参数名     | 类型     | 必填 | 说明                                                        |
774
| -------- | -------- | ---- | ----------------------------------------------------------- |
F
fangJinliang1 已提交
775
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
776 777 778 779 780 781 782 783 784

**返回值:**

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

**错误码:**

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

787 788 789 790 791 792 793 794
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

795
```ts
X
xuzhihao 已提交
796 797
import Base from '@ohos.base';

798 799 800
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;

notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
X
xuzhihao 已提交
801 802 803
    console.info("getSlot success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getSlot fail: ${JSON.stringify(err)}`);
804 805 806
});
```

807
## notificationManager.getSlots
808

809
getSlots(callback: AsyncCallback\<Array\<NotificationSlot>>): void
810 811 812 813 814 815 816

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

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

**参数:**

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

F
fangJinliang1 已提交
819
| 参数名     | 类型                              | 必填 | 说明                 |
820
| -------- | --------------------------------- | ---- | -------------------- |
821
| callback | AsyncCallback\<Array\<[NotificationSlot](js-apis-inner-notification-notificationSlot.md)\>\> | 是   | 以callback形式返回获取此应用程序的所有通知通道的结果。 |
822 823 824 825 826 827 828 829 830 831 832

**错误码:**

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

**示例:**

833
```ts
X
xuzhihao 已提交
834 835
import Base from '@ohos.base';

F
fangJinliang1 已提交
836
// getSlots回调
X
xuzhihao 已提交
837
let getSlotsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) => {
838 839 840 841 842
  if (err) {
    console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`getSlots success, data is ${JSON.stringify(data)}`);
  }
843
}
844
notificationManager.getSlots(getSlotsCallback);
845 846
```

847
## notificationManager.getSlots
848

849
getSlots(): Promise\<Array\<NotificationSlot>>
850 851 852 853 854 855 856 857 858

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

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

**返回值:**

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

**错误码:**

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

865 866 867 868 869 870 871 872
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

873
```ts
X
xuzhihao 已提交
874 875
import Base from '@ohos.base';

876
notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
F
fangJinliang1 已提交
877
	console.info("getSlots success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
878 879
}).catch((err: Base.BusinessError) => {
    console.error(`getSlots fail: ${JSON.stringify(err)}`);
880 881 882
});
```

883
## notificationManager.removeSlot
884 885 886

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

F
fangJinliang1 已提交
887
删除指定类型的通知通道(callback形式)。
888 889 890 891 892

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

**参数:**

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

**错误码:**

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

902 903 904 905 906 907 908 909
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

910
```ts
X
xuzhihao 已提交
911 912
import Base from '@ohos.base';

F
fangJinliang1 已提交
913
// removeSlot回调
X
xuzhihao 已提交
914
let removeSlotCallback = (err: Base.BusinessError) => {
915 916 917 918 919
  if (err) {
    console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("removeSlot success");
  }
920
}
921
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
922
notificationManager.removeSlot(slotType, removeSlotCallback);
923 924
```

925
## notificationManager.removeSlot
926 927 928

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

F
fangJinliang1 已提交
929
删除指定类型的通知通道(Promise形式)。
930 931 932 933 934

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

**参数:**

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

**错误码:**

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

943 944 945 946 947 948 949 950
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

951
```ts
X
xuzhihao 已提交
952 953
import Base from '@ohos.base';

954
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
955
notificationManager.removeSlot(slotType).then(() => {
F
fangJinliang1 已提交
956
	console.info("removeSlot success");
X
xuzhihao 已提交
957 958
}).catch((err: Base.BusinessError) => {
    console.error(`removeSlot fail: ${JSON.stringify(err)}`);
959 960 961
});
```

962
## notificationManager.removeAllSlots
963 964 965 966 967 968 969 970 971

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

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

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

**参数:**

F
fangJinliang1 已提交
972
| 参数名     | 类型                  | 必填 | 说明                 |
973 974 975 976 977
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |

**错误码:**

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

980 981 982 983 984 985 986 987
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

988
```ts
X
xuzhihao 已提交
989 990 991
import Base from '@ohos.base';

let removeAllCallBack = (err: Base.BusinessError) => {
992
    if (err) {
993
        console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
994 995 996 997
    } else {
        console.info("removeAllSlots success");
    }
}
998
notificationManager.removeAllSlots(removeAllCallBack);
999 1000
```

1001
## notificationManager.removeAllSlots
1002 1003 1004 1005 1006 1007 1008 1009 1010

removeAllSlots(): Promise\<void\>

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

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

**错误码:**

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

1013 1014 1015 1016 1017 1018 1019 1020
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1021
```ts
X
xuzhihao 已提交
1022 1023
import Base from '@ohos.base';

1024
notificationManager.removeAllSlots().then(() => {
F
fangJinliang1 已提交
1025
	console.info("removeAllSlots success");
X
xuzhihao 已提交
1026 1027
}).catch((err: Base.BusinessError) => {
    console.error(`removeAllSlots fail: ${JSON.stringify(err)}`);
1028 1029 1030
});
```

1031
## notificationManager.setNotificationEnable
1032 1033 1034

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

F
fangJinliang1 已提交
1035
设定指定应用的通知使能状态(Callback形式)。
1036 1037 1038 1039 1040 1041 1042 1043 1044

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

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

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

**参数:**

F
fangJinliang1 已提交
1045
| 参数名     | 类型                  | 必填 | 说明                 |
1046
| -------- | --------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
1047
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)   | 是   | 指定应用的包信息。        |
1048 1049 1050 1051 1052
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知使能回调函数。 |

**错误码:**

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

1055 1056 1057 1058 1059 1060 1061 1062 1063
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1064
```ts
X
xuzhihao 已提交
1065 1066 1067
import Base from '@ohos.base';

let setNotificationEnableCallback = (err: Base.BusinessError) => {
1068
    if (err) {
1069
        console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`);
1070
    } else {
1071
        console.info("setNotificationEnableCallback success");
1072 1073
    }
}
1074
let bundle: notificationManager.BundleOption = {
1075
    bundle: "bundleName1",
F
fangJinliang1 已提交
1076
};
1077
notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback);
1078 1079
```

1080
## notificationManager.setNotificationEnable
1081 1082 1083

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

F
fangJinliang1 已提交
1084
设定指定应用的通知使能状态(Promise形式)。
1085 1086 1087 1088 1089 1090 1091 1092 1093

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

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

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

**参数:**

F
fangJinliang1 已提交
1094
| 参数名   | 类型         | 必填 | 说明       |
1095
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1096
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1097 1098 1099 1100
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

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

1103 1104 1105 1106 1107 1108 1109 1110 1111
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1112
```ts
X
xuzhihao 已提交
1113 1114
import Base from '@ohos.base';

1115
let bundle: notificationManager.BundleOption = {
1116
    bundle: "bundleName1",
F
fangJinliang1 已提交
1117
};
1118
notificationManager.setNotificationEnable(bundle, false).then(() => {
F
fangJinliang1 已提交
1119
	console.info("setNotificationEnable success");
X
xuzhihao 已提交
1120 1121
}).catch((err: Base.BusinessError) => {
    console.error(`setNotificationEnable fail: ${JSON.stringify(err)}`);
1122 1123 1124
});
```

1125
## notificationManager.isNotificationEnabled
1126 1127 1128

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

F
fangJinliang1 已提交
1129
获取指定应用的通知使能状态(Callback形式)。
1130 1131 1132 1133 1134 1135 1136 1137 1138

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

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

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

**参数:**

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

**错误码:**

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

1148 1149 1150 1151 1152 1153 1154 1155 1156
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1157
```ts
X
xuzhihao 已提交
1158 1159 1160
import Base from '@ohos.base';

let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean) => {
1161
    if (err) {
1162
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
1163
    } else {
1164
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
1165 1166
    }
}
1167 1168

let bundle: notificationManager.BundleOption = {
1169
    bundle: "bundleName1",
F
fangJinliang1 已提交
1170
};
1171

1172
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
1173 1174
```

1175
## notificationManager.isNotificationEnabled
1176 1177 1178

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

F
fangJinliang1 已提交
1179
获取指定应用的通知使能状态(Promise形式)。
1180 1181 1182 1183 1184 1185 1186 1187 1188

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

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

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

**参数:**

F
fangJinliang1 已提交
1189
| 参数名   | 类型         | 必填 | 说明       |
1190
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1191
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1192 1193 1194

**返回值:**

F
fangJinliang1 已提交
1195 1196 1197
| 类型               | 说明                                                |
| ------------------ | --------------------------------------------------- |
| Promise\<boolean\> | 以Promise形式返回获取指定应用的通知使能状态的结果。 |
1198 1199 1200

**错误码:**

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

1203 1204 1205 1206 1207 1208 1209 1210 1211
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1212
```ts
X
xuzhihao 已提交
1213 1214
import Base from '@ohos.base';

1215
let bundle: notificationManager.BundleOption = {
1216
    bundle: "bundleName1",
F
fangJinliang1 已提交
1217
};
1218
notificationManager.isNotificationEnabled(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
1219
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1220 1221
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
1222 1223 1224
});
```

1225
## notificationManager.isNotificationEnabled
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
1239
| 参数名     | 类型                  | 必填 | 说明                     |
1240
| -------- | --------------------- | ---- | ------------------------ |
1241
| callback | AsyncCallback\<boolean\> | 是   | 获取通知使能状态回调函数。 |
1242 1243 1244

**错误码:**

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

1247 1248 1249 1250 1251 1252 1253 1254
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

1255
```ts
X
xuzhihao 已提交
1256 1257 1258
import Base from '@ohos.base';

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

1266
notificationManager.isNotificationEnabled(isNotificationEnabledCallback);
1267 1268
```

1269
## notificationManager.isNotificationEnabled
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280

isNotificationEnabled(): Promise\<boolean\>

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

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

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

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

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
**返回值:**

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

**错误码:**

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

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

**示例:**

```ts
X
xuzhihao 已提交
1300 1301
import Base from '@ohos.base';

1302
notificationManager.isNotificationEnabled().then((data: boolean) => {
1303
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1304 1305
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
});
```

## 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
X
xuzhihao 已提交
1342 1343 1344
import Base from '@ohos.base';

let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean) => {
1345 1346 1347
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
1348
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
1349 1350 1351
    }
}

1352
let userId: number = 1;
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368

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

## notificationManager.isNotificationEnabled

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

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

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

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

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

1369 1370
**参数:**

F
fangJinliang1 已提交
1371
| 参数名   | 类型         | 必填 | 说明       |
1372
| ------ | ------------ | ---- | ---------- |
1373
| userId | number       | 是   | 指定的用户ID。 |
1374 1375 1376 1377 1378 1379 1380 1381 1382

**返回值:**

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

**错误码:**

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

1385 1386 1387 1388 1389
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
1390
| 1600008  | The user is not exist..                  |
1391 1392 1393

**示例:**

1394
```ts
X
xuzhihao 已提交
1395 1396
import Base from '@ohos.base';

1397
let userId: number = 1;
1398

1399
notificationManager.isNotificationEnabled(userId).then((data: boolean) => {
F
fangJinliang1 已提交
1400
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1401 1402
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
1403 1404 1405
});
```

1406
## notificationManager.displayBadge
1407 1408 1409

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

F
fangJinliang1 已提交
1410
设定指定应用的角标使能状态(Callback形式)。
1411 1412 1413 1414 1415 1416 1417 1418 1419

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

1439
```ts
X
xuzhihao 已提交
1440 1441 1442
import Base from '@ohos.base';

let displayBadgeCallback = (err: Base.BusinessError) => {
1443
    if (err) {
1444
        console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
1445 1446 1447 1448
    } else {
        console.info("displayBadge success");
    }
}
1449
let bundle: notificationManager.BundleOption = {
1450
    bundle: "bundleName1",
F
fangJinliang1 已提交
1451
};
1452
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
1453 1454
```

1455
## notificationManager.displayBadge
1456 1457 1458

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

F
fangJinliang1 已提交
1459
设定指定应用的角标使能状态(Promise形式)。
1460 1461 1462 1463 1464 1465 1466 1467 1468

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

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

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

**参数:**

F
fangJinliang1 已提交
1469
| 参数名   | 类型         | 必填 | 说明       |
1470
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1471
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1472 1473 1474 1475
| enable | boolean      | 是   | 使能状态。   |

**错误码:**

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

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

**示例:**

1487
```ts
X
xuzhihao 已提交
1488 1489
import Base from '@ohos.base';

1490
let bundle: notificationManager.BundleOption = {
1491
    bundle: "bundleName1",
F
fangJinliang1 已提交
1492
};
1493
notificationManager.displayBadge(bundle, false).then(() => {
F
fangJinliang1 已提交
1494
	console.info("displayBadge success");
X
xuzhihao 已提交
1495 1496
}).catch((err: Base.BusinessError) => {
    console.error(`displayBadge fail: ${JSON.stringify(err)}`);
1497 1498 1499
});
```

1500
## notificationManager.isBadgeDisplayed
1501 1502 1503

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

F
fangJinliang1 已提交
1504
获取指定应用的角标使能状态(Callback形式)。
1505 1506 1507 1508 1509 1510 1511 1512 1513

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

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

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

**参数:**

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

**错误码:**

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

1523 1524 1525 1526 1527 1528 1529 1530 1531
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1532
```ts
X
xuzhihao 已提交
1533 1534 1535
import Base from '@ohos.base';

let isBadgeDisplayedCallback = (err: Base.BusinessError, data: boolean) => {
1536
    if (err) {
1537
        console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
1538
    } else {
1539
        console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`);
1540 1541
    }
}
1542
let bundle: notificationManager.BundleOption = {
1543
    bundle: "bundleName1",
F
fangJinliang1 已提交
1544
};
1545
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
1546 1547
```

1548
## notificationManager.isBadgeDisplayed
1549 1550 1551

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

F
fangJinliang1 已提交
1552
获取指定应用的角标使能状态(Promise形式)。
1553 1554 1555 1556 1557 1558 1559 1560 1561

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

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

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

**参数:**

F
fangJinliang1 已提交
1562
| 参数名   | 类型         | 必填 | 说明       |
1563
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1564
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1565 1566 1567 1568 1569

**返回值:**

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

**错误码:**

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

1576 1577 1578 1579 1580 1581 1582 1583 1584
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1585
```ts
X
xuzhihao 已提交
1586 1587
import Base from '@ohos.base';

1588 1589
let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
F
fangJinliang1 已提交
1590
};
1591 1592

notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
1593
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1594 1595
}).catch((err: Base.BusinessError) => {
    console.error(`isBadgeDisplayed fail: ${JSON.stringify(err)}`);
1596 1597 1598
});
```

F
fangJinliang1 已提交
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
## 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.          |
1620
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1621 1622 1623 1624

**示例:**

```ts
X
xuzhihao 已提交
1625 1626
import Base from '@ohos.base';

1627 1628
let badgeNumber: number = 10;

F
fangJinliang1 已提交
1629 1630
notificationManager.setBadgeNumber(badgeNumber).then(() => {
	console.info("displayBadge success");
X
xuzhihao 已提交
1631 1632
}).catch((err: Base.BusinessError) => {
    console.error(`displayBadge fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
});
```

## 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.          |
1660
| 1600012  | No memory space.                          |
F
fangJinliang1 已提交
1661 1662 1663 1664

**示例:**

```ts
X
xuzhihao 已提交
1665 1666 1667
import Base from '@ohos.base';

let setBadgeNumberCallback = (err: Base.BusinessError) => {
F
fangJinliang1 已提交
1668 1669 1670 1671 1672 1673 1674
    if (err) {
        console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("displayBadge success");
    }
}

1675
let badgeNumber: number = 10;
F
fangJinliang1 已提交
1676 1677 1678
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
```

1679
## notificationManager.setSlotByBundle
1680 1681 1682

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

F
fangJinliang1 已提交
1683
设定指定应用的通知通道(Callback形式)。
1684 1685 1686 1687 1688 1689 1690 1691 1692

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

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

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

**参数:**

F
fangJinliang1 已提交
1693
| 参数名     | 类型                  | 必填 | 说明                 |
1694
| -------- | --------------------- | ---- | -------------------- |
Y
yuyaozhi 已提交
1695
| bundle   | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 指定应用的包信息。           |
1696
| slot     | [NotificationSlot](js-apis-inner-notification-notificationSlot.md)      | 是   | 通知通道。             |
1697 1698 1699 1700
| callback | AsyncCallback\<void\> | 是   | 设定通知通道回调函数。 |

**错误码:**

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

1703 1704 1705 1706 1707 1708 1709 1710 1711
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1712
```ts
X
xuzhihao 已提交
1713 1714 1715
import Base from '@ohos.base';

let setSlotByBundleCallback = (err: Base.BusinessError) => {
1716
    if (err) {
1717
        console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1718 1719 1720 1721
    } else {
        console.info("setSlotByBundle success");
    }
}
1722
let bundle: notificationManager.BundleOption = {
1723
    bundle: "bundleName1",
F
fangJinliang1 已提交
1724
};
1725
let notificationSlot: notificationManager.NotificationSlot = {
1726
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1727
};
1728
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
1729 1730
```

1731
## notificationManager.setSlotByBundle
1732 1733 1734

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

F
fangJinliang1 已提交
1735
设定指定应用的通知通道(Promise形式)。
1736 1737 1738 1739 1740 1741 1742 1743 1744

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

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

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

**参数:**

F
fangJinliang1 已提交
1745
| 参数名   | 类型         | 必填 | 说明       |
1746
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1747
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1748
| slot   | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是   | 通知通道。 |
1749 1750 1751

**错误码:**

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

1754 1755 1756 1757 1758 1759 1760 1761 1762
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1763
```ts
X
xuzhihao 已提交
1764 1765
import Base from '@ohos.base';

1766
let bundle: notificationManager.BundleOption = {
1767
    bundle: "bundleName1",
F
fangJinliang1 已提交
1768
};
1769 1770

let notificationSlot: notificationManager.NotificationSlot = {
1771
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1772
};
1773

1774
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
F
fangJinliang1 已提交
1775
	console.info("setSlotByBundle success");
X
xuzhihao 已提交
1776 1777
}).catch((err: Base.BusinessError) => {
    console.error(`setSlotByBundle fail: ${JSON.stringify(err)}`);
1778 1779 1780
});
```

1781
## notificationManager.getSlotsByBundle
1782

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

F
fangJinliang1 已提交
1785
获取指定应用的所有通知通道(Callback形式)。
1786 1787 1788 1789 1790 1791 1792 1793 1794

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

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

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

**参数:**

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

**错误码:**

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

1804 1805 1806 1807 1808 1809 1810 1811 1812
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1813
```ts
X
xuzhihao 已提交
1814 1815 1816
import Base from '@ohos.base';

let getSlotsByBundleCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>) => {
1817
    if (err) {
1818
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1819
    } else {
1820
        console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`);
1821 1822
    }
}
1823
let bundle: notificationManager.BundleOption = {
1824
    bundle: "bundleName1",
F
fangJinliang1 已提交
1825
};
1826
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
1827 1828
```

1829
## notificationManager.getSlotsByBundle
1830

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

F
fangJinliang1 已提交
1833
获取指定应用的所有通知通道(Promise形式)。
1834 1835 1836 1837 1838 1839 1840 1841 1842

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

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

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

**参数:**

F
fangJinliang1 已提交
1843
| 参数名   | 类型         | 必填 | 说明       |
1844
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1845
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1846 1847 1848 1849 1850

**返回值:**

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

**错误码:**

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

1857 1858 1859 1860 1861 1862 1863 1864 1865
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1866
```ts
X
xuzhihao 已提交
1867 1868
import Base from '@ohos.base';

1869
let bundle: notificationManager.BundleOption = {
1870
    bundle: "bundleName1",
F
fangJinliang1 已提交
1871
};
1872 1873

notificationManager.getSlotsByBundle(bundle).then((data: Array<notificationManager.NotificationSlot>) => {
F
fangJinliang1 已提交
1874
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1875 1876
}).catch((err: Base.BusinessError) => {
    console.error(`getSlotsByBundle fail: ${JSON.stringify(err)}`);
1877 1878 1879
});
```

1880
## notificationManager.getSlotNumByBundle
1881 1882 1883

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

F
fangJinliang1 已提交
1884
获取指定应用的通知通道数量(Callback形式)。
1885 1886 1887 1888 1889 1890 1891 1892 1893

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

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

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

**参数:**

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

**错误码:**

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

1903 1904 1905 1906 1907 1908 1909 1910 1911
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1912
```ts
X
xuzhihao 已提交
1913 1914 1915
import Base from '@ohos.base';

let getSlotNumByBundleCallback = (err: Base.BusinessError, data: number) => {
1916
    if (err) {
1917
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
1918
    } else {
1919
        console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`);
1920 1921
    }
}
1922 1923 1924

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

1927
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
1928 1929
```

1930
## notificationManager.getSlotNumByBundle
1931 1932 1933

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

F
fangJinliang1 已提交
1934
获取指定应用的通知通道数量(Promise形式)。
1935 1936 1937 1938 1939 1940 1941 1942 1943

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

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

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

**参数:**

F
fangJinliang1 已提交
1944
| 参数名   | 类型         | 必填 | 说明       |
1945
| ------ | ------------ | ---- | ---------- |
Y
yuyaozhi 已提交
1946
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 指定应用的包信息。 |
1947 1948 1949 1950 1951

**返回值:**

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

**错误码:**

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

1958 1959 1960 1961 1962 1963 1964 1965 1966
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

1967
```ts
X
xuzhihao 已提交
1968 1969
import Base from '@ohos.base';

1970 1971
let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
F
fangJinliang1 已提交
1972
};
1973 1974

notificationManager.getSlotNumByBundle(bundle).then((data: number) => {
F
fangJinliang1 已提交
1975
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
1976 1977
}).catch((err: Base.BusinessError) => {
    console.error(`getSlotsByBundle fail: ${JSON.stringify(err)}`);
1978 1979 1980 1981
});
```


1982
## notificationManager.getAllActiveNotifications
1983

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

F
fangJinliang1 已提交
1986
获取当前未删除的所有通知(Callback形式)。
1987 1988 1989 1990 1991 1992 1993 1994 1995

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

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

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

**参数:**

F
fangJinliang1 已提交
1996
| 参数名     | 类型                                                         | 必填 | 说明                 |
1997
| -------- | ------------------------------------------------------------ | ---- | -------------------- |
1998
| callback | AsyncCallback\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)>> | 是   | 获取活动通知回调函数。 |
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009

**错误码:**

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

**示例:**

2010
```ts
X
xuzhihao 已提交
2011 2012 2013
import Base from '@ohos.base';

let getAllActiveNotificationsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) => {
2014
    if (err) {
2015
        console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
2016
    } else {
2017
        console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`);
2018 2019 2020
    }
}

2021
notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);
2022 2023
```

2024
## notificationManager.getAllActiveNotifications
2025

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

F
fangJinliang1 已提交
2028
获取当前未删除的所有通知(Promise形式)。
2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039

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

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

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

**返回值:**

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

**错误码:**

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

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

**示例:**

2054
```ts
X
xuzhihao 已提交
2055 2056
import Base from '@ohos.base';

2057
notificationManager.getAllActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
F
fangJinliang1 已提交
2058
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2059 2060
}).catch((err: Base.BusinessError) => {
    console.error(`getAllActiveNotifications fail: ${JSON.stringify(err)}`);
2061 2062 2063
});
```

2064
## notificationManager.getActiveNotificationCount
2065 2066 2067

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

F
fangJinliang1 已提交
2068
获取当前应用未删除的通知数(Callback形式)。
2069 2070 2071 2072 2073

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

**参数:**

F
fangJinliang1 已提交
2074
| 参数名     | 类型                   | 必填 | 说明                   |
2075
| -------- | ---------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
2076
| callback | AsyncCallback\<number\> | 是   | 获取未删除通知数回调函数。 |
2077 2078 2079

**错误码:**

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

2082 2083 2084 2085 2086 2087 2088 2089
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2090
```ts
X
xuzhihao 已提交
2091 2092 2093
import Base from '@ohos.base';

let getActiveNotificationCountCallback = (err: Base.BusinessError, data: number) => {
2094
    if (err) {
2095
        console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
2096
    } else {
2097
        console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`);
2098 2099 2100
    }
}

2101
notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);
2102 2103
```

2104
## notificationManager.getActiveNotificationCount
2105 2106 2107

getActiveNotificationCount(): Promise\<number\>

F
fangJinliang1 已提交
2108
获取当前应用未删除的通知数(Promise形式)。
2109 2110 2111 2112 2113

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

**返回值:**

F
fangJinliang1 已提交
2114 2115 2116
| 类型              | 说明                                        |
| ----------------- | ------------------------------------------- |
| Promise\<number\> | 以Promise形式返回获取当前应用未删除通知数。 |
2117 2118 2119

**错误码:**

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

2122 2123 2124 2125 2126 2127 2128 2129
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2130
```ts
X
xuzhihao 已提交
2131 2132
import Base from '@ohos.base';

2133
notificationManager.getActiveNotificationCount().then((data: number) => {
F
fangJinliang1 已提交
2134
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2135 2136
}).catch((err: Base.BusinessError) => {
    console.error(`getActiveNotificationCount fail: ${JSON.stringify(err)}`);
2137 2138 2139
});
```

2140
## notificationManager.getActiveNotifications
2141

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

F
fangJinliang1 已提交
2144
获取当前应用未删除的通知列表(Callback形式)。
2145 2146 2147 2148 2149

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

**参数:**

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

**错误码:**

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

2158 2159 2160 2161 2162 2163 2164 2165
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2166
```ts
X
xuzhihao 已提交
2167 2168 2169
import Base from '@ohos.base';

let getActiveNotificationsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>) => {
2170
    if (err) {
2171
        console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
2172 2173 2174 2175 2176
    } else {
        console.info("getActiveNotifications success");
    }
}

2177
notificationManager.getActiveNotifications(getActiveNotificationsCallback);
2178 2179
```

2180
## notificationManager.getActiveNotifications
2181

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

F
fangJinliang1 已提交
2184
获取当前应用未删除的通知列表(Promise形式)。
2185 2186 2187 2188 2189

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

**返回值:**

F
fangJinliang1 已提交
2190 2191
| 类型                                                         | 说明                                    |
| ------------------------------------------------------------ | --------------------------------------- |
2192
| Promise\<Array\<[NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest)\>\> | 以Promise形式返回获取当前应用通知列表。 |
2193 2194 2195

**错误码:**

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

2198 2199 2200 2201 2202 2203 2204 2205
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2206
```ts
X
xuzhihao 已提交
2207 2208
import Base from '@ohos.base';

2209
notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
F
fangJinliang1 已提交
2210
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2211 2212
}).catch((err: Base.BusinessError) => {
    console.error(`getActiveNotificationCount fail: ${JSON.stringify(err)}`);
2213 2214 2215
});
```

2216
## notificationManager.cancelGroup
2217 2218 2219

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

F
fangJinliang1 已提交
2220
取消本应用指定组下的通知(Callback形式)。
2221 2222 2223 2224 2225

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

**参数:**

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

**错误码:**

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

2235 2236 2237 2238 2239 2240 2241 2242
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2243
```ts
X
xuzhihao 已提交
2244 2245 2246
import Base from '@ohos.base';

let cancelGroupCallback = (err: Base.BusinessError) => {
2247
    if (err) {
2248
        console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
2249 2250 2251 2252 2253
    } else {
        console.info("cancelGroup success");
    }
}

2254
let groupName: string = "GroupName";
2255

2256
notificationManager.cancelGroup(groupName, cancelGroupCallback);
2257 2258
```

2259
## notificationManager.cancelGroup
2260 2261 2262

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

F
fangJinliang1 已提交
2263
取消本应用指定组下的通知(Promise形式)。
2264 2265 2266 2267 2268

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

**参数:**

F
fangJinliang1 已提交
2269
| 参数名      | 类型   | 必填 | 说明           |
2270
| --------- | ------ | ---- | -------------- |
F
fangJinliang1 已提交
2271
| groupName | string | 是   | 通知组名称。 |
2272 2273 2274

**错误码:**

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

2277 2278 2279 2280 2281 2282 2283 2284
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

2285
```ts
X
xuzhihao 已提交
2286 2287
import Base from '@ohos.base';

2288
let groupName: string = "GroupName";
2289
notificationManager.cancelGroup(groupName).then(() => {
F
fangJinliang1 已提交
2290
	console.info("cancelGroup success");
X
xuzhihao 已提交
2291 2292
}).catch((err: Base.BusinessError) => {
    console.error(`cancelGroup fail: ${JSON.stringify(err)}`);
2293 2294 2295
});
```

2296
## notificationManager.removeGroupByBundle
2297 2298 2299

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

F
fangJinliang1 已提交
2300
删除指定应用的指定组下的通知(Callback形式)。
2301 2302 2303 2304 2305 2306 2307 2308 2309

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

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

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

**参数:**

F
fangJinliang1 已提交
2310
| 参数名      | 类型                  | 必填 | 说明                         |
2311
| --------- | --------------------- | ---- | ---------------------------- |
Y
yuyaozhi 已提交
2312
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption)          | 是   | 应用的包信息。                   |
F
fangJinliang1 已提交
2313 2314
| groupName | string                | 是   | 通知组名称。               |
| callback  | AsyncCallback\<void\> | 是   | 删除指定应用指定组下通知的回调函数。 |
2315 2316 2317

**错误码:**

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

2320 2321 2322 2323 2324 2325 2326 2327 2328
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2329
```ts
X
xuzhihao 已提交
2330 2331 2332
import Base from '@ohos.base';

let removeGroupByBundleCallback = (err: Base.BusinessError) => {
2333
    if (err) {
2334
        console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
2335 2336 2337 2338 2339
    } else {
        console.info("removeGroupByBundle success");
    }
}

2340 2341
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";
2342

2343
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
2344 2345
```

2346
## notificationManager.removeGroupByBundle
2347 2348 2349

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

F
fangJinliang1 已提交
2350
删除指定应用的指定组下的通知(Promise形式)。
2351 2352 2353 2354 2355 2356 2357 2358 2359

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

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

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

**参数:**

F
fangJinliang1 已提交
2360
| 参数名      | 类型         | 必填 | 说明           |
2361
| --------- | ------------ | ---- | -------------- |
Y
yuyaozhi 已提交
2362
| bundle    | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。     |
F
fangJinliang1 已提交
2363
| groupName | string       | 是   | 通知组名称。 |
2364 2365 2366

**错误码:**

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

2369 2370 2371 2372 2373 2374 2375 2376 2377
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

2378
```ts
X
xuzhihao 已提交
2379 2380
import Base from '@ohos.base';

2381 2382 2383
let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";

2384
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
F
fangJinliang1 已提交
2385
	console.info("removeGroupByBundle success");
X
xuzhihao 已提交
2386 2387
}).catch((err: Base.BusinessError) => {
    console.error(`removeGroupByBundle fail: ${JSON.stringify(err)}`);
2388 2389 2390
});
```

2391
## notificationManager.setDoNotDisturbDate
2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2405
| 参数名     | 类型                  | 必填 | 说明                   |
2406 2407 2408 2409 2410 2411
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

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

2414 2415 2416 2417 2418
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2419
| 1600012  | No memory space.                          |
2420 2421 2422

**示例:**

2423
```ts
X
xuzhihao 已提交
2424 2425 2426
import Base from '@ohos.base';

let setDoNotDisturbDateCallback = (err: Base.BusinessError) => {
2427
    if (err) {
2428
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2429 2430 2431 2432 2433
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

2434
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2435
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2436 2437
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2438
};
2439

2440
notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
2441 2442
```

2443
## notificationManager.setDoNotDisturbDate
2444 2445 2446

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

F
fangJinliang1 已提交
2447
设置免打扰时间(Promise形式)。
2448 2449 2450 2451 2452 2453 2454 2455 2456

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

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

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

**参数:**

F
fangJinliang1 已提交
2457
| 参数名 | 类型             | 必填 | 说明           |
2458 2459 2460 2461 2462
| ---- | ---------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |

**错误码:**

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

2465 2466 2467 2468 2469
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2470
| 1600012  | No memory space.                          |
2471 2472 2473

**示例:**

2474
```ts
X
xuzhihao 已提交
2475 2476
import Base from '@ohos.base';

2477
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2478
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2479 2480
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2481
};
2482
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
F
fangJinliang1 已提交
2483
	console.info("setDoNotDisturbDate success");
X
xuzhihao 已提交
2484 2485
}).catch((err: Base.BusinessError) => {
    console.error(`setDoNotDisturbDate fail: ${JSON.stringify(err)}`);
2486 2487 2488 2489
});
```


2490
## notificationManager.setDoNotDisturbDate
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503

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

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

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

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

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

**参数:**

F
fangJinliang1 已提交
2504
| 参数名     | 类型                  | 必填 | 说明                   |
2505 2506
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate)      | 是   | 免打扰时间选项。         |
F
fangJinliang1 已提交
2507
| userId   | number                | 是   | 设置免打扰时间的用户ID。 |
2508 2509 2510 2511
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**错误码:**

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

2514 2515 2516 2517 2518 2519
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2520
| 1600012  | No memory space.                          |
2521 2522 2523

**示例:**

2524
```ts
X
xuzhihao 已提交
2525 2526 2527
import Base from '@ohos.base';

let setDoNotDisturbDateCallback = (err: Base.BusinessError) => {
2528
    if (err) {
2529
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2530 2531 2532 2533 2534
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

2535
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2536
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2537 2538
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2539
};
2540

2541
let userId: number = 1;
2542

2543
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
2544 2545
```

2546
## notificationManager.setDoNotDisturbDate
2547 2548 2549

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

F
fangJinliang1 已提交
2550
指定用户设置免打扰时间(Promise形式)。
2551 2552 2553 2554 2555 2556 2557 2558 2559

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

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

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

**参数:**

F
fangJinliang1 已提交
2560
| 参数名   | 类型             | 必填 | 说明           |
2561 2562
| ------ | ---------------- | ---- | -------------- |
| date   | [DoNotDisturbDate](#donotdisturbdate) | 是   | 免打扰时间选项。 |
F
fangJinliang1 已提交
2563
| userId | number           | 是   | 设置免打扰时间的用户ID。 |
2564 2565 2566

**错误码:**

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

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

**示例:**

2579
```ts
X
xuzhihao 已提交
2580 2581
import Base from '@ohos.base';

2582
let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
2583
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
2584 2585
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2586
};
2587

2588
let userId: number = 1;
2589

2590
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
F
fangJinliang1 已提交
2591
	console.info("setDoNotDisturbDate success");
X
xuzhihao 已提交
2592 2593
}).catch((err: Base.BusinessError) => {
    console.error(`setDoNotDisturbDate fail: ${JSON.stringify(err)}`);
2594 2595 2596 2597
});
```


2598
## notificationManager.getDoNotDisturbDate
2599 2600 2601

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

F
fangJinliang1 已提交
2602
查询免打扰时间(Callback形式)。
2603 2604 2605 2606 2607 2608 2609 2610 2611

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

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

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

**参数:**

F
fangJinliang1 已提交
2612
| 参数名     | 类型                              | 必填 | 说明                   |
2613 2614 2615 2616 2617
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |

**错误码:**

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

2620 2621 2622 2623 2624
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
2625
| 1600012  | No memory space.                          |
2626 2627 2628

**示例:**

2629
```ts
X
xuzhihao 已提交
2630 2631 2632
import Base from '@ohos.base';

let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) => {
2633
    if (err) {
2634
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2635
    } else {
2636
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
2637 2638 2639
    }
}

2640
notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);
2641 2642
```

2643
## notificationManager.getDoNotDisturbDate
2644 2645 2646

getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>

F
fangJinliang1 已提交
2647
查询免打扰时间(Promise形式)。
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658

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

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

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

**返回值:**

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

**错误码:**

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

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

**示例:**

2674
```ts
X
xuzhihao 已提交
2675 2676
import Base from '@ohos.base';

2677 2678
notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => {
  console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2679 2680
}).catch((err: Base.BusinessError) => {
    console.error(`getDoNotDisturbDate fail: ${JSON.stringify(err)}`);
2681 2682 2683 2684
});
```


2685
## notificationManager.getDoNotDisturbDate
2686 2687 2688

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

F
fangJinliang1 已提交
2689
查询指定用户的免打扰时间(Callback形式)。
2690 2691 2692 2693 2694 2695 2696 2697 2698

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

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

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

**参数:**

F
fangJinliang1 已提交
2699
| 参数名     | 类型                              | 必填 | 说明                   |
2700 2701
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate)\> | 是   | 查询免打扰时间回调函数。 |
F
fangJinliang1 已提交
2702
| userId   | number                            | 是   | 用户ID。 |
2703 2704 2705

**错误码:**

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

2708 2709 2710 2711 2712 2713
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2714
| 1600012  | No memory space.                          |
2715 2716 2717

**示例:**

2718
```ts
X
xuzhihao 已提交
2719 2720 2721
import Base from '@ohos.base';

let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: notificationManager.DoNotDisturbDate) => {
2722
    if (err) {
2723
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
2724
    } else {
2725
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
2726 2727 2728
    }
}

2729
let userId: number = 1;
2730

2731
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
2732 2733
```

2734
## notificationManager.getDoNotDisturbDate
2735 2736 2737

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

F
fangJinliang1 已提交
2738
查询指定用户的免打扰时间(Promise形式)。
2739 2740 2741 2742 2743 2744 2745 2746 2747

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

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

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

**参数:**

F
fangJinliang1 已提交
2748
| 参数名     | 类型                              | 必填 | 说明                   |
2749
| -------- | --------------------------------- | ---- | ---------------------- |
F
fangJinliang1 已提交
2750
| userId   | number                            | 是   | 用户ID。 |
2751 2752 2753 2754 2755

**返回值:**

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

**错误码:**

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

2762 2763 2764 2765 2766 2767
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |
2768
| 1600012  | No memory space.                          |
2769 2770 2771

**示例:**

2772
```ts
X
xuzhihao 已提交
2773 2774
import Base from '@ohos.base';

2775
let userId: number = 1;
2776

2777
notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => {
F
fangJinliang1 已提交
2778
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2779 2780
}).catch((err: Base.BusinessError) => {
    console.error(`getDoNotDisturbDate fail: ${JSON.stringify(err)}`);
2781 2782 2783 2784
});
```


F
fangJinliang1 已提交
2785
## notificationManager.isSupportDoNotDisturbMode
2786

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

F
fangJinliang1 已提交
2789
查询是否支持免打扰功能(Callback形式)。
2790 2791 2792 2793 2794 2795 2796 2797 2798

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

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

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

**参数:**

F
fangJinliang1 已提交
2799
| 参数名     | 类型                     | 必填 | 说明                             |
2800
| -------- | ------------------------ | ---- | -------------------------------- |
F
fangJinliang1 已提交
2801
| callback | AsyncCallback\<boolean\> | 是   | 查询是否支持免打扰功能回调函数。 |
2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812

**错误码:**

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

**示例:**

2813
```ts
X
xuzhihao 已提交
2814 2815 2816
import Base from '@ohos.base';

let isSupportDoNotDisturbModeCallback = (err: Base.BusinessError, data: boolean) => {
2817
    if (err) {
2818
        console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
2819
    } else {
F
fangJinliang1 已提交
2820
        console.info("isSupportDoNotDisturbMode success");
2821 2822 2823
    }
}

F
fangJinliang1 已提交
2824
notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);
2825 2826
```

F
fangJinliang1 已提交
2827
## notificationManager.isSupportDoNotDisturbMode
2828

F
fangJinliang1 已提交
2829
isSupportDoNotDisturbMode(): Promise\<boolean\>
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842

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

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

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

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

**返回值:**

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

**错误码:**

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

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

**示例:**

2857
```ts
X
xuzhihao 已提交
2858 2859
import Base from '@ohos.base';

2860
notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => {
F
fangJinliang1 已提交
2861
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2862 2863
}).catch((err: Base.BusinessError) => {
    console.error(`supportDoNotDisturbMode fail: ${JSON.stringify(err)}`);
2864 2865 2866
});
```

2867
## notificationManager.isSupportTemplate
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883

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

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

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

**参数:**

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

**错误码:**

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

2886 2887 2888 2889 2890 2891 2892 2893
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

X
xuzhihao 已提交
2894 2895 2896
```ts
import Base from '@ohos.base';

2897
let templateName: string = 'process';
X
xuzhihao 已提交
2898
let isSupportTemplateCallback = (err: Base.BusinessError, data: boolean) => {
2899
    if (err) {
2900
        console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
2901 2902 2903 2904 2905
    } else {
        console.info("isSupportTemplate success");
    }
}

2906
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);
2907 2908
```

2909
## notificationManager.isSupportTemplate
2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

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

2933 2934 2935 2936 2937 2938 2939 2940
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

X
xuzhihao 已提交
2941 2942 2943
```ts
import Base from '@ohos.base';

2944
let templateName: string = 'process';
2945

2946
notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
2947
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
2948 2949
}).catch((err: Base.BusinessError) => {
    console.error(`isSupportTemplate fail: ${JSON.stringify(err)}`);
2950 2951 2952
});
```

2953
## notificationManager.requestEnableNotification
2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968

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

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

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

**参数:**

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

**错误码:**

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

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

**示例:**

X
xuzhihao 已提交
2979 2980 2981 2982
```ts
import Base from '@ohos.base';

let requestEnableNotificationCallback = (err: Base.BusinessError) => {
2983
    if (err) {
2984
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
2985 2986 2987 2988 2989
    } else {
        console.info("requestEnableNotification success");
    }
};

2990
notificationManager.requestEnableNotification(requestEnableNotificationCallback);
2991 2992
```

2993
## notificationManager.requestEnableNotification
2994 2995 2996 2997 2998 2999 3000 3001 3002

requestEnableNotification(): Promise\<void\>

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

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

**错误码:**

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

3005 3006 3007 3008 3009 3010 3011 3012
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

X
xuzhihao 已提交
3013 3014 3015
```ts
import Base from '@ohos.base';

3016
notificationManager.requestEnableNotification().then(() => {
F
fangJinliang1 已提交
3017
    console.info("requestEnableNotification success");
X
xuzhihao 已提交
3018 3019
}).catch((err: Base.BusinessError) => {
    console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
3020
});
3021 3022
```

X
XKK 已提交
3023
## notificationManager.requestEnableNotification<sup>10+<sup>
3024

X
XKK 已提交
3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049
requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback\<void\>): void

应用请求通知使能模态弹窗(Callback形式)。

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                 |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | 是   | 通知弹窗绑定Ability的上下文。 |
| callback | AsyncCallback\<void\> | 是   | 应用请求通知使能的回调函数。     |

**错误码:**

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

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

**示例:**

X
xuzhihao 已提交
3050 3051 3052 3053
```ts
import Base from '@ohos.base';

let requestEnableNotificationCallback = (err: Base.BusinessError) => {
X
XKK 已提交
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089
    if (err) {
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("requestEnableNotification success");
    }
};

notificationManager.requestEnableNotification(globalThis.uicontext, requestEnableNotificationCallback);
```

## notificationManager.requestEnableNotification<sup>10+<sup>

requestEnableNotification(context: UIAbilityContext): Promise\<void\>

应用请求通知使能模态弹窗(Promise形式)。

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                 |
| -------- | ------------------------ | ---- |--------------------|
| context | UIAbilityContext | 是   | 通知弹窗绑定Ability的上下文。 |

**错误码:**

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

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

**示例:**

X
xuzhihao 已提交
3090 3091 3092
```ts
import Base from '@ohos.base';

X
XKK 已提交
3093 3094
notificationManager.requestEnableNotification(globalThis.uicontext).then(() => {
    console.info("requestEnableNotification success");
X
xuzhihao 已提交
3095 3096
}).catch((err: Base.BusinessError) => {
    console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
X
XKK 已提交
3097 3098
});
```
3099

3100
## notificationManager.setDistributedEnable
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115

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

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

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

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

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

**参数:**

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

**错误码:**

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

3123 3124 3125 3126 3127 3128 3129 3130 3131
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

X
xuzhihao 已提交
3132 3133 3134 3135
```ts
import Base from '@ohos.base';

let setDistributedEnableCallback = (err: Base.BusinessError) => {
3136
    if (err) {
3137
        console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
3138 3139 3140 3141 3142
    } else {
        console.info("setDistributedEnable success");
    }
};

3143
let enable: boolean = true;
3144

3145
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
3146 3147
```

3148
## notificationManager.setDistributedEnable
3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163

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

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

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

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

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

**参数:**

| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
F
fangJinliang1 已提交
3164
| enable   | boolean                  | 是   | 是否支持。 |
3165 3166 3167

**错误码:**

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

3170 3171 3172 3173 3174 3175 3176 3177 3178
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

X
xuzhihao 已提交
3179 3180 3181
```ts
import Base from '@ohos.base';

3182
let enable: boolean = true;
3183

3184
notificationManager.setDistributedEnable(enable).then(() => {
3185
    console.info("setDistributedEnable success");
X
xuzhihao 已提交
3186 3187
}).catch((err: Base.BusinessError) => {
    console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
3188
});
3189 3190 3191
```


3192
## notificationManager.isDistributedEnabled
3193 3194 3195

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

F
fangJinliang1 已提交
3196
查询设备是否支持分布式通知(Callback形式)。
3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207

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

**参数:**

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

**错误码:**

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

3210 3211 3212 3213 3214 3215 3216 3217 3218
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

X
xuzhihao 已提交
3219 3220 3221 3222
```ts
import Base from '@ohos.base';

let isDistributedEnabledCallback = (err: Base.BusinessError, data: boolean) => {
3223
    if (err) {
3224
        console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
3225
    } else {
F
fangJinliang1 已提交
3226
        console.info("isDistributedEnabled success " + JSON.stringify(data));
3227 3228 3229
    }
};

3230
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);
3231 3232 3233 3234
```



3235
## notificationManager.isDistributedEnabled
3236 3237 3238

isDistributedEnabled(): Promise\<boolean>

F
fangJinliang1 已提交
3239
查询设备是否支持分布式通知(Promise形式)。
3240 3241 3242 3243 3244

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

**返回值:**

F
fangJinliang1 已提交
3245 3246 3247
| 类型               | 说明                                          |
| ------------------ | --------------------------------------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。 |
3248 3249 3250

**错误码:**

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

3253 3254 3255 3256 3257 3258 3259 3260 3261
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600010  | Distributed operation failed.       |

**示例:**

X
xuzhihao 已提交
3262 3263 3264
```ts
import Base from '@ohos.base';

3265
notificationManager.isDistributedEnabled()
X
xuzhihao 已提交
3266 3267 3268 3269 3270
.then((data: boolean) => {
    console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isDistributedEnabled fail: ${JSON.stringify(err)}`);
});
3271 3272 3273
```


3274
## notificationManager.setDistributedEnableByBundle
3275 3276 3277

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

F
fangJinliang1 已提交
3278
设置指定应用是否支持分布式通知(Callback形式)。
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289

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

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

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

**参数:**

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

**错误码:**

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

3298 3299 3300 3301 3302 3303 3304 3305 3306 3307
| 错误码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. |

**示例:**

X
xuzhihao 已提交
3308 3309 3310 3311
```ts
import Base from '@ohos.base';

let setDistributedEnableByBundleCallback = (err: Base.BusinessError) => {
3312
    if (err) {
3313
        console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
3314 3315 3316 3317 3318
    } else {
        console.info("enableDistributedByBundle success");
    }
};

3319
let bundle: notificationManager.BundleOption = {
3320
    bundle: "bundleName1",
F
fangJinliang1 已提交
3321
};
3322

3323
let enable: boolean = true;
3324

3325
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
3326 3327 3328 3329
```



3330
## notificationManager.setDistributedEnableByBundle
3331 3332 3333

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

F
fangJinliang1 已提交
3334
设置指定应用是否支持分布式通知(Promise形式)。
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345

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

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

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

**参数:**

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

**错误码:**

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

3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
| 错误码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. |

**示例:**

X
xuzhihao 已提交
3363 3364 3365
```ts
import Base from '@ohos.base';

3366
let bundle: notificationManager.BundleOption = {
3367
    bundle: "bundleName1",
F
fangJinliang1 已提交
3368
};
3369

3370
let enable: boolean = true;
3371

3372 3373
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
    console.info("setDistributedEnableByBundle success");
X
xuzhihao 已提交
3374 3375
}).catch((err: Base.BusinessError) => {
    console.error(`setDistributedEnableByBundle fail: ${JSON.stringify(err)}`);
3376
});
3377 3378
```

3379
## notificationManager.isDistributedEnabledByBundle
3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394

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

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

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

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

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

**参数:**

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

**错误码:**

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

3402 3403 3404 3405 3406 3407 3408 3409 3410 3411
| 错误码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. |

**示例:**

X
xuzhihao 已提交
3412 3413 3414 3415
```ts
import Base from '@ohos.base';

let isDistributedEnabledByBundleCallback = (err: Base.BusinessError, data: boolean) => {
3416
    if (err) {
3417
        console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
3418
    } else {
F
fangJinliang1 已提交
3419
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
3420 3421 3422
    }
};

3423
let bundle: notificationManager.BundleOption = {
3424
    bundle: "bundleName1",
F
fangJinliang1 已提交
3425
};
3426

3427
notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
3428 3429
```

3430
## notificationManager.isDistributedEnabledByBundle
3431 3432 3433

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

F
fangJinliang1 已提交
3434
查询指定应用是否支持分布式通知(Promise形式)。
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445

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

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

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

**参数:**

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

**返回值:**

F
fangJinliang1 已提交
3450 3451 3452
| 类型               | 说明                                              |
| ------------------ | ------------------------------------------------- |
| Promise\<boolean\> | Promise方式返回指定应用是否支持分布式通知的结果。 |
3453 3454 3455

**错误码:**

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

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

**示例:**

X
xuzhihao 已提交
3468 3469 3470
```ts
import Base from '@ohos.base';

3471
let bundle: notificationManager.BundleOption = {
3472
    bundle: "bundleName1",
F
fangJinliang1 已提交
3473
};
3474

3475
notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
F
fangJinliang1 已提交
3476
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
3477 3478
}).catch((err: Base.BusinessError) => {
    console.error(`isDistributedEnabledByBundle fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
3479
});
3480 3481 3482
```


3483
## notificationManager.getDeviceRemindType
3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498

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

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

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

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

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

**参数:**

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

**错误码:**

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

3505 3506 3507 3508 3509 3510 3511 3512
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

X
xuzhihao 已提交
3513 3514 3515 3516
```ts
import Base from '@ohos.base';

let getDeviceRemindTypeCallback = (err: Base.BusinessError, data: notificationManager.DeviceRemindType) => {
3517
    if (err) {
3518
        console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
3519
    } else {
3520
        console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`);
3521 3522 3523
    }
};

3524
notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);
3525 3526
```

3527
## notificationManager.getDeviceRemindType
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542

getDeviceRemindType(): Promise\<DeviceRemindType\>

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

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

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

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

**返回值:**

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

**错误码:**

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

3549 3550 3551 3552 3553 3554 3555 3556
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |

**示例:**

X
xuzhihao 已提交
3557 3558 3559
```ts
import Base from '@ohos.base';

3560
notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => {
F
fangJinliang1 已提交
3561
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
3562 3563
}).catch((err: Base.BusinessError) => {
    console.error(`getDeviceRemindType fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
3564
});
3565 3566 3567
```


3568
## notificationManager.publishAsBundle
3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581

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

**错误码:**

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

3593 3594 3595 3596 3597 3598 3599 3600 3601
| 错误码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. |
3602
| 1600012  | No memory space.                          |
3603 3604 3605

**示例:**

3606
```ts
X
xuzhihao 已提交
3607 3608
import Base from '@ohos.base';

3609
//publishAsBundle回调
X
xuzhihao 已提交
3610
let callback = (err: Base.BusinessError) => {
3611
    if (err) {
3612
        console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
3613 3614 3615 3616 3617
    } else {
        console.info("publishAsBundle success");
    }
}
// 被代理应用的包名
3618
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3619
// 用户ID
3620
let userId: number = 100;
F
fangJinliang1 已提交
3621
// NotificationRequest对象
3622
let request: notificationManager.NotificationRequest = {
3623 3624
    id: 1,
    content: {
3625
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3626 3627 3628 3629 3630 3631
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3632
};
3633

3634
notificationManager.publishAsBundle(request, representativeBundle, userId, callback);
3635 3636
```

3637
## notificationManager.publishAsBundle
3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653

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

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

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

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

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

**参数:**


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

**错误码:**

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

3662 3663 3664 3665 3666 3667 3668 3669 3670
| 错误码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. |
3671
| 1600012  | No memory space.                          |
3672 3673 3674

**示例:**

3675
```ts
X
xuzhihao 已提交
3676 3677
import Base from '@ohos.base';

3678
// 被代理应用的包名
3679
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3680
// 用户ID
3681
let userId: number = 100;
F
fangJinliang1 已提交
3682
// NotificationRequest对象
3683
let request: notificationManager.NotificationRequest = {
3684 3685
    id: 1,
    content: {
3686
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
3687 3688 3689 3690 3691 3692
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
3693
};
3694

3695
notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
F
fangJinliang1 已提交
3696
	console.info("publishAsBundle success");
X
xuzhihao 已提交
3697 3698
}).catch((err: Base.BusinessError) => {
    console.error(`publishAsBundle fail: ${JSON.stringify(err)}`);
3699 3700 3701
});
```

3702
## notificationManager.cancelAsBundle
3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721

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 已提交
3722
| userId               | number        | 是   | 用户ID。       |
3723 3724 3725 3726
| callback             | AsyncCallback | 是   | 取消代理通知的回调方法。 |

**错误码:**

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

3729 3730 3731 3732 3733 3734 3735 3736 3737 3738
| 错误码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.              |

**示例:**

3739
```ts
X
xuzhihao 已提交
3740 3741
import Base from '@ohos.base';

F
fangJinliang1 已提交
3742
// cancelAsBundle
X
xuzhihao 已提交
3743
let cancelAsBundleCallback = (err: Base.BusinessError) => {
3744
    if (err) {
3745
        console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
3746 3747 3748 3749 3750
    } else {
        console.info("cancelAsBundle success");
    }
}
// 被代理应用的包名
3751
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3752
// 用户ID
3753
let userId: number = 100;
3754

3755
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
3756 3757
```

3758
## notificationManager.cancelAsBundle
3759 3760 3761

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

F
fangJinliang1 已提交
3762
取消代理通知(Promise形式)。
3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777

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

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

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

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

**参数:**

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

**错误码:**

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

3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
| 错误码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.              |

**示例:**

3794
```ts
X
xuzhihao 已提交
3795 3796
import Base from '@ohos.base';

3797
// 被代理应用的包名
3798
let representativeBundle: string = "com.example.demo";
F
fangJinliang1 已提交
3799
// 用户ID
3800
let userId: number = 100;
3801

3802
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
3803
	console.info("cancelAsBundle success");
X
xuzhihao 已提交
3804 3805
}).catch((err: Base.BusinessError) => {
    console.error(`cancelAsBundle fail: ${JSON.stringify(err)}`);
3806 3807 3808
});
```

3809
## notificationManager.setNotificationEnableSlot 
3810 3811 3812

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

F
fangJinliang1 已提交
3813
设置指定应用的指定渠道类型的使能状态(Callback形式)。
3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824

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

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

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

**参数:**

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

**错误码:**

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

3834 3835 3836 3837 3838 3839 3840 3841 3842
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3843
```ts
X
xuzhihao 已提交
3844 3845
import Base from '@ohos.base';

F
fangJinliang1 已提交
3846
// setNotificationEnableSlot
X
xuzhihao 已提交
3847
let setNotificationEnableSlotCallback = (err: Base.BusinessError) => {
3848
    if (err) {
3849
        console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
3850 3851 3852 3853 3854
    } else {
        console.info("setNotificationEnableSlot success");
    }
};

3855
notificationManager.setNotificationEnableSlot(
3856
    { bundle: "ohos.samples.notification", },
3857
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3858 3859 3860 3861
    true,
    setNotificationEnableSlotCallback);
```

3862
## notificationManager.setNotificationEnableSlot
3863 3864 3865

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

F
fangJinliang1 已提交
3866
设置指定应用的指定渠道类型的使能状态(Promise形式)。
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877

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

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

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

**参数:**

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

**错误码:**

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

3886 3887 3888 3889 3890 3891 3892 3893 3894
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3895
```ts
X
xuzhihao 已提交
3896 3897
import Base from '@ohos.base';

F
fangJinliang1 已提交
3898
// setNotificationEnableSlot
3899
notificationManager.setNotificationEnableSlot(
3900
    { bundle: "ohos.samples.notification", },
3901
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3902
    true).then(() => {
F
fangJinliang1 已提交
3903
        console.info("setNotificationEnableSlot success");
X
xuzhihao 已提交
3904 3905
    }).catch((err: Base.BusinessError) => {
        console.error(`setNotificationEnableSlot fail: ${JSON.stringify(err)}`);
3906 3907 3908
    });
```

3909
## notificationManager.isNotificationSlotEnabled
3910 3911 3912

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

F
fangJinliang1 已提交
3913
获取指定应用的指定渠道类型的使能状态(Callback形式)。
3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924

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

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

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

**参数:**

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

**错误码:**

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

3933 3934 3935 3936 3937 3938 3939 3940 3941
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3942
```ts
X
xuzhihao 已提交
3943 3944
import Base from '@ohos.base';

F
fangJinliang1 已提交
3945
// isNotificationSlotEnabled
X
xuzhihao 已提交
3946
let getEnableSlotCallback = (err: Base.BusinessError, data: boolean) => {
3947
    if (err) {
3948
        console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
3949
    } else {
3950
        console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`);
3951 3952 3953
    }
};

3954
notificationManager.isNotificationSlotEnabled(
3955
    { bundle: "ohos.samples.notification", },
3956
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
3957 3958 3959
    getEnableSlotCallback);
```

3960
## notificationManager.isNotificationSlotEnabled
3961 3962 3963

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

F
fangJinliang1 已提交
3964
获取指定应用的指定渠道类型的使能状态(Promise形式)。
3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
Y
yuyaozhi 已提交
3976
| bundle | [BundleOption](./js-apis-inner-notification-notificationCommonDef.md#bundleoption) | 是   | 应用的包信息。   |
F
fangJinliang1 已提交
3977
| type   | [SlotType](#slottype)         | 是   | 渠道类型。 |
3978 3979 3980 3981 3982 3983 3984 3985 3986

**返回值:**

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

**错误码:**

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

3989 3990 3991 3992 3993 3994 3995 3996 3997
| 错误码ID | 错误信息                                 |
| -------- | ---------------------------------------- |
| 1600001  | Internal error.                          |
| 1600002  | Marshalling or unmarshalling error.      |
| 1600003  | Failed to connect service.               |
| 17700001 | The specified bundle name was not found. |

**示例:**

3998
```ts
X
xuzhihao 已提交
3999 4000
import Base from '@ohos.base';

F
fangJinliang1 已提交
4001
// isNotificationSlotEnabled
4002
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
4003
    notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => {
F
fangJinliang1 已提交
4004
    console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
X
xuzhihao 已提交
4005 4006
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationSlotEnabled fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
4007
});
4008 4009 4010
```


4011
## notificationManager.setSyncNotificationEnabledWithoutApp
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026

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

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

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

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

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

**参数:** 

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

**错误码:**

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

4035 4036 4037 4038 4039 4040 4041 4042 4043
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

4044
```ts
X
xuzhihao 已提交
4045 4046
import Base from '@ohos.base';

4047 4048
let userId: number = 100;
let enable: boolean = true;
4049

X
xuzhihao 已提交
4050
let callback = (err: Base.BusinessError) => {
4051
    if (err) {
4052
        console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
4053 4054 4055 4056 4057
    } else {
        console.info("setSyncNotificationEnabledWithoutApp success");
    }
}

4058
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);
4059 4060 4061
```


4062
## notificationManager.setSyncNotificationEnabledWithoutApp
4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077

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

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

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
4078 4079
| userId | number | 是   | 用户ID。   |
| enable | boolean | 是   | 是否启用。   |
4080 4081 4082 4083 4084 4085 4086 4087 4088

**返回值:**

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

**错误码:**

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

4091 4092 4093 4094 4095 4096 4097 4098 4099
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

4100
```ts
X
xuzhihao 已提交
4101 4102
import Base from '@ohos.base';

4103 4104
let userId: number = 100;
let enable: boolean = true;
4105

4106
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
F
fangJinliang1 已提交
4107
    console.info('setSyncNotificationEnabledWithoutApp success');
X
xuzhihao 已提交
4108 4109
}).catch((err: Base.BusinessError) => {
    console.error(`setSyncNotificationEnabledWithoutApp fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
4110
});
4111 4112 4113
```


4114
## notificationManager.getSyncNotificationEnabledWithoutApp
4115 4116 4117

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

F
fangJinliang1 已提交
4118
获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。
4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129

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

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

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

**参数:**

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

**错误码:**

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

4137 4138 4139 4140 4141 4142 4143 4144 4145
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

4146
```ts
X
xuzhihao 已提交
4147 4148
import Base from '@ohos.base';

4149
let userId: number = 100;
4150

X
xuzhihao 已提交
4151
let getSyncNotificationEnabledWithoutAppCallback = (err: Base.BusinessError, data: boolean) => {
4152
    if (err) {
F
fangJinliang1 已提交
4153
        console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
4154
    } else {
F
fangJinliang1 已提交
4155
        console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
4156 4157 4158
    }
}

4159
notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);
4160 4161 4162
```


4163
## notificationManager.getSyncNotificationEnabledWithoutApp
4164 4165 4166

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

F
fangJinliang1 已提交
4167
获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。
4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
F
fangJinliang1 已提交
4179
| userId | number | 是   | 用户ID。   |
4180 4181 4182

**返回值:**

F
fangJinliang1 已提交
4183 4184 4185
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 |
4186 4187 4188

**错误码:**

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

4191 4192 4193 4194 4195 4196 4197 4198 4199
| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |
| 1600002  | Marshalling or unmarshalling error. |
| 1600003  | Failed to connect service.          |
| 1600008  | The user is not exist.              |

**示例:**

4200
```ts
X
xuzhihao 已提交
4201 4202
import Base from '@ohos.base';

4203 4204 4205 4206
let userId: number = 100;

notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => {
  console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
X
xuzhihao 已提交
4207 4208
}).catch((err: Base.BusinessError) => {
    console.error(`getSyncNotificationEnabledWithoutApp fail: ${JSON.stringify(err)}`);
F
fangJinliang1 已提交
4209
});
4210 4211
```

4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227
## 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 已提交
4228
| type | string | 是   | 回调函数类型名,固定为'checkNotification'。 |
X
xinking129 已提交
4229
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)    | 是   | 消息验证函数指针。 |
4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241

**错误码:**

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

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |

**示例:**

```ts
X
xuzhihao 已提交
4242 4243 4244
import Base from '@ohos.base';

let OnCheckNotification = (info : notificationManager.NotificationCheckInfo) => {
4245 4246
    console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`);
    if(info.notificationId == 1){
4247 4248
        let result: notificationManager.NotificationCheckResult =  { code: 1, message: "testMsg1"};
        return result;
4249
    } else {
4250 4251
        let result: notificationManager.NotificationCheckResult =   { code: 0, message: "testMsg0"};
        return result;
4252 4253
    }
}
X
xuzhihao 已提交
4254 4255 4256 4257 4258
try{
    notificationManager.on("checkNotification", OnCheckNotification);
} catch (error){
    console.info(`notificationManager.on error: ${JSON.stringify(error)}`);
}
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276
```

## 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 已提交
4277
| type | string                                                       | 是   | 回调函数类型名,固定为'checkNotification'。 |
W
wangkailong 已提交
4278
| callback | (checkInfo: [NotificationCheckInfo](#notificationcheckinfo)) =>  [NotificationCheckResult](#notificationcheckresult)  | 否   | 消息验证函数指针,默认为空。 |
4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290

**错误码:**

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

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 1600001  | Internal error.                     |

**示例:**

```ts
X
xuzhihao 已提交
4291 4292
import Base from '@ohos.base';

4293 4294 4295 4296 4297 4298
try{
    notificationManager.off("checkNotification");
} catch (error){
    console.info(`notificationManager.off error: ${JSON.stringify(error)}`);
}
```
4299 4300 4301 4302 4303 4304 4305

## DoNotDisturbDate

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

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

4306 4307 4308 4309 4310
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | ---- | ---------------------- |
| type  | [DoNotDisturbType](#donotdisturbtype) | 是   | 免打扰设置的时间类型。 |
| begin | Date                                  | 是   | 免打扰设置的起点时间。 |
| end   | Date                                  | 是   | 免打扰设置的终点时间。 |
4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330

## DoNotDisturbType

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

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

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


## ContentType

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

| 名称                              | 值          | 说明               |
X
XKK 已提交
4331 4332 4333 4334 4335 4336
| --------------------------------- | ----------- |------------------|
| 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 | 多行文本类型通知。        |
4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371

## 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 已提交
4372
| 名称                 | 值  | 说明                               |
4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |


## SourceType

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

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

F
fangJinliang1 已提交
4386
| 名称                 | 值  | 说明                  |
4387 4388 4389 4390
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
| TYPE_TIMER           | 2   | 计划通知。            |
4391 4392 4393 4394 4395 4396 4397 4398 4399

## NotificationCheckInfo<sup>10+</sup>

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

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

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

4400 4401 4402 4403 4404
| 名称  | 类型                                  | 必填 | 说明                   |
| ----- | ------------------------------------- | --- | ---------------------- |
| bundleName  | string                          | 是   | bundle名称。 |
| notificationId | number                       | 是   | 通知Id。     |
| contentType   | [ContentType](#contenttype)   | 是   | 通知类型。   |
4405 4406 4407 4408 4409 4410 4411 4412 4413

## NotificationCheckResult<sup>10+</sup>

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

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

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

4414 4415 4416 4417
| 名称    | 类型                                  | 必填 | 说明                   |
| ------- | ------------------------------------ | ---- | ---------------------- |
| code    | number                               | 是   | 0-display, 1-no display。 |
| message | string                               | 是   | 结果信息。    |