js-apis-notification.md 133.7 KB
Newer Older
X
xuchenghua09 已提交
1
# Notification模块
Z
zhaoyuan17 已提交
2

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

一般情况下,只有系统应用具有通知订阅和取消订阅的权限。

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

X
xuchenghua09 已提交
11
## 导入模块
Z
zhaoyuan17 已提交
12 13

```js
X
xuchenghua09 已提交
14
import Notification from '@ohos.notification';
Z
zhaoyuan17 已提交
15 16
```

X
xuzhihao 已提交
17
## Notification.publish
Z
zero-cyc 已提交
18

X
xuzhihao 已提交
19
publish(request: NotificationRequest, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
20

X
xuzhihao 已提交
21
发布通知(callback形式)。
Z
zhaoyuan17 已提交
22

X
xuzhihao 已提交
23
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
24

X
xuzhihao 已提交
25
**参数:**
Z
zhaoyuan17 已提交
26

X
xuzhihao 已提交
27 28 29 30
| 名称     | 可读 | 可写 | 类型                                        | 必填 | 描述                                        |
| -------- | ---- | ---- | ------------------------------------------- | ---- | ------------------------------------------- |
| request  | 是   | 否   |[NotificationRequest](#notificationrequest) | 是   | 设置要发布通知内容的NotificationRequest对象。 |
| callback | 是   | 否   |AsyncCallback\<void\>                       | 是   | 被指定的回调方法。                            |
Z
zhaoyuan17 已提交
31

X
xuzhihao 已提交
32
**示例:**
Z
zhaoyuan17 已提交
33 34 35 36 37 38 39 40 41 42

```js
//publish回调
function publishCallback(err) {
	console.info("==========================>publishCallback=======================>");
}
//通知Request对象
var notificationRequest = {
    id: 1,
    content: {
Z
zengsiyu 已提交
43
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
Z
zhaoyuan17 已提交
44 45 46 47 48 49 50 51 52 53 54 55
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}
Notification.publish(notificationRequest, publishCallback)
```



X
xuzhihao 已提交
56
## Notification.publish
Z
zhaoyuan17 已提交
57

X
xuzhihao 已提交
58
publish(request: NotificationRequest): Promise\<void\>
Z
zhaoyuan17 已提交
59

X
xuzhihao 已提交
60
发布通知(Promise形式)。
Z
zhaoyuan17 已提交
61

X
xuzhihao 已提交
62
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
63

X
xuzhihao 已提交
64
**示例:**
Z
zhaoyuan17 已提交
65 66 67 68 69 70

```js
//通知Request对象
var notificationRequest = {
    notificationId: 1,
    content: {
Z
zengsiyu 已提交
71
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
Z
zhaoyuan17 已提交
72 73 74 75 76 77 78
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}
Z
zengsiyu 已提交
79
Notification.publish(notificationRequest).then(() => {
Z
zhaoyuan17 已提交
80 81 82 83 84
	console.info("==========================>publishCallback=======================>");
});

```

85 86
## Notification.publish<sup>8+</sup>

X
xuzhihao 已提交
87
publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<void\>): void
88 89 90 91 92

发布通知(callback形式)。

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

X
xuzhihao 已提交
93 94 95
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
**参数:**

| 名称     | 可读 | 可写 | 类型                                        | 必填 | 描述                                        |
| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- |
| request  | 是   | 否   |[NotificationRequest](#notificationrequest) | 是   | 设置要发布通知内容的NotificationRequest对象。 |
| userId   | 是   | 否   |number                                      | 是   | 接收通知用户的Id。                           |
| callback | 是   | 否   |AsyncCallback\<void\>                       | 是   | 被指定的回调方法。                           |

**示例:**

```js
//publish回调
function publishCallback(err) {
	console.info("==========================>publishCallback=======================>");
}
// 接收通知的用户ID
var userId = 1
//通知Request对象
var notificationRequest = {
    id: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}
Notification.publish(notificationRequest, userId, publishCallback);
```

## Notification.publish<sup>8+</sup>

X
xuzhihao 已提交
131
publish(request: NotificationRequest, userId: number): Promise\<void\>
132 133 134 135 136

发布通知(Promise形式)。

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

X
xuzhihao 已提交
137 138 139
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
**参数:**

| 名称     | 可读 | 可写 | 类型                                        | 必填 | 描述                                        |
| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- |
| request  | 是   | 否   |[NotificationRequest](#notificationrequest) | 是   | 设置要发布通知内容的NotificationRequest对象。 |
| userId   | 是   | 否   |number                                      | 是   | 接收通知用户的Id。                           |

**示例:**

```js
var notificationRequest = {
    notificationId: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}

var userId = 1

Notification.publish(notificationRequest, userId).then(() => {
	console.info("==========================>publishCallback=======================>");
});
```
Z
zhaoyuan17 已提交
169 170


X
xuzhihao 已提交
171
## Notification.cancel
Z
zhaoyuan17 已提交
172

X
xuzhihao 已提交
173
cancel(id: number, label: string, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
174

X
xuzhihao 已提交
175
取消与指定id和label相匹配的已发布通知(callback形式)。
Z
zhaoyuan17 已提交
176

X
xuzhihao 已提交
177
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
178

X
xuzhihao 已提交
179
**参数:**
Z
zhaoyuan17 已提交
180

X
xuzhihao 已提交
181 182 183 184 185
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | --- | ---- | --------------------- | ---- | -------------------- |
| id       | 是   | 否   | number                | 是   | 通知ID。               |
| label    | 是   | 否   | string                | 是   | 通知标签。             |
| callback | 是   | 否   | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
186

X
xuzhihao 已提交
187
**示例:**
Z
zhaoyuan17 已提交
188 189 190 191 192 193 194 195 196 197 198

```js
//cancel回调
function cancelCallback(err) {
	console.info("==========================>cancelCallback=======================>");
}
Notification.cancel(0, "label", cancelCallback)
```



X
xuzhihao 已提交
199
## Notification.cancel
Z
zhaoyuan17 已提交
200

X
xuzhihao 已提交
201
cancel(id: number, label?: string): Promise\<void\>
Z
zhaoyuan17 已提交
202

R
RayShih 已提交
203
取消与指定id相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
Z
zhaoyuan17 已提交
204

X
xuzhihao 已提交
205
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
206

X
xuzhihao 已提交
207
**参数:**
Z
zhaoyuan17 已提交
208

X
xuzhihao 已提交
209 210 211 212
| 名称  | 可读 | 可写 | 类型   | 必填 | 描述     |
| ----- | --- | ---- | ------ | ---- | -------- |
| id    | 是   | 否   | number | 是   | 通知ID。   |
| label | 是   | 否   | string | 否   | 通知标签。 |
Z
zhaoyuan17 已提交
213

X
xuzhihao 已提交
214
**示例:**
Z
zhaoyuan17 已提交
215 216

```js
Z
zengsiyu 已提交
217
Notification.cancel(0).then(() => {
Z
zhaoyuan17 已提交
218 219 220 221 222 223
	console.info("==========================>cancelCallback=======================>");
});
```



X
xuzhihao 已提交
224
## Notification.cancel
Z
zhaoyuan17 已提交
225

X
xuzhihao 已提交
226
cancel(id: number, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
227

R
RayShih 已提交
228
取消与指定id相匹配的已发布通知(callback形式)。
Z
zhaoyuan17 已提交
229

X
xuzhihao 已提交
230
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
231

X
xuzhihao 已提交
232
**参数:**
Z
zhaoyuan17 已提交
233

X
xuzhihao 已提交
234 235 236 237
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| id       | 是   | 否  | number                | 是   | 通知ID。               |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
238

X
xuzhihao 已提交
239
**示例:**
Z
zhaoyuan17 已提交
240 241 242 243 244 245 246 247 248 249 250

```js
//cancel回调
function cancelCallback(err) {
	console.info("==========================>cancelCallback=======================>");
}
Notification.cancel(0, cancelCallback)
```



X
xuzhihao 已提交
251
## Notification.cancelAll
Z
zhaoyuan17 已提交
252

X
xuzhihao 已提交
253
cancelAll(callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
254

R
RayShih 已提交
255
取消所有已发布的通知(callback形式)。
Z
zhaoyuan17 已提交
256

X
xuzhihao 已提交
257
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
258

X
xuzhihao 已提交
259
**参数:**
Z
zhaoyuan17 已提交
260

X
xuzhihao 已提交
261 262 263
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
264

X
xuzhihao 已提交
265
**示例:**
Z
zhaoyuan17 已提交
266 267 268

```js
//cancel回调
Z
zengsiyu 已提交
269 270
function cancelAllCallback(err) {
	console.info("==========================>cancelAllCallback=======================>");
Z
zhaoyuan17 已提交
271
}
Z
zengsiyu 已提交
272
Notification.cancelAll(cancelAllCallback)
Z
zhaoyuan17 已提交
273 274 275 276
```



X
xuzhihao 已提交
277
## Notification.cancelAll
Z
zhaoyuan17 已提交
278

X
xuzhihao 已提交
279
cancelAll(): Promise\<void\>
Z
zhaoyuan17 已提交
280

R
RayShih 已提交
281
取消所有已发布的通知(Promise形式)。
Z
zhaoyuan17 已提交
282

X
xuzhihao 已提交
283
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
284

X
xuzhihao 已提交
285
**示例:**
Z
zhaoyuan17 已提交
286 287

```js
Z
zengsiyu 已提交
288 289
Notification.cancelAll().then(() => {
	console.info("==========================>cancelAllCallback=======================>");
Z
zhaoyuan17 已提交
290 291 292 293 294
});
```



X
xuzhihao 已提交
295
## Notification.addSlot
Z
zhaoyuan17 已提交
296

X
xuzhihao 已提交
297
addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
298

R
RayShih 已提交
299
创建通知通道(callback形式)。
Z
zhaoyuan17 已提交
300

X
xuzhihao 已提交
301
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
302

X
xuzhihao 已提交
303 304 305
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
307
**参数:**
Z
zhaoyuan17 已提交
308

X
xuzhihao 已提交
309 310
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
311
| slot     | 是   | 否  | [NotificationSlot](#notificationslot)       | 是   | 要创建的通知通道对象。 |
X
xuzhihao 已提交
312
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
313

X
xuzhihao 已提交
314
**示例:**
Z
zhaoyuan17 已提交
315 316 317 318 319 320 321 322

```js
//addslot回调
function addSlotCallBack(err) {
	console.info("==========================>addSlotCallBack=======================>");
}
//通知slot对象
var notificationSlot = {
X
xuchenghua09 已提交
323
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
324 325 326 327 328 329
}
Notification.addSlot(notificationSlot, addSlotCallBack)
```



X
xuzhihao 已提交
330
## Notification.addSlot
Z
zhaoyuan17 已提交
331

X
xuzhihao 已提交
332
addSlot(slot: NotificationSlot): Promise\<void\>
Z
zhaoyuan17 已提交
333

R
RayShih 已提交
334
创建通知通道(Promise形式)。
Z
zhaoyuan17 已提交
335

X
xuzhihao 已提交
336
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
337

X
xuzhihao 已提交
338 339 340
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
342
**参数:**
Z
zhaoyuan17 已提交
343

X
xuzhihao 已提交
344 345
| 名称 | 可读 | 可写 | 类型             | 必填 | 描述                 |
| ---- | ---- | --- | ---------------- | ---- | -------------------- |
346
| slot | 是   | 否  | [NotificationSlot](#notificationslot) | 是   | 要创建的通知通道对象。 |
Z
zhaoyuan17 已提交
347

X
xuzhihao 已提交
348
**示例:**
Z
zhaoyuan17 已提交
349 350 351

```js
//通知slot对象
X
xuchenghua09 已提交
352 353 354
var notificationSlot = {
    type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Z
zengsiyu 已提交
355
Notification.addSlot(notificationSlot).then(() => {
Z
zhaoyuan17 已提交
356 357 358 359 360 361
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuzhihao 已提交
362
## Notification.addSlot
Z
zhaoyuan17 已提交
363

X
xuzhihao 已提交
364
addSlot(type: SlotType, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
365

R
RayShih 已提交
366
创建通知通道(callback形式)。
Z
zhaoyuan17 已提交
367

X
xuzhihao 已提交
368
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
369

X
xuzhihao 已提交
370
**参数:**
Z
zhaoyuan17 已提交
371

X
xuzhihao 已提交
372 373 374 375
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                   |
| -------- | ---- | --- | --------------------- | ---- | ---------------------- |
| type     | 是   | 否  | [SlotType](#slottype)              | 是   | 要创建的通知通道的类型。 |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。   |
Z
zhaoyuan17 已提交
376

X
xuzhihao 已提交
377
**示例:**
Z
zhaoyuan17 已提交
378 379 380 381 382 383

```js
//addslot回调
function addSlotCallBack(err) {
	console.info("==========================>addSlotCallBack=======================>");
}
X
xuchenghua09 已提交
384
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack)
Z
zhaoyuan17 已提交
385 386 387 388
```



X
xuzhihao 已提交
389
## Notification.addSlot
Z
zhaoyuan17 已提交
390

X
xuzhihao 已提交
391
addSlot(type: SlotType): Promise\<void\>
Z
zhaoyuan17 已提交
392

R
RayShih 已提交
393
创建通知通道(Promise形式)。
Z
zhaoyuan17 已提交
394

X
xuzhihao 已提交
395
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
396

X
xuzhihao 已提交
397
**参数:**
Z
zhaoyuan17 已提交
398

X
xuzhihao 已提交
399 400 401
| 名称 | 可读 | 可写 | 类型     | 必填 | 描述                   |
| ---- | ---- | --- | -------- | ---- | ---------------------- |
| type | 是   | 否  | [SlotType](#slottype) | 是   | 要创建的通知通道的类型。 |
Z
zhaoyuan17 已提交
402

X
xuzhihao 已提交
403
**示例:**
Z
zhaoyuan17 已提交
404 405

```js
Z
zengsiyu 已提交
406
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => {
Z
zhaoyuan17 已提交
407 408 409 410 411 412
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuzhihao 已提交
413
## Notification.addSlots
Z
zhaoyuan17 已提交
414

X
xuzhihao 已提交
415
addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
416

R
RayShih 已提交
417
创建多个通知通道(callback形式)。
Z
zhaoyuan17 已提交
418

X
xuzhihao 已提交
419
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
420

X
xuzhihao 已提交
421 422 423
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
425
**参数:**
Z
zhaoyuan17 已提交
426

X
xuzhihao 已提交
427 428
| 名称     | 可读 | 可写 | 类型                      | 必填 | 描述                     |
| -------- | ---- | --- | ------------------------- | ---- | ------------------------ |
429
| slots    | 是   | 否  | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |
X
xuzhihao 已提交
430
| callback | 是   | 否  | AsyncCallback\<void\>     | 是   | 表示被指定的回调方法。     |
Z
zhaoyuan17 已提交
431

X
xuzhihao 已提交
432
**示例:**
Z
zhaoyuan17 已提交
433 434 435 436 437 438 439 440

```js
//addSlots回调
function addSlotsCallBack(err) {
	console.info("==========================>addSlotsCallBack=======================>");
}
//通知slot对象
var notificationSlot = {
X
xuchenghua09 已提交
441
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
442 443
}
//通知slot array 对象
Z
zengsiyu 已提交
444 445
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Z
zhaoyuan17 已提交
446 447 448 449 450 451

Notification.addSlots(notificationSlotArray, addSlotsCallBack)
```



X
xuzhihao 已提交
452
## Notification.addSlots
Z
zhaoyuan17 已提交
453

X
xuzhihao 已提交
454
addSlots(slots: Array\<NotificationSlot\>): Promise\<void\>
Z
zhaoyuan17 已提交
455

R
RayShih 已提交
456
创建多个通知通道(Promise形式)。
Z
zhaoyuan17 已提交
457

X
xuzhihao 已提交
458
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
459

X
xuzhihao 已提交
460 461 462
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
464
**参数:**
Z
zhaoyuan17 已提交
465

X
xuzhihao 已提交
466 467
| 名称  | 可读 | 可写 | 类型                      | 必填 | 描述                     |
| ----- | ---- | --- | ------------------------- | ---- | ------------------------ |
468
| slots | 是   | 否  | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |
Z
zhaoyuan17 已提交
469

X
xuzhihao 已提交
470
**示例:**
Z
zhaoyuan17 已提交
471 472 473 474

```js
//通知slot对象
var notificationSlot = {
X
xuchenghua09 已提交
475
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
476 477
}
//通知slot array 对象
Z
zengsiyu 已提交
478 479
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Z
zhaoyuan17 已提交
480

Z
zengsiyu 已提交
481
Notification.addSlots(notificationSlotArray).then(() => {
Z
zhaoyuan17 已提交
482 483 484 485 486 487
	console.info("==========================>addSlotCallback=======================>");
});
```



X
xuzhihao 已提交
488
## Notification.getSlot
Z
zhaoyuan17 已提交
489

X
xuzhihao 已提交
490
getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>): void
Z
zhaoyuan17 已提交
491

R
RayShih 已提交
492
获取一个通知通道(callback形式)。
Z
zhaoyuan17 已提交
493

X
xuzhihao 已提交
494
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
495

X
xuzhihao 已提交
496
**参数:**
Z
zhaoyuan17 已提交
497

X
xuzhihao 已提交
498 499 500
| 名称     | 可读 | 可写 | 类型                              | 必填 | 描述                                                        |
| -------- | ---- | --- | --------------------------------- | ---- | ----------------------------------------------------------- |
| slotType | 是   | 否  | [SlotType](#slottype)                          | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
501
| callback | 是   | 否  | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是   | 表示被指定的回调方法。                                        |
Z
zhaoyuan17 已提交
502

X
xuzhihao 已提交
503
**示例:**
Z
zhaoyuan17 已提交
504 505 506 507 508 509

```js
//getSlot回调
function getSlotCallback(err,data) {
	console.info("==========================>getSlotCallback=======================>");
}
X
xuchenghua09 已提交
510
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
511 512 513 514 515
Notification.getSlot(slotType, getSlotCallback)
```



X
xuzhihao 已提交
516
## Notification.getSlot
Z
zhaoyuan17 已提交
517

X
xuzhihao 已提交
518
getSlot(slotType: SlotType): Promise\<NotificationSlot\>
Z
zhaoyuan17 已提交
519

R
RayShih 已提交
520
获取一个通知通道(Promise形式)。
Z
zhaoyuan17 已提交
521

X
xuzhihao 已提交
522
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
523

X
xuzhihao 已提交
524
**参数:**
Z
zhaoyuan17 已提交
525

X
xuzhihao 已提交
526 527 528
| 名称     | 可读 | 可写 | 类型     | 必填 | 描述                                                        |
| -------- | ---- | --- | -------- | ---- | ----------------------------------------------------------- |
| slotType | 是   | 否  | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
Z
zhaoyuan17 已提交
529

X
xuzhihao 已提交
530
**返回值:**
Z
zhaoyuan17 已提交
531

X
xuzhihao 已提交
532 533 534 535 536
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<NotificationSlot\> | 以Promise形式返回获取一个通知通道。 |

**示例:**
Z
zhaoyuan17 已提交
537 538

```js
X
xuchenghua09 已提交
539
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
540 541
Notification.getSlot(slotType).then((data) => {
	console.info("==========================>getSlotCallback=======================>");
X
xuchenghua09 已提交
542
});
Z
zhaoyuan17 已提交
543 544 545 546
```



X
xuzhihao 已提交
547
## Notification.getSlots
Z
zhaoyuan17 已提交
548

X
xuzhihao 已提交
549
getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>): void
Z
zhaoyuan17 已提交
550

R
RayShih 已提交
551
获取此应用程序的所有通知通道(callback形式)。
Z
zhaoyuan17 已提交
552

X
xuzhihao 已提交
553
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
554

X
xuzhihao 已提交
555
**参数:**
Z
zhaoyuan17 已提交
556

X
xuzhihao 已提交
557 558
| 名称     | 可读 | 可写 | 类型                              | 必填 | 描述                 |
| -------- | ---- | --- | --------------------------------- | ---- | -------------------- |
559
| callback | 是   | 否  | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
560

X
xuzhihao 已提交
561
**示例:**
Z
zhaoyuan17 已提交
562 563 564 565 566 567 568 569 570 571 572

```js
//getSlots回调
function getSlotsCallback(err,data) {
	console.info("==========================>getSlotsCallback=======================>");
}
Notification.getSlots(getSlotsCallback)
```



X
xuzhihao 已提交
573
## Notification.getSlots
Z
zhaoyuan17 已提交
574

X
xuzhihao 已提交
575
getSlots(): Promise\<Array\<NotificationSlot\>>
Z
zhaoyuan17 已提交
576

R
RayShih 已提交
577
获取此应用程序的所有通知通道(Promise形式)。
Z
zhaoyuan17 已提交
578

X
xuzhihao 已提交
579
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
580

X
xuzhihao 已提交
581
**返回值:**
Z
zhaoyuan17 已提交
582

X
xuzhihao 已提交
583 584
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
585
| Promise\<Array\<[NotificationSlot](#notificationslot)\>\> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 |
X
xuezhongzhu 已提交
586

X
xuzhihao 已提交
587
**示例:**
Z
zhaoyuan17 已提交
588 589 590 591

```js
Notification.getSlots().then((data) => {
	console.info("==========================>getSlotsCallback=======================>");
X
xuchenghua09 已提交
592
});
Z
zhaoyuan17 已提交
593 594 595 596
```



X
xuzhihao 已提交
597
## Notification.removeSlot
Z
zhaoyuan17 已提交
598

X
xuzhihao 已提交
599
removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
600

R
RayShih 已提交
601
根据通知通道类型删除创建的通知通道(callback形式)。
Z
zhaoyuan17 已提交
602

X
xuzhihao 已提交
603
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
604

X
xuzhihao 已提交
605
**参数:**
Z
zhaoyuan17 已提交
606

X
xuzhihao 已提交
607 608 609 610
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                                                        |
| -------- | ---- | --- | --------------------- | ---- | ----------------------------------------------------------- |
| slotType | 是   | 否  | [SlotType](#slottype)              | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。                                        |
Z
zhaoyuan17 已提交
611

X
xuzhihao 已提交
612
**示例:**
Z
zhaoyuan17 已提交
613 614 615 616 617 618

```js
//removeSlot回调
function removeSlotCallback(err) {
	console.info("==========================>removeSlotCallback=======================>");
}
X
xuchenghua09 已提交
619
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
620 621 622 623 624
Notification.removeSlot(slotType,removeSlotCallback)
```



X
xuzhihao 已提交
625
## Notification.removeSlot
Z
zhaoyuan17 已提交
626

X
xuzhihao 已提交
627
removeSlot(slotType: SlotType): Promise\<void\>
Z
zhaoyuan17 已提交
628

R
RayShih 已提交
629
根据通知通道类型删除创建的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
630

X
xuzhihao 已提交
631
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
632

X
xuzhihao 已提交
633
**参数:**
Z
zhaoyuan17 已提交
634

X
xuzhihao 已提交
635 636 637
| 名称     | 可读 | 可写 | 类型     | 必填 | 描述                                                        |
| -------- | ---- | --- | -------- | ---- | ----------------------------------------------------------- |
| slotType | 是   | 否  | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
Z
zhaoyuan17 已提交
638

X
xuzhihao 已提交
639
**示例:**
Z
zhaoyuan17 已提交
640 641

```js
X
xuchenghua09 已提交
642
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zengsiyu 已提交
643
Notification.removeSlot(slotType).then(() => {
Z
zhaoyuan17 已提交
644
	console.info("==========================>removeSlotCallback=======================>");
X
xuchenghua09 已提交
645
});
Z
zhaoyuan17 已提交
646 647 648 649
```



X
xuzhihao 已提交
650
## Notification.removeAllSlots
Z
zhaoyuan17 已提交
651

X
xuzhihao 已提交
652
removeAllSlots(callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
653

R
RayShih 已提交
654
删除所有通知通道(callback形式)。
Z
zhaoyuan17 已提交
655

X
xuzhihao 已提交
656
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
657

X
xuzhihao 已提交
658
**参数:**
Z
zhaoyuan17 已提交
659

X
xuzhihao 已提交
660 661 662
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
663

X
xuzhihao 已提交
664
**示例:**
Z
zhaoyuan17 已提交
665 666 667 668 669 670 671 672 673 674

```js
function removeAllCallBack(err) {
	console.info("================>removeAllCallBack=======================>");
}
Notification.removeAllSlots(removeAllCallBack)
```



X
xuzhihao 已提交
675
## Notification.removeAllSlots
Z
zhaoyuan17 已提交
676

X
xuzhihao 已提交
677
removeAllSlots(): Promise\<void\>
Z
zhaoyuan17 已提交
678

R
RayShih 已提交
679
删除所有通知通道(Promise形式)。
Z
zhaoyuan17 已提交
680

X
xuzhihao 已提交
681
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
682

X
xuzhihao 已提交
683
**示例:**
Z
zhaoyuan17 已提交
684 685

```js
Z
zengsiyu 已提交
686
Notification.removeAllSlots().then(() => {
Z
zhaoyuan17 已提交
687 688 689 690 691 692
	console.info("==========================>removeAllCallBack=======================>");
});
```



X
xuzhihao 已提交
693
## Notification.subscribe
Z
zhaoyuan17 已提交
694

X
xuzhihao 已提交
695
subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
696

R
RayShih 已提交
697
订阅通知并指定订阅信息(callback形式)。
Z
zhaoyuan17 已提交
698

X
xuzhihao 已提交
699
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
700

X
xuzhihao 已提交
701 702 703
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
705
**参数:**
Z
zhaoyuan17 已提交
706

X
xuzhihao 已提交
707 708 709 710 711
| 名称       | 可读 | 可写 | 类型                      | 必填 | 描述             |
| ---------- | ---- | --- | ------------------------- | ---- | ---------------- |
| subscriber | 是   | 否  | [NotificationSubscriber](#notificationsubscriber)    | 是   | 通知订阅对象。     |
| info       | 是   | 否  | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是   | 订阅信息。         |
| callback   | 是   | 否  | AsyncCallback\<void\>     | 是   | 订阅动作回调函数。 |
Z
zhaoyuan17 已提交
712

X
xuzhihao 已提交
713
**示例:**
Z
zhaoyuan17 已提交
714 715 716 717 718 719

```js
//subscribe回调
function subscribeCallback(err) {
	console.info("==========================>subscribeCallback=======================>");
}
720
function onConsumeCallback(data) {
Z
zhaoyuan17 已提交
721 722 723
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
724
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
725 726
}
var info = {
X
xuchenghua09 已提交
727
    bundleNames: ["bundleName1","bundleName2"]
Z
zhaoyuan17 已提交
728 729 730 731 732 733
}
Notification.subscribe(subscriber, info, subscribeCallback);
```



X
xuzhihao 已提交
734
## Notification.subscribe
Z
zhaoyuan17 已提交
735

X
xuzhihao 已提交
736
subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
737

R
RayShih 已提交
738
订阅通知并指定订阅信息(callback形式)。
Z
zhaoyuan17 已提交
739

X
xuzhihao 已提交
740
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
741

X
xuzhihao 已提交
742 743 744
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
746
**参数:**
Z
zhaoyuan17 已提交
747

X
xuzhihao 已提交
748 749 750 751
| 名称       | 可读 | 可写 | 类型                   | 必填 | 描述             |
| ---------- | ---- | --- | ---------------------- | ---- | ---------------- |
| subscriber | 是   | 否  | [NotificationSubscriber](#notificationsubscriber) | 是   | 通知订阅对象。     |
| callback   | 是   | 否  | AsyncCallback\<void\>  | 是   | 订阅动作回调函数。 |
Z
zhaoyuan17 已提交
752

X
xuzhihao 已提交
753
**示例:**
Z
zhaoyuan17 已提交
754 755 756 757 758

```js
function subscribeCallback(err) {
	console.info("==========================>subscribeCallback=======================>");
}
759
function onConsumeCallback(data) {
Z
zhaoyuan17 已提交
760 761 762
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
763
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
764 765 766 767 768 769
}
Notification.subscribe(subscriber, subscribeCallback);
```



X
xuzhihao 已提交
770
## Notification.subscribe
Z
zhaoyuan17 已提交
771

X
xuzhihao 已提交
772
subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise\<void\>
Z
zhaoyuan17 已提交
773

R
RayShih 已提交
774
订阅通知并指定订阅信息(Promise形式)。
Z
zhaoyuan17 已提交
775

X
xuzhihao 已提交
776
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
777

X
xuzhihao 已提交
778 779 780
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
782
**参数:**
Z
zhaoyuan17 已提交
783

X
xuzhihao 已提交
784 785 786 787
| 名称       | 可读 | 可写 | 类型                      | 必填 | 描述         |
| ---------- | ---- | --- | ------------------------- | ---- | ------------ |
| subscriber | 是   | 否  | [NotificationSubscriber](#notificationsubscriber)    | 是   | 通知订阅对象。 |
| info       | 是   | 否  | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否   | 订阅信息。     |
Z
zhaoyuan17 已提交
788

X
xuzhihao 已提交
789
**示例:**
Z
zhaoyuan17 已提交
790 791

```js
792
function onConsumeCallback(data) {
Z
zhaoyuan17 已提交
793 794 795
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
796
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
797
};
Z
zengsiyu 已提交
798
Notification.subscribe(subscriber).then(() => {
Z
zhaoyuan17 已提交
799 800 801 802 803 804
	console.info("==========================>subscribeCallback=======================>");
});
```



X
xuzhihao 已提交
805
## Notification.unsubscribe
Z
zhaoyuan17 已提交
806

X
xuzhihao 已提交
807
unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
808

R
RayShih 已提交
809
取消订阅(callbcak形式)。
Z
zhaoyuan17 已提交
810

X
xuzhihao 已提交
811
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
812

X
xuzhihao 已提交
813 814 815
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
817
**参数:**
Z
zhaoyuan17 已提交
818

X
xuzhihao 已提交
819 820 821 822
| 名称       | 可读 | 可写 | 类型                   | 必填 | 描述                 |
| ---------- | ---- | --- | ---------------------- | ---- | -------------------- |
| subscriber | 是   | 否  | [NotificationSubscriber](#notificationsubscriber) | 是   | 通知订阅对象。         |
| callback   | 是   | 否  | AsyncCallback\<void\>  | 是   | 取消订阅动作回调函数。 |
Z
zhaoyuan17 已提交
823

X
xuzhihao 已提交
824
**示例:**
Z
zhaoyuan17 已提交
825 826 827 828 829

```js
function unsubscribeCallback(err) {
	console.info("==========================>unsubscribeCallback=======================>");
}
830
function onConsumeCallback(data) {
Z
zhaoyuan17 已提交
831 832 833
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
834
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
835 836 837 838 839 840
}
Notification.unsubscribe(subscriber, unsubscribeCallback);
```



X
xuzhihao 已提交
841
## Notification.unsubscribe
Z
zhaoyuan17 已提交
842

X
xuzhihao 已提交
843
unsubscribe(subscriber: NotificationSubscriber): Promise\<void\>
Z
zhaoyuan17 已提交
844

R
RayShih 已提交
845
取消订阅(Promise形式)。
Z
zhaoyuan17 已提交
846

X
xuzhihao 已提交
847
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
848

X
xuzhihao 已提交
849 850 851
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
853
**参数:**
Z
zhaoyuan17 已提交
854

X
xuzhihao 已提交
855 856 857
| 名称       | 可读 | 可写 | 类型                   | 必填 | 描述         |
| ---------- | ---- | --- | ---------------------- | ---- | ------------ |
| subscriber | 是   | 否  | [NotificationSubscriber](#notificationsubscriber) | 是   | 通知订阅对象。 |
Z
zhaoyuan17 已提交
858

X
xuzhihao 已提交
859
**示例:**
Z
zhaoyuan17 已提交
860 861

```js
862
function onConsumeCallback(data) {
Z
zhaoyuan17 已提交
863 864 865
	console.info("==========================>onConsumeCallback=======================>");
}
var subscriber = {
X
xuchenghua09 已提交
866
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
867
};
Z
zengsiyu 已提交
868
Notification.unsubscribe(subscriber).then(() => {
Z
zhaoyuan17 已提交
869 870 871 872 873 874
	console.info("==========================>unsubscribeCallback=======================>");
});
```



X
xuzhihao 已提交
875
## Notification.enableNotification
Z
zhaoyuan17 已提交
876

X
xuzhihao 已提交
877
enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
878

R
RayShih 已提交
879
设定指定包的通知使能状态(Callback形式)。
Z
zhaoyuan17 已提交
880

X
xuzhihao 已提交
881
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
882

X
xuzhihao 已提交
883 884 885
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
887
**参数:**
Z
zhaoyuan17 已提交
888

X
xuzhihao 已提交
889 890 891 892 893
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。           |
| enable   | 是   | 否  | boolean               | 是   | 使能状态。             |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 设定通知使能回调函数。 |
Z
zhaoyuan17 已提交
894

X
xuzhihao 已提交
895
**示例:**
Z
zhaoyuan17 已提交
896 897 898 899 900 901

```js
function enableNotificationCallback(err) {
	console.info("==========================>enableNotificationCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
902
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
903 904 905 906 907 908
}
Notification.enableNotification(bundle, false, enableNotificationCallback);
```



X
xuzhihao 已提交
909
## Notification.enableNotification
Z
zhaoyuan17 已提交
910

X
xuzhihao 已提交
911
enableNotification(bundle: BundleOption, enable: boolean): Promise\<void\>
Z
zhaoyuan17 已提交
912

R
RayShih 已提交
913
设定指定包的通知使能状态(Promise形式)。
Z
zhaoyuan17 已提交
914

X
xuzhihao 已提交
915
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
916

X
xuzhihao 已提交
917 918 919
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
921
**参数:**
Z
zhaoyuan17 已提交
922

X
xuzhihao 已提交
923 924 925 926
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
| enable | 是   | 否  | boolean      | 是   | 使能状态。   |
Z
zhaoyuan17 已提交
927

X
xuzhihao 已提交
928
**示例:**
Z
zhaoyuan17 已提交
929 930 931

```js
var bundle = {
Z
zengsiyu 已提交
932
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
933
}
Z
zengsiyu 已提交
934
Notification.enableNotification(bundle, false).then(() => {
Z
zhaoyuan17 已提交
935 936 937 938 939 940
	console.info("==========================>enableNotificationCallback=======================>");
});
```



X
xuzhihao 已提交
941
## Notification.isNotificationEnabled
Z
zhaoyuan17 已提交
942

X
xuzhihao 已提交
943
isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void
Z
zhaoyuan17 已提交
944

R
RayShih 已提交
945
获取指定包的通知使能状态(Callback形式)。
Z
zhaoyuan17 已提交
946

X
xuzhihao 已提交
947
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
948

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

X
xuzhihao 已提交
951 952
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

X
xuzhihao 已提交
953
**参数:**
Z
zhaoyuan17 已提交
954

X
xuzhihao 已提交
955 956 957 958
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                     |
| -------- | ---- | --- | --------------------- | ---- | ------------------------ |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。               |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |
Z
zhaoyuan17 已提交
959

X
xuzhihao 已提交
960
**示例:**
Z
zhaoyuan17 已提交
961 962 963 964 965 966

```js
function isNotificationEnabledCallback(err, data) {
	console.info("==========================>isNotificationEnabledCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
967
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
968 969 970 971 972 973
}
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```



X
xuzhihao 已提交
974 975 976
## Notification.isNotificationEnabled

isNotificationEnabled(bundle: BundleOption): Promise\<boolean\>
Z
zhaoyuan17 已提交
977

R
RayShih 已提交
978
获取指定包的通知使能状态(Promise形式)。
Z
zhaoyuan17 已提交
979

X
xuzhihao 已提交
980
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
981

X
xuzhihao 已提交
982 983 984
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
986
**参数:**
Z
zhaoyuan17 已提交
987

X
xuzhihao 已提交
988 989 990
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
Z
zhaoyuan17 已提交
991

X
xuzhihao 已提交
992
**返回值:**
Z
zhaoyuan17 已提交
993

X
xuzhihao 已提交
994 995 996
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取指定包的通知使能状态的结果。 |
Z
zhaoyuan17 已提交
997

X
xuzhihao 已提交
998
**示例:**
Z
zhaoyuan17 已提交
999 1000 1001

```js
var bundle = {
Z
zengsiyu 已提交
1002
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1003 1004 1005 1006 1007 1008 1009 1010
}
Notification.isNotificationEnabled(bundle).then((data) => {
	console.info("==========================>isNotificationEnabledCallback=======================>");
});
```



X
xuzhihao 已提交
1011
## Notification.isNotificationEnabled
Z
zhaoyuan17 已提交
1012

X
xuzhihao 已提交
1013
isNotificationEnabled(callback: AsyncCallback\<boolean\>): void
Z
zhaoyuan17 已提交
1014

R
RayShih 已提交
1015
获取通知使能状态(Callback形式)。
Z
zhaoyuan17 已提交
1016

X
xuzhihao 已提交
1017
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1018

X
xuzhihao 已提交
1019 1020 1021
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1023
**参数:**
Z
zhaoyuan17 已提交
1024

X
xuzhihao 已提交
1025 1026 1027
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                     |
| -------- | ---- | --- | --------------------- | ---- | ------------------------ |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |
Z
zhaoyuan17 已提交
1028

X
xuzhihao 已提交
1029
**示例:**
Z
zhaoyuan17 已提交
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040

```js
function isNotificationEnabledCallback(err, data) {
	console.info("==========================>isNotificationEnabledCallback=======================>");
}

Notification.isNotificationEnabled(isNotificationEnabledCallback);
```



X
xuzhihao 已提交
1041 1042 1043
## Notification.isNotificationEnabled

isNotificationEnabled(): Promise\<boolean\>
Z
zhaoyuan17 已提交
1044

R
RayShih 已提交
1045
获取通知使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1046

X
xuzhihao 已提交
1047
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1048

X
xuzhihao 已提交
1049 1050 1051
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1053
**参数:**
Z
zhaoyuan17 已提交
1054

X
xuzhihao 已提交
1055 1056 1057
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
Z
zhaoyuan17 已提交
1058

X
xuzhihao 已提交
1059
**返回值:**
Z
zhaoyuan17 已提交
1060

X
xuzhihao 已提交
1061 1062 1063
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取通知使能状态的结果。 |
Z
zhaoyuan17 已提交
1064

X
xuzhihao 已提交
1065
**示例:**
Z
zhaoyuan17 已提交
1066 1067 1068 1069 1070 1071 1072 1073 1074

```js
Notification.isNotificationEnabled().then((data) => {
	console.info("==========================>isNotificationEnabledCallback=======================>");
});
```



X
xuzhihao 已提交
1075
## Notification.displayBadge
Z
zhaoyuan17 已提交
1076

X
xuzhihao 已提交
1077
displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1078

R
RayShih 已提交
1079
设定指定包的角标使能状态(Callback形式)。
Z
zhaoyuan17 已提交
1080

X
xuzhihao 已提交
1081
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1082

X
xuzhihao 已提交
1083 1084 1085
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1087
**参数:**
Z
zhaoyuan17 已提交
1088

X
xuzhihao 已提交
1089 1090 1091 1092 1093
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。           |
| enable   | 是   | 否  | boolean               | 是   | 使能状态。             |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 设定角标使能回调函数。 |
Z
zhaoyuan17 已提交
1094

X
xuzhihao 已提交
1095
**示例:**
Z
zhaoyuan17 已提交
1096 1097 1098 1099 1100 1101

```js
function displayBadgeCallback(err) {
	console.info("==========================>displayBadgeCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1102
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1103 1104 1105 1106 1107 1108
}
Notification.displayBadge(bundle, false, displayBadgeCallback);
```



X
xuzhihao 已提交
1109
## Notification.displayBadge
Z
zhaoyuan17 已提交
1110

X
xuzhihao 已提交
1111
displayBadge(bundle: BundleOption, enable: boolean): Promise\<void\>
Z
zhaoyuan17 已提交
1112

R
RayShih 已提交
1113
设定指定包的角标使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1114

X
xuzhihao 已提交
1115
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1116

X
xuzhihao 已提交
1117 1118 1119
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1121
**参数:**
Z
zhaoyuan17 已提交
1122

X
xuzhihao 已提交
1123 1124 1125 1126
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
| enable | 是   | 否  | boolean      | 是   | 使能状态。   |
Z
zhaoyuan17 已提交
1127

X
xuzhihao 已提交
1128
**示例:**
Z
zhaoyuan17 已提交
1129 1130 1131

```js
var bundle = {
Z
zengsiyu 已提交
1132
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1133
}
Z
zengsiyu 已提交
1134
Notification.displayBadge(bundle, false).then(() => {
Z
zhaoyuan17 已提交
1135 1136 1137 1138 1139 1140
	console.info("==========================>displayBadgeCallback=======================>");
});
```



X
xuzhihao 已提交
1141
## Notification.isBadgeDisplayed
Z
zhaoyuan17 已提交
1142

X
xuzhihao 已提交
1143
isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>): void
Z
zhaoyuan17 已提交
1144

R
RayShih 已提交
1145
获取指定包的角标使能状态(Callback形式)。
Z
zhaoyuan17 已提交
1146

X
xuzhihao 已提交
1147
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1148

X
xuzhihao 已提交
1149 1150 1151
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1153
**参数:**
Z
zhaoyuan17 已提交
1154

X
xuzhihao 已提交
1155 1156 1157 1158
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                     |
| -------- | ---- | --- | --------------------- | ---- | ------------------------ |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。               |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 获取角标使能状态回调函数。 |
Z
zhaoyuan17 已提交
1159

X
xuzhihao 已提交
1160
**示例:**
Z
zhaoyuan17 已提交
1161 1162 1163 1164 1165 1166

```js
function isBadgeDisplayedCallback(err, data) {
	console.info("==========================>isBadgeDisplayedCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1167
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1168 1169 1170 1171 1172 1173
}
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
```



X
xuzhihao 已提交
1174
## Notification.isBadgeDisplayed
Z
zhaoyuan17 已提交
1175

X
xuzhihao 已提交
1176
isBadgeDisplayed(bundle: BundleOption): Promise\<boolean\>
Z
zhaoyuan17 已提交
1177

R
RayShih 已提交
1178
获取指定包的角标使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1179

X
xuzhihao 已提交
1180
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1181

X
xuzhihao 已提交
1182 1183 1184
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1186
**参数:**
Z
zhaoyuan17 已提交
1187

X
xuzhihao 已提交
1188 1189 1190
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
Z
zhaoyuan17 已提交
1191

X
xuzhihao 已提交
1192
**返回值:**
Z
zhaoyuan17 已提交
1193

X
xuzhihao 已提交
1194 1195 1196 1197 1198
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取指定包的角标使能状态。 |

**示例:**
Z
zhaoyuan17 已提交
1199 1200 1201

```js
var bundle = {
Z
zengsiyu 已提交
1202
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1203 1204 1205 1206 1207 1208 1209 1210
}
Notification.isBadgeDisplayed(bundle).then((data) => {
	console.info("==========================>isBadgeDisplayedCallback=======================>");
});
```



X
xuzhihao 已提交
1211
## Notification.setSlotByBundle
Z
zhaoyuan17 已提交
1212

X
xuzhihao 已提交
1213
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1214

R
RayShih 已提交
1215
设定指定包的通知通道状态(Callback形式)。
Z
zhaoyuan17 已提交
1216

X
xuzhihao 已提交
1217
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1218

X
xuzhihao 已提交
1219 1220 1221
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1223
**参数:**
Z
zhaoyuan17 已提交
1224

X
xuzhihao 已提交
1225 1226 1227
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。           |
1228
| slot     | 是   | 否  | [NotificationSlot](#notificationslot)      | 是   | 通知通道。             |
X
xuzhihao 已提交
1229
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 设定通知通道回调函数。 |
Z
zhaoyuan17 已提交
1230

X
xuzhihao 已提交
1231
**示例:**
Z
zhaoyuan17 已提交
1232 1233 1234 1235 1236 1237

```js
function setSlotByBundleCallback(err) {
	console.info("==========================>setSlotByBundleCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1238
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1239 1240
}
var notificationSlot = {
X
xuchenghua09 已提交
1241
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
1242 1243 1244 1245 1246 1247
}
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```



X
xuzhihao 已提交
1248
## Notification.setSlotByBundle
Z
zhaoyuan17 已提交
1249

X
xuzhihao 已提交
1250
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise\<void\>
Z
zhaoyuan17 已提交
1251

F
fangjinliang 已提交
1252
设定指定包的通知通道状态(Promise形式)。
Z
zhaoyuan17 已提交
1253

X
xuzhihao 已提交
1254
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1255

X
xuzhihao 已提交
1256 1257 1258
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1260
**参数:**
Z
zhaoyuan17 已提交
1261

X
xuzhihao 已提交
1262 1263 1264
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
1265
| slot   | 是   | 否  | [NotificationSlot](#notificationslot) | 是   | 使能状态。   |
Z
zhaoyuan17 已提交
1266

X
xuzhihao 已提交
1267
**示例:**
Z
zhaoyuan17 已提交
1268 1269 1270

```js
var bundle = {
Z
zengsiyu 已提交
1271
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1272 1273
}
var notificationSlot = {
X
xuchenghua09 已提交
1274
    type: Notification.SlotType.SOCIAL_COMMUNICATION
Z
zhaoyuan17 已提交
1275
}
1276
Notification.setSlotByBundle(bundle, notificationSlot).then(() => {
Z
zhaoyuan17 已提交
1277 1278 1279 1280 1281 1282
	console.info("==========================>setSlotByBundleCallback=======================>");
});
```



X
xuzhihao 已提交
1283
## Notification.getSlotsByBundle
Z
zhaoyuan17 已提交
1284

X
xuzhihao 已提交
1285
getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>): void
Z
zhaoyuan17 已提交
1286

R
RayShih 已提交
1287
获取指定包的通知通道(Callback形式)。
Z
zhaoyuan17 已提交
1288

X
xuzhihao 已提交
1289
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1290

X
xuzhihao 已提交
1291 1292 1293
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1295
**参数:**
Z
zhaoyuan17 已提交
1296

X
xuzhihao 已提交
1297 1298 1299
| 名称     | 可读 | 可写 | 类型                                     | 必填 | 描述                 |
| -------- | ---- | --- | ---------------------------------------- | ---- | -------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)                             | 是   | 指定包信息。           |
1300
| callback | 是   | 否  | AsyncCallback<Array\<[NotificationSlot](#notificationslot)\>> | 是   | 获取通知通道回调函数。 |
Z
zhaoyuan17 已提交
1301

X
xuzhihao 已提交
1302
**示例:**
Z
zhaoyuan17 已提交
1303 1304 1305 1306 1307 1308

```js
function getSlotsByBundleCallback(err, data) {
	console.info("==========================>getSlotsByBundleCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1309
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1310 1311 1312 1313 1314 1315
}
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```



X
xuzhihao 已提交
1316
## Notification.getSlotsByBundle
Z
zhaoyuan17 已提交
1317

X
xuzhihao 已提交
1318
getSlotsByBundle(bundle: BundleOption): Promise<Array\<NotificationSlot\>>
Z
zhaoyuan17 已提交
1319

R
RayShih 已提交
1320
获取指定包的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
1321

X
xuzhihao 已提交
1322
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1323

X
xuzhihao 已提交
1324 1325 1326
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1328
**参数:**
Z
zhaoyuan17 已提交
1329

X
xuzhihao 已提交
1330 1331 1332
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
Z
zhaoyuan17 已提交
1333

X
xuzhihao 已提交
1334
**返回值:**
Z
zhaoyuan17 已提交
1335

X
xuzhihao 已提交
1336 1337
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
1338
| Promise<Array\<[NotificationSlot](#notificationslot)\>> | 以Promise形式返回获取指定包的通知通道。 |
X
xuzhihao 已提交
1339 1340

**示例:**
Z
zhaoyuan17 已提交
1341 1342 1343

```js
var bundle = {
Z
zengsiyu 已提交
1344
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1345 1346 1347 1348 1349 1350 1351 1352
}
Notification.getSlotsByBundle(bundle).then((data) => {
	console.info("==========================>getSlotsByBundleCallback=======================>");
});
```



X
xuzhihao 已提交
1353
## Notification.getSlotNumByBundle
Z
zhaoyuan17 已提交
1354

X
xuzhihao 已提交
1355
getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>): void
Z
zhaoyuan17 已提交
1356

R
RayShih 已提交
1357
获取指定包的通知通道数(Callback形式)。
Z
zhaoyuan17 已提交
1358

X
xuzhihao 已提交
1359
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1360

X
xuzhihao 已提交
1361 1362 1363
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1365
**参数:**
Z
zhaoyuan17 已提交
1366

X
xuzhihao 已提交
1367 1368 1369 1370
| 名称     | 可读 | 可写 | 类型                      | 必填 | 描述                   |
| -------- | ---- | --- | ------------------------- | ---- | ---------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)              | 是   | 指定包信息。             |
| callback | 是   | 否  | AsyncCallback\<number\> | 是   | 获取通知通道数回调函数。 |
Z
zhaoyuan17 已提交
1371

X
xuzhihao 已提交
1372
**示例:**
Z
zhaoyuan17 已提交
1373 1374

```js
1375
function getSlotNumByBundleCallback(err, data) {
Z
zhaoyuan17 已提交
1376 1377 1378
	console.info("==========================>getSlotNumByBundleCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1379
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1380 1381 1382 1383 1384 1385
}
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```



X
xuzhihao 已提交
1386 1387 1388
## Notification.getSlotNumByBundle

getSlotNumByBundle(bundle: BundleOption): Promise\<number\>
Z
zhaoyuan17 已提交
1389

R
RayShih 已提交
1390
获取指定包的通知通道数(Promise形式)。
Z
zhaoyuan17 已提交
1391

X
xuzhihao 已提交
1392
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1393

X
xuzhihao 已提交
1394 1395 1396
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1398
**参数:**
Z
zhaoyuan17 已提交
1399

X
xuzhihao 已提交
1400 1401 1402
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。 |
Z
zhaoyuan17 已提交
1403

X
xuzhihao 已提交
1404
**返回值:**
Z
zhaoyuan17 已提交
1405

X
xuzhihao 已提交
1406 1407 1408
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<number\> | 以Promise形式返回获取指定包的通知通道数。 |
Z
zhaoyuan17 已提交
1409

X
xuzhihao 已提交
1410
**示例:**
Z
zhaoyuan17 已提交
1411 1412 1413

```js
var bundle = {
Z
zengsiyu 已提交
1414
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1415 1416 1417 1418 1419 1420 1421 1422
}
Notification.getSlotNumByBundle(bundle).then((data) => {
	console.info("==========================>getSlotNumByBundleCallback=======================>");
});
```



X
xuzhihao 已提交
1423
## Notification.remove
Z
zhaoyuan17 已提交
1424

X
xuzhihao 已提交
1425
remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1426

R
RayShih 已提交
1427
删除指定通知(Callback形式)。
Z
zhaoyuan17 已提交
1428

X
xuzhihao 已提交
1429
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1430

X
xuzhihao 已提交
1431 1432 1433
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1435
**参数:**
Z
zhaoyuan17 已提交
1436

X
xuzhihao 已提交
1437 1438 1439 1440 1441
| 名称            | 可读 | 可写 | 类型                                | 必填 | 描述                 |
| --------------- | ---- | --- | ----------------------------------- | ---- | -------------------- |
| bundle          | 是   | 否  | [BundleOption](#bundleoption)       | 是   | 指定包信息。           |
| notificationKey | 是   | 否  | [NotificationKey](#notificationkey) | 是   | 通知键值。             |
| callback        | 是   | 否  | AsyncCallback\<void\>               | 是   | 删除指定通知回调函数。 |
Z
zhaoyuan17 已提交
1442

X
xuzhihao 已提交
1443
**示例:**
Z
zhaoyuan17 已提交
1444 1445 1446 1447 1448 1449

```js
function removeCallback(err) {
	console.info("==========================>removeCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1450
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1451 1452
}
var notificationKey = {
Z
zengsiyu 已提交
1453 1454
    id: 0,
    label: "label",
Z
zhaoyuan17 已提交
1455 1456 1457 1458 1459 1460
}
Notification.remove(bundle, notificationKey, removeCallback);
```



X
xuzhihao 已提交
1461
## Notification.remove
Z
zhaoyuan17 已提交
1462

X
xuzhihao 已提交
1463
remove(bundle: BundleOption, notificationKey: NotificationKey): Promise\<void\>
Z
zhaoyuan17 已提交
1464

R
RayShih 已提交
1465
删除指定通知(Promise形式)。
Z
zhaoyuan17 已提交
1466

X
xuzhihao 已提交
1467
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1468

X
xuzhihao 已提交
1469 1470 1471
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1473
**参数:**
Z
zhaoyuan17 已提交
1474

X
xuzhihao 已提交
1475 1476 1477 1478
| 名称            | 可读 | 可写 | 类型            | 必填 | 描述       |
| --------------- | ---- | --- | --------------- | ---- | ---------- |
| bundle          | 是   | 否  | [BundleOption](#bundleoption)    | 是   | 指定包信息。 |
| notificationKey | 是   | 否  | [NotificationKey](#notificationkey) | 是   | 通知键值。   |
Z
zhaoyuan17 已提交
1479

X
xuzhihao 已提交
1480
**示例:**
Z
zhaoyuan17 已提交
1481 1482 1483

```js
var bundle = {
Z
zengsiyu 已提交
1484
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1485 1486
}
var notificationKey = {
Z
zengsiyu 已提交
1487 1488
    id: 0,
    label: "label",
Z
zhaoyuan17 已提交
1489
}
Z
zengsiyu 已提交
1490
Notification.remove(bundle, notificationKey).then(() => {
Z
zhaoyuan17 已提交
1491 1492 1493 1494 1495 1496
	console.info("==========================>removeCallback=======================>");
});
```



X
xuzhihao 已提交
1497
## Notification.remove
Z
zhaoyuan17 已提交
1498

X
xuzhihao 已提交
1499
remove(hashCode: string, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1500

R
RayShih 已提交
1501
删除指定通知(Callback形式)。
Z
zhaoyuan17 已提交
1502

X
xuzhihao 已提交
1503
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1504

X
xuzhihao 已提交
1505 1506 1507
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1509
**参数:**
Z
zhaoyuan17 已提交
1510

X
xuzhihao 已提交
1511 1512 1513 1514
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| hashCode | 是   | 否  | string                | 是   | 通知唯一ID。           |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 删除指定通知回调函数。 |
Z
zhaoyuan17 已提交
1515

X
xuzhihao 已提交
1516
**示例:**
Z
zhaoyuan17 已提交
1517 1518

```js
1519 1520
var hashCode = 'hashCode'

Z
zhaoyuan17 已提交
1521 1522 1523 1524 1525 1526 1527 1528 1529
function removeCallback(err) {
	console.info("==========================>removeCallback=======================>");
}

Notification.remove(hashCode, removeCallback);
```



X
xuzhihao 已提交
1530
## Notification.remove
Z
zhaoyuan17 已提交
1531

X
xuzhihao 已提交
1532
remove(hashCode: string): Promise\<void\>
Z
zhaoyuan17 已提交
1533

R
RayShih 已提交
1534
删除指定通知(Promise形式)。
Z
zhaoyuan17 已提交
1535

X
xuzhihao 已提交
1536
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1537

X
xuzhihao 已提交
1538 1539 1540
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1542
**参数:**
Z
zhaoyuan17 已提交
1543

X
xuzhihao 已提交
1544 1545 1546
| 名称     | 可读 | 可写 | 类型       | 必填 | 描述       |
| -------- | ---- | --- | ---------- | ---- | ---------- |
| hashCode | 是   | 否  | string | 是   | 通知唯一ID。 |
Z
zhaoyuan17 已提交
1547

X
xuzhihao 已提交
1548
**示例:**
Z
zhaoyuan17 已提交
1549 1550

```js
1551 1552
var hashCode = 'hashCode'

Z
zengsiyu 已提交
1553
Notification.remove(hashCode).then(() => {
Z
zhaoyuan17 已提交
1554 1555 1556 1557 1558 1559
	console.info("==========================>removeCallback=======================>");
});
```



X
xuzhihao 已提交
1560
## Notification.removeAll
Z
zhaoyuan17 已提交
1561

X
xuzhihao 已提交
1562
removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1563

R
RayShih 已提交
1564
删除指定包的所有通知(Callback形式)。
Z
zhaoyuan17 已提交
1565

X
xuzhihao 已提交
1566
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1567

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

X
xuzhihao 已提交
1570 1571
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

X
xuzhihao 已提交
1572
**参数:**
Z
zhaoyuan17 已提交
1573

X
xuzhihao 已提交
1574 1575 1576 1577
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                         |
| -------- | ---- | --- | --------------------- | ---- | ---------------------------- |
| bundle   | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。                   |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 删除指定包的所有通知回调函数。 |
Z
zhaoyuan17 已提交
1578

X
xuzhihao 已提交
1579
**示例:**
Z
zhaoyuan17 已提交
1580 1581 1582 1583 1584 1585

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}
var bundle = {
Z
zengsiyu 已提交
1586
    bundle: "bundleName1",
Z
zhaoyuan17 已提交
1587 1588 1589 1590 1591 1592
}
Notification.removeAll(bundle, removeAllCallback);
```



X
xuzhihao 已提交
1593
## Notification.removeAll
Z
zhaoyuan17 已提交
1594

X
xuzhihao 已提交
1595
removeAll(callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1596

R
RayShih 已提交
1597
删除所有通知(Callback形式)。
Z
zhaoyuan17 已提交
1598

X
xuzhihao 已提交
1599
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1600

X
xuzhihao 已提交
1601 1602 1603
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1605
**参数:**
Z
zhaoyuan17 已提交
1606

X
xuzhihao 已提交
1607 1608 1609
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                 |
| -------- | ---- | --- | --------------------- | ---- | -------------------- |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 删除所有通知回调函数。 |
Z
zhaoyuan17 已提交
1610

X
xuzhihao 已提交
1611
**示例:**
Z
zhaoyuan17 已提交
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}

Notification.removeAll(removeAllCallback);
```



X
xuzhihao 已提交
1623
## Notification.removeAll
Z
zhaoyuan17 已提交
1624

X
xuzhihao 已提交
1625
removeAll(bundle?: BundleOption): Promise\<void\>
Z
zhaoyuan17 已提交
1626

R
RayShih 已提交
1627
删除所有通知(Promise形式)。
Z
zhaoyuan17 已提交
1628

X
xuzhihao 已提交
1629
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1630

X
xuzhihao 已提交
1631 1632 1633
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1635
**参数:**
Z
zhaoyuan17 已提交
1636

X
xuzhihao 已提交
1637 1638 1639
| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| bundle | 是   | 否  | [BundleOption](#bundleoption) | 否   | 指定包信息。 |
Z
zhaoyuan17 已提交
1640

X
xuzhihao 已提交
1641
**示例:**
Z
zhaoyuan17 已提交
1642 1643

```js
Z
zengsiyu 已提交
1644
Notification.removeAll().then(() => {
Z
zhaoyuan17 已提交
1645 1646 1647 1648
	console.info("==========================>removeAllCallback=======================>");
});
```

1649 1650
## Notification.removeAll<sup>8+</sup>

X
xuzhihao 已提交
1651
removeAll(userId: number, callback: AsyncCallback\<void>): void
1652

R
RayShih 已提交
1653
删除所有通知(callback形式)。
1654 1655 1656

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

X
xuzhihao 已提交
1657 1658 1659
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
**参数:**

| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| userId | 是   | 否  | number | 是   | 接收通知用户的Id。 |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 删除所有通知回调函数。 |

**示例:**

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}

var userId = 1

Notification.removeAll(userId, removeAllCallback);
```

## Notification.removeAll<sup>8+</sup>

X
xuzhihao 已提交
1682
removeAll(userId: number): Promise\<void>
1683

R
RayShih 已提交
1684
删除所有通知(Promise形式)。
1685 1686 1687

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

X
xuzhihao 已提交
1688 1689 1690
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
**参数:**

| 名称   | 可读 | 可写 | 类型         | 必填 | 描述       |
| ------ | ---- | --- | ------------ | ---- | ---------- |
| userId | 是   | 否  | number | 是   | 接收通知用户的Id。 |

**示例:**

```js
function removeAllCallback(err) {
	console.info("==========================>removeAllCallback=======================>");
}

var userId = 1

Notification.removeAll(userId, removeAllCallback);
```
Z
zhaoyuan17 已提交
1709 1710


X
xuzhihao 已提交
1711
## Notification.getAllActiveNotifications
Z
zhaoyuan17 已提交
1712

X
xuzhihao 已提交
1713
getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void
Z
zhaoyuan17 已提交
1714

R
RayShih 已提交
1715
获取活动通知(Callback形式)。
Z
zhaoyuan17 已提交
1716

X
xuzhihao 已提交
1717
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1718

X
xuzhihao 已提交
1719 1720 1721
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1723
**参数:**
Z
zhaoyuan17 已提交
1724

X
xuzhihao 已提交
1725 1726 1727
| 名称     | 可读 | 可写 | 类型                                                         | 必填 | 描述                 |
| -------- | ---- | --- | ------------------------------------------------------------ | ---- | -------------------- |
| callback | 是   | 否  | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是   | 获取活动通知回调函数。 |
Z
zhaoyuan17 已提交
1728

X
xuzhihao 已提交
1729
**示例:**
Z
zhaoyuan17 已提交
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740

```js
function getAllActiveNotificationsCallback(err, data) {
	console.info("==========================>getAllActiveNotificationsCallback=======================>");
}

Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
```



X
xuzhihao 已提交
1741
## Notification.getAllActiveNotifications
Z
zhaoyuan17 已提交
1742

X
xuzhihao 已提交
1743
getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\>
Z
zhaoyuan17 已提交
1744

R
RayShih 已提交
1745
获取活动通知(Promise形式)。
Z
zhaoyuan17 已提交
1746

X
xuzhihao 已提交
1747
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1748

X
xuzhihao 已提交
1749 1750 1751
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1753
**返回值:**
Z
zhaoyuan17 已提交
1754

X
xuzhihao 已提交
1755 1756 1757
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取活动通知。 |
Z
zhaoyuan17 已提交
1758

X
xuzhihao 已提交
1759
**示例:**
Z
zhaoyuan17 已提交
1760 1761 1762 1763 1764 1765 1766 1767 1768

```js
Notification.getAllActiveNotifications().then((data) => {
	console.info("==========================>getAllActiveNotificationsCallback=======================>");
});
```



X
xuzhihao 已提交
1769
## Notification.getActiveNotificationCount
Z
zhaoyuan17 已提交
1770

X
xuzhihao 已提交
1771
getActiveNotificationCount(callback: AsyncCallback\<number\>): void
Z
zhaoyuan17 已提交
1772

R
RayShih 已提交
1773
获取当前应用的活动通知数(Callback形式)。
Z
zhaoyuan17 已提交
1774

X
xuzhihao 已提交
1775
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1776

X
xuzhihao 已提交
1777
**参数:**
Z
zhaoyuan17 已提交
1778

X
xuzhihao 已提交
1779 1780 1781
| 名称     | 可读 | 可写 | 类型                   | 必填 | 描述                   |
| -------- | ---- | --- | ---------------------- | ---- | ---------------------- |
| callback | 是   | 否  | AsyncCallback\<number\> | 是   | 获取活动通知数回调函数。 |
Z
zhaoyuan17 已提交
1782

X
xuzhihao 已提交
1783
**示例:**
Z
zhaoyuan17 已提交
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794

```js
function getActiveNotificationCountCallback(err, data) {
	console.info("==========================>getActiveNotificationCountCallback=======================>");
}

Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
```



X
xuzhihao 已提交
1795
## Notification.getActiveNotificationCount
Z
zhaoyuan17 已提交
1796

X
xuzhihao 已提交
1797
getActiveNotificationCount(): Promise\<number\>
Z
zhaoyuan17 已提交
1798

R
RayShih 已提交
1799
获取当前应用的活动通知数(Promise形式)。
Z
zhaoyuan17 已提交
1800

X
xuzhihao 已提交
1801
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1802

X
xuzhihao 已提交
1803
**返回值:**
Z
zhaoyuan17 已提交
1804

X
xuzhihao 已提交
1805 1806 1807
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<number\> | 以Promise形式返回获取当前应用的活动通知数。 |
Z
zhaoyuan17 已提交
1808

X
xuzhihao 已提交
1809
**示例:**
Z
zhaoyuan17 已提交
1810 1811 1812 1813 1814 1815 1816 1817 1818

```js
Notification.getActiveNotificationCount().then((data) => {
	console.info("==========================>getActiveNotificationCountCallback=======================>");
});
```



X
xuzhihao 已提交
1819
## Notification.getActiveNotifications
Z
zhaoyuan17 已提交
1820

X
xuzhihao 已提交
1821
getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>): void
Z
zhaoyuan17 已提交
1822

R
RayShih 已提交
1823
获取当前应用的活动通知(Callback形式)。
Z
zhaoyuan17 已提交
1824

X
xuzhihao 已提交
1825
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1826

X
xuzhihao 已提交
1827
**参数:**
Z
zhaoyuan17 已提交
1828

X
xuzhihao 已提交
1829 1830 1831
| 名称     | 可读 | 可写 | 类型                                                         | 必填 | 描述                           |
| -------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------------------ |
| callback | 是   | 否  | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是   | 获取当前应用的活动通知回调函数。 |
Z
zhaoyuan17 已提交
1832

X
xuzhihao 已提交
1833
**示例:**
Z
zhaoyuan17 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844

```js
function getActiveNotificationsCallback(err, data) {
	console.info("==========================>getActiveNotificationsCallback=======================>");
}

Notification.getActiveNotifications(getActiveNotificationsCallback);
```



X
xuzhihao 已提交
1845
## Notification.getActiveNotifications
Z
zhaoyuan17 已提交
1846

X
xuzhihao 已提交
1847
getActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)\>\>
Z
zhaoyuan17 已提交
1848

R
RayShih 已提交
1849
获取当前应用的活动通知(Promise形式)。
Z
zhaoyuan17 已提交
1850

X
xuzhihao 已提交
1851
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1852

X
xuzhihao 已提交
1853
**返回值:**
Z
zhaoyuan17 已提交
1854

X
xuzhihao 已提交
1855 1856 1857
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取当前应用的活动通知。 |
Z
zhaoyuan17 已提交
1858

X
xuzhihao 已提交
1859
**示例:**
Z
zhaoyuan17 已提交
1860 1861 1862 1863 1864 1865 1866 1867 1868

```js
Notification.getActiveNotifications().then((data) => {
	console.info("==========================>getActiveNotificationsCallback=======================>");
});
```



1869
## Notification.cancelGroup<sup>8+</sup>
Z
zhaoyuan17 已提交
1870

X
xuzhihao 已提交
1871
cancelGroup(groupName: string, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1872

R
RayShih 已提交
1873
取消本应用指定组通知(Callback形式)。
Z
zhaoyuan17 已提交
1874

X
xuzhihao 已提交
1875
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1876

X
xuzhihao 已提交
1877
**参数:**
Z
zhaoyuan17 已提交
1878

X
xuzhihao 已提交
1879 1880 1881 1882
| 名称      | 可读 | 可写 | 类型                  | 必填 | 描述                         |
| --------- | ---- | --- | --------------------- | ---- | ---------------------------- |
| groupName | 是   | 否  | string                | 是   | 指定通知组名称。               |
| callback  | 是   | 否  | AsyncCallback\<void\> | 是   | 取消本应用指定组通知回调函数。 |
Z
zhaoyuan17 已提交
1883

X
xuzhihao 已提交
1884
**示例:**
Z
zhaoyuan17 已提交
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897

```js
function cancelGroupCallback(err) {
   console.info("==========================>cancelGroupCallback=======================>");
}

var groupName = "GroupName";

Notification.cancelGroup(groupName, cancelGroupCallback);
```



1898
## Notification.cancelGroup<sup>8+</sup>
Z
zhaoyuan17 已提交
1899

X
xuzhihao 已提交
1900
cancelGroup(groupName: string): Promise\<void\>
Z
zhaoyuan17 已提交
1901

R
RayShih 已提交
1902
取消本应用指定组通知(Promise形式)。
Z
zhaoyuan17 已提交
1903

X
xuzhihao 已提交
1904
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1905

X
xuzhihao 已提交
1906
**参数:**
Z
zhaoyuan17 已提交
1907

X
xuzhihao 已提交
1908 1909 1910
| 名称      | 可读 | 可写 | 类型   | 必填 | 描述           |
| --------- | ---- | --- | ------ | ---- | -------------- |
| groupName | 是   | 否  | string | 是   | 指定通知组名称。 |
Z
zhaoyuan17 已提交
1911

X
xuzhihao 已提交
1912
**示例:**
Z
zhaoyuan17 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922

```js
var groupName = "GroupName";
Notification.cancelGroup(groupName).then(() => {
	console.info("==========================>cancelGroupPromise=======================>");
});
```



1923
## Notification.removeGroupByBundle<sup>8+</sup>
Z
zhaoyuan17 已提交
1924

X
xuzhihao 已提交
1925
removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1926

R
RayShih 已提交
1927
删除指定应用指定组通知(Callback形式)。
Z
zhaoyuan17 已提交
1928

X
xuzhihao 已提交
1929
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1930

X
xuzhihao 已提交
1931 1932 1933
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1935
**参数:**
Z
zhaoyuan17 已提交
1936

X
xuzhihao 已提交
1937 1938 1939 1940 1941
| 名称      | 可读 | 可写 | 类型                  | 必填 | 描述                         |
| --------- | ---- | --- | --------------------- | ---- | ---------------------------- |
| bundle    | 是   | 否  | [BundleOption](#bundleoption)          | 是   | 指定包信息。                   |
| groupName | 是   | 否  | string                | 是   | 指定通知组名称。               |
| callback  | 是   | 否  | AsyncCallback\<void\> | 是   | 删除本应用指定组通知回调函数。 |
Z
zhaoyuan17 已提交
1942

X
xuzhihao 已提交
1943
**示例:**
Z
zhaoyuan17 已提交
1944 1945 1946 1947 1948 1949

```js
function removeGroupByBundleCallback(err) {
   console.info("==========================>removeGroupByBundleCallback=======================>");
}

X
xuchenghua09 已提交
1950
var bundleOption = {bundle: "Bundle"};
Z
zhaoyuan17 已提交
1951 1952 1953 1954 1955 1956 1957
var groupName = "GroupName";

Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
```



1958
## Notification.removeGroupByBundle<sup>8+</sup>
Z
zhaoyuan17 已提交
1959

X
xuzhihao 已提交
1960
removeGroupByBundle(bundle: BundleOption, groupName: string): Promise\<void\>
Z
zhaoyuan17 已提交
1961

R
RayShih 已提交
1962
删除指定应用指定组通知(Promise形式)。
Z
zhaoyuan17 已提交
1963

X
xuzhihao 已提交
1964
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1965

X
xuzhihao 已提交
1966 1967 1968
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1970
**参数:**
Z
zhaoyuan17 已提交
1971

X
xuzhihao 已提交
1972 1973 1974 1975
| 名称      | 可读 | 可写 | 类型         | 必填 | 描述           |
| --------- | ---- | --- | ------------ | ---- | -------------- |
| bundle    | 是   | 否  | [BundleOption](#bundleoption) | 是   | 指定包信息。     |
| groupName | 是   | 否  | string       | 是   | 指定通知组名称。 |
Z
zhaoyuan17 已提交
1976

X
xuzhihao 已提交
1977
**示例:**
Z
zhaoyuan17 已提交
1978 1979

```js
X
xuchenghua09 已提交
1980
var bundleOption = {bundle: "Bundle"};
Z
zhaoyuan17 已提交
1981 1982 1983 1984 1985 1986 1987 1988
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
	console.info("==========================>removeGroupByBundlePromise=======================>");
});
```



1989
## Notification.setDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
1990

X
xuzhihao 已提交
1991
setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1992

R
RayShih 已提交
1993
设置免打扰时间(Callback形式)。
Z
zhaoyuan17 已提交
1994

X
xuzhihao 已提交
1995
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
1996

X
xuzhihao 已提交
1997 1998 1999
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2001
**参数:**
Z
zhaoyuan17 已提交
2002

X
xuzhihao 已提交
2003 2004
| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                   |
| -------- | ---- | --- | --------------------- | ---- | ---------------------- |
2005
| date     | 是   | 否  | [DoNotDisturbDate](#donotdisturbdate8)      | 是   | 免打扰时间选项。         |
X
xuzhihao 已提交
2006
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |
Z
zhaoyuan17 已提交
2007

X
xuzhihao 已提交
2008
**示例:**
Z
zhaoyuan17 已提交
2009 2010 2011 2012 2013 2014 2015

```js
function setDoNotDisturbDateCallback(err) {
   console.info("==========================>setDoNotDisturbDateCallback=======================>");
}

var doNotDisturbDate = {
Z
zengsiyu 已提交
2016
    type: Notification.DoNotDisturbType.TYPE_ONCE,
X
xuchenghua09 已提交
2017 2018
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
Z
zhaoyuan17 已提交
2019 2020 2021 2022 2023 2024 2025
}

Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
```



2026
## Notification.setDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2027

X
xuzhihao 已提交
2028
setDoNotDisturbDate(date: DoNotDisturbDate): Promise\<void\>
Z
zhaoyuan17 已提交
2029

R
RayShih 已提交
2030
设置免打扰时间接口(Promise形式)。
Z
zhaoyuan17 已提交
2031

X
xuzhihao 已提交
2032
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2033

X
xuzhihao 已提交
2034 2035 2036
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2038
**参数:**
Z
zhaoyuan17 已提交
2039

X
xuzhihao 已提交
2040 2041
| 名称 | 可读 | 可写 | 类型             | 必填 | 描述           |
| ---- | ---- | --- | ---------------- | ---- | -------------- |
2042
| date | 是   | 否  | [DoNotDisturbDate](#donotdisturbdate8) | 是   | 免打扰时间选项。 |
Z
zhaoyuan17 已提交
2043

X
xuzhihao 已提交
2044
**示例:**
Z
zhaoyuan17 已提交
2045 2046 2047

```js
var doNotDisturbDate = {
Z
zengsiyu 已提交
2048
    type: Notification.DoNotDisturbType.TYPE_ONCE,
X
xuchenghua09 已提交
2049 2050
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
Z
zhaoyuan17 已提交
2051 2052 2053 2054 2055 2056 2057
}
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
	console.info("==========================>setDoNotDisturbDatePromise=======================>");
});
```


2058 2059 2060 2061
## Notification.setDoNotDisturbDate<sup>8+</sup>

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

R
RayShih 已提交
2062
指定用户设置免打扰时间(Callback形式)。
2063 2064 2065

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

X
xuzhihao 已提交
2066 2067 2068
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2070 2071 2072 2073
**参数:**

| 名称     | 可读 | 可写 | 类型                  | 必填 | 描述                   |
| -------- | ---- | --- | --------------------- | ---- | ---------------------- |
2074
| date     | 是   | 否  | [DoNotDisturbDate](#donotdisturbdate8)      | 是   | 免打扰时间选项。         |
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
| userId   | 是   | 否  | number                | 是   | 设置免打扰事件的用户ID。 |
| callback | 是   | 否  | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |

**示例:**

```js
function setDoNotDisturbDateCallback(err) {
   console.info("==========================>setDoNotDisturbDateCallback=======================>");
}

var doNotDisturbDate = {
    type: Notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
}

var userId = 1

Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
```



## Notification.setDoNotDisturbDate<sup>8+</sup>

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

R
RayShih 已提交
2102
指定用户设置免打扰时间接口(Promise形式)。
2103 2104 2105

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

X
xuzhihao 已提交
2106 2107 2108
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2110 2111 2112 2113
**参数:**

| 名称   | 可读 | 可写 | 类型             | 必填 | 描述           |
| ------ | ---- | --- | ---------------- | ---- | -------------- |
2114
| date   | 是   | 否  | [DoNotDisturbDate](#donotdisturbdate8) | 是   | 免打扰时间选项。 |
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
| userId | 是   | 否  | number           | 是   | 设置免打扰事件的用户ID。 |

**示例:**

```js
var doNotDisturbDate = {
    type: Notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
}

var userId = 1

Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
	console.info("==========================>setDoNotDisturbDatePromise=======================>");
});
```

Z
zhaoyuan17 已提交
2133

2134
## Notification.getDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2135

X
xuzhihao 已提交
2136
getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>): void
Z
zhaoyuan17 已提交
2137

R
RayShih 已提交
2138
查询免打扰时间接口(Callback形式)。
Z
zhaoyuan17 已提交
2139

X
xuzhihao 已提交
2140
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2141

X
xuzhihao 已提交
2142 2143 2144
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2146
**参数:**
Z
zhaoyuan17 已提交
2147

X
xuzhihao 已提交
2148 2149
| 名称     | 可读 | 可写 | 类型                              | 必填 | 描述                   |
| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- |
2150
| callback | 是   | 否  | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是   | 查询免打扰时间回调函数。 |
Z
zhaoyuan17 已提交
2151

X
xuzhihao 已提交
2152
**示例:**
Z
zhaoyuan17 已提交
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

```js
function getDoNotDisturbDateCallback(err,data) {
   console.info("==========================>getDoNotDisturbDateCallback=======================>");
}

Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
```



2164
## Notification.getDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2165

X
xuzhihao 已提交
2166
getDoNotDisturbDate(): Promise\<DoNotDisturbDate\>
Z
zhaoyuan17 已提交
2167

R
RayShih 已提交
2168
查询免打扰时间接口(Promise形式)。
Z
zhaoyuan17 已提交
2169

X
xuzhihao 已提交
2170
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2171

X
xuzhihao 已提交
2172 2173 2174
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2176
**返回值:**
Z
zhaoyuan17 已提交
2177

X
xuzhihao 已提交
2178 2179
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
2180
| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 |
Z
zhaoyuan17 已提交
2181

X
xuzhihao 已提交
2182
**示例:**
Z
zhaoyuan17 已提交
2183 2184 2185 2186 2187 2188 2189 2190

```js
Notification.getDoNotDisturbDate().then((data) => {
	console.info("==========================>getDoNotDisturbDatePromise=======================>");
});
```


2191 2192 2193 2194
## Notification.getDoNotDisturbDate<sup>8+</sup>

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

R
RayShih 已提交
2195
指定用户查询免打扰时间接口(Callback形式)。
2196 2197 2198

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

X
xuzhihao 已提交
2199 2200 2201 2202
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2203 2204 2205 2206
**参数:**

| 名称     | 可读 | 可写 | 类型                              | 必填 | 描述                   |
| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- |
2207
| callback | 是   | 否  | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是   | 查询免打扰时间回调函数。 |
2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
| userId   | 是   | 否  | number                            | 是   | 设置免打扰事件的用户ID。 |

**示例:**

```js
function getDoNotDisturbDateCallback(err,data) {
   console.info("==========================>getDoNotDisturbDateCallback=======================>");
}

var userId = 1

Notification.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
```



## Notification.getDoNotDisturbDate<sup>8+</sup>

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

R
RayShih 已提交
2228
指定用户查询免打扰时间接口(Promise形式)。
2229 2230 2231

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

X
xuzhihao 已提交
2232 2233 2234 2235
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
**参数:**

| 名称     | 可读 | 可写 | 类型                              | 必填 | 描述                   |
| -------- | ---- | --- | --------------------------------- | ---- | ---------------------- |
| userId   | 是   | 否  | number                            | 是   | 设置免打扰事件的用户ID。 |

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
2246
| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询免打扰时间接口。 |
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257

**示例:**

```js
var userId = 1

Notification.getDoNotDisturbDate(userId).then((data) => {
	console.info("==========================>getDoNotDisturbDatePromise=======================>");
});
```

Z
zhaoyuan17 已提交
2258

2259
## Notification.supportDoNotDisturbMode<sup>8+</sup>
Z
zhaoyuan17 已提交
2260

X
xuzhihao 已提交
2261
supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>): void
Z
zhaoyuan17 已提交
2262

R
RayShih 已提交
2263
查询是否支持勿扰模式功能(Callback形式)。
Z
zhaoyuan17 已提交
2264

X
xuzhihao 已提交
2265
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2266

X
xuzhihao 已提交
2267 2268 2269
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2271
**参数:**
Z
zhaoyuan17 已提交
2272

X
xuzhihao 已提交
2273 2274 2275
| 名称     | 可读 | 可写 | 类型                     | 必填 | 描述                             |
| -------- | ---- | --- | ------------------------ | ---- | -------------------------------- |
| callback | 是   | 否  | AsyncCallback\<boolean\> | 是   | 查询是否支持勿扰模式功能回调函数。 |
Z
zhaoyuan17 已提交
2276

X
xuzhihao 已提交
2277
**示例:**
Z
zhaoyuan17 已提交
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288

```js
function supportDoNotDisturbModeCallback(err,data) {
   console.info("==========================>supportDoNotDisturbModeCallback=======================>");
}

Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
```



2289
## Notification.supportDoNotDisturbMode<sup>8+</sup>
Z
zhaoyuan17 已提交
2290

X
xuzhihao 已提交
2291
supportDoNotDisturbMode(): Promise\<boolean\>
Z
zhaoyuan17 已提交
2292

R
RayShih 已提交
2293
查询是否支持勿扰模式功能(Promise形式)。
Z
zhaoyuan17 已提交
2294

X
xuzhihao 已提交
2295
**系统能力**:SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2296

X
xuzhihao 已提交
2297 2298 2299
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2301
**返回值:**
Z
zhaoyuan17 已提交
2302

X
xuzhihao 已提交
2303 2304 2305
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取是否支持勿扰模式功能的结果。 |
Z
zhaoyuan17 已提交
2306

X
xuzhihao 已提交
2307
**示例:**
Z
zhaoyuan17 已提交
2308 2309 2310 2311 2312 2313 2314 2315 2316

```js
Notification.supportDoNotDisturbMode().then((data) => {
	console.info("==========================>supportDoNotDisturbModePromise=======================>");
});
```



2317
## Notification.isSupportTemplate<sup>8+</sup>
Z
zengsiyu 已提交
2318 2319 2320

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

F
fangjinliang 已提交
2321
查询模板是否存在(Callback形式)。
Z
zengsiyu 已提交
2322

X
xuzhihao 已提交
2323 2324 2325
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2326 2327 2328

| 参数名       | 类型                     | 必填 | 说明                       |
| ------------ | ------------------------ | ---- | -------------------------- |
X
xuzhihao 已提交
2329 2330
| templateName | string                   | 是   | 模板名称。                   |
| callback     | AsyncCallback\<boolean\> | 是   | 查询模板是否存在的回调函数。 |
Z
zengsiyu 已提交
2331

X
xuzhihao 已提交
2332
**示例:**
Z
zengsiyu 已提交
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344

```javascript
var templateName = 'process';
function isSupportTemplateCallback(err, data) {
    console.info("isSupportTemplateCallback");
}

Notification.isSupportTemplate(templateName, isSupportTemplateCallback);
```



2345
## Notification.isSupportTemplate<sup>8+</sup>
Z
zengsiyu 已提交
2346 2347 2348

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

F
fangjinliang 已提交
2349
查询模板是否存在(Promise形式)。
Z
zengsiyu 已提交
2350

X
xuzhihao 已提交
2351 2352 2353
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2354 2355 2356

| 参数名       | 类型   | 必填 | 说明     |
| ------------ | ------ | ---- | -------- |
X
xuzhihao 已提交
2357
| templateName | string | 是   | 模板名称。 |
Z
zengsiyu 已提交
2358

X
xuzhihao 已提交
2359
**返回值:**
Z
zengsiyu 已提交
2360 2361 2362

| 类型               | 说明            |
| ------------------ | --------------- |
X
xuzhihao 已提交
2363
| Promise\<boolean\> | Promise方式返回模板是否存在的结果。 |
Z
zengsiyu 已提交
2364

X
xuzhihao 已提交
2365
**示例:**
Z
zengsiyu 已提交
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376

```javascript
var templateName = 'process';

Notification.isSupportTemplate(templateName).then((data) => {
    console.info("isSupportTemplateCallback");
});
```



2377
## Notification.requestEnableNotification<sup>8+</sup>
Z
zengsiyu 已提交
2378

X
xuzhihao 已提交
2379
requestEnableNotification(callback: AsyncCallback\<void\>): void
Z
zengsiyu 已提交
2380

F
fangjinliang 已提交
2381
应用请求通知使能(Callback形式)。
Z
zengsiyu 已提交
2382

X
xuzhihao 已提交
2383 2384 2385
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2386 2387 2388

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

X
xuzhihao 已提交
2391
**示例:**
Z
zengsiyu 已提交
2392 2393

```javascript
2394
function requestEnableNotificationCallback() {
2395
    console.log('------------- requestEnabledNotification --------------');
Z
zengsiyu 已提交
2396 2397
};

2398
Notification.requestEnableNotification(requestEnableNotificationCallback);
Z
zengsiyu 已提交
2399 2400 2401 2402
```



2403
## Notification.requestEnableNotification<sup>8+</sup>
Z
zengsiyu 已提交
2404

X
xuzhihao 已提交
2405
requestEnableNotification(): Promise\<void\>
Z
zengsiyu 已提交
2406

F
fangjinliang 已提交
2407
应用请求通知使能(Promise形式)。
Z
zengsiyu 已提交
2408

X
xuzhihao 已提交
2409 2410 2411
**系统能力**:SystemCapability.Notification.Notification

**示例:**
Z
zengsiyu 已提交
2412 2413

```javascript
2414
Notification.requestEnableNotification()
Z
zengsiyu 已提交
2415
    .then(() => {
2416
        console.info("requestEnableNotification ");
Z
zengsiyu 已提交
2417 2418 2419 2420
	});
```


2421
## Notification.enableDistributed<sup>8+</sup>
X
xuzhihao 已提交
2422

2423
enableDistributed(enable: boolean, callback: AsyncCallback\<void\>): void
X
xuzhihao 已提交
2424

F
fangjinliang 已提交
2425
设置设备是否支持分布式通知(Callback形式)。
X
xuzhihao 已提交
2426 2427 2428

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

X
xuzhihao 已提交
2429 2430 2431
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2433 2434
**参数:**

2435 2436 2437 2438
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| enable   | boolean                  | 是   | 是否支持。<br/>true 支持。<br/>false 不支持。|
| callback | AsyncCallback\<void\> | 是   | 设置设备是否支持分布式通知的回调函数。 |
X
xuzhihao 已提交
2439 2440 2441 2442

**示例:**

```javascript
2443 2444
function enabledNotificationCallback() {
    console.log('----------- enableDistributed ------------');
X
xuzhihao 已提交
2445 2446
};

2447 2448 2449
var enable = true

Notification.enableDistributed(enable, enabledNotificationCallback);
X
xuzhihao 已提交
2450 2451 2452
```


Z
zengsiyu 已提交
2453

2454
## Notification.enableDistributed<sup>8+</sup>
Z
zengsiyu 已提交
2455

X
xuzhihao 已提交
2456
enableDistributed(enable: boolean): Promise\<void>
X
xuezhongzhu 已提交
2457

F
fangjinliang 已提交
2458
设置设备是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2459

2460
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2461

X
xuzhihao 已提交
2462 2463 2464
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2466
**参数:**
Z
zengsiyu 已提交
2467

2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| enable   | boolean                  | 是   | 是否支持。<br/>true 支持。<br/>false 不支持。|

**示例:**

```javascript
var enable = true

Notification.enableDistributed(enable)
    .then(() => {
        console.log('-------- enableDistributed ----------');
    });
```


## Notification.isDistributedEnabled<sup>8+</sup>

X
xuzhihao 已提交
2486
isDistributedEnabled(callback: AsyncCallback\<boolean>): void
2487

F
fangjinliang 已提交
2488
获取设备是否支持分布式通知(Callback形式)。
Z
zengsiyu 已提交
2489

X
xuzhihao 已提交
2490 2491 2492
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2493

2494 2495 2496
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
| callback | AsyncCallback\<boolean\> | 是   | 设备是否支持分布式通知的回调函数。 |
Z
zengsiyu 已提交
2497

X
xuzhihao 已提交
2498
**示例:**
Z
zengsiyu 已提交
2499 2500

```javascript
2501 2502
function isDistributedEnabledCallback() {
    console.log('----------- isDistributedEnabled ------------');
Z
zengsiyu 已提交
2503 2504
};

2505
Notification.isDistributedEnabled(isDistributedEnabledCallback);
Z
zengsiyu 已提交
2506 2507 2508 2509
```



2510
## Notification.isDistributedEnabled<sup>8+</sup>
X
xuezhongzhu 已提交
2511

X
xuzhihao 已提交
2512
isDistributedEnabled(): Promise\<boolean>
Z
zengsiyu 已提交
2513

F
fangjinliang 已提交
2514
获取设备是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2515

2516
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2517

2518
**返回值:**
Z
zengsiyu 已提交
2519

2520 2521 2522
| 类型               | 说明            |
| ------------------ | --------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。<br/>true 支持。<br/>false 不支持。 |
Z
zengsiyu 已提交
2523

2524
**示例:**
X
xuezhongzhu 已提交
2525

2526 2527 2528 2529 2530 2531
```javascript
Notification.isDistributedEnabled()
    .then((data) => {
        console.log('-------- isDistributedEnabled ----------');
    });
```
Z
zengsiyu 已提交
2532 2533


2534
## Notification.enableDistributedByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2535

X
xuzhihao 已提交
2536
enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void>): void
Z
zengsiyu 已提交
2537

F
fangjinliang 已提交
2538
根据应用的包设置应用程序是否支持分布式通知(Callback形式)。
X
xuezhongzhu 已提交
2539

2540
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2541

X
xuzhihao 已提交
2542 2543 2544
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2546
**参数:**
Z
zengsiyu 已提交
2547

2548 2549
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2550
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                     |
2551 2552
| enable   | boolean                  | 是   | 是否支持。                       |
| callback | AsyncCallback\<void\> | 是   | 应用程序是否支持分布式通知的回调函数。 |
Z
zengsiyu 已提交
2553

2554
**示例:**
Z
zengsiyu 已提交
2555

2556 2557 2558 2559
```javascript
function enableDistributedByBundleCallback() {
    console.log('----------- enableDistributedByBundle ------------');
};
Z
zengsiyu 已提交
2560

2561 2562 2563
var bundle = {
    bundle: "bundleName1",
}
X
xuezhongzhu 已提交
2564

2565
var enable = true
Z
zengsiyu 已提交
2566

2567 2568
Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundleCallback);
```
Z
zengsiyu 已提交
2569 2570 2571



2572
## Notification.enableDistributedByBundle<sup>8+</sup>
X
xuezhongzhu 已提交
2573

X
xuzhihao 已提交
2574
enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\<void>
Z
zengsiyu 已提交
2575

F
fangjinliang 已提交
2576
根据应用的包设置应用程序是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2577

2578
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2579

X
xuzhihao 已提交
2580 2581 2582
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2584
**参数:**
Z
zengsiyu 已提交
2585

2586 2587
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2588
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |
2589
| enable   | boolean                  | 是   | 是否支持。                  |
X
xuezhongzhu 已提交
2590

2591
**示例:**
Z
zengsiyu 已提交
2592

2593 2594 2595 2596
```javascript
var bundle = {
    bundle: "bundleName1",
}
Z
zengsiyu 已提交
2597

2598
var enable = true
X
xuezhongzhu 已提交
2599

2600 2601 2602 2603 2604
Notification.enableDistributedByBundle(bundle, enable)
    .then(() => {
        console.log('-------- enableDistributedByBundle ----------');
    });
```
Z
zengsiyu 已提交
2605

2606
## Notification.isDistributedEnabledByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2607

X
xuzhihao 已提交
2608
isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback\<boolean>): void
Z
zengsiyu 已提交
2609

F
fangjinliang 已提交
2610
根据应用的包获取应用程序是否支持分布式通知(Callback形式)。
Z
zengsiyu 已提交
2611

2612
**系统能力**:SystemCapability.Notification.Notification
X
xuezhongzhu 已提交
2613

X
xuzhihao 已提交
2614 2615 2616
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2618
**参数:**
Z
zengsiyu 已提交
2619

2620 2621
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2622
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                     |
2623
| callback | AsyncCallback\<boolean\> | 是   | 应用程序是否支持分布式通知的回调函数。 |
Z
zengsiyu 已提交
2624

2625
**示例:**
Z
zengsiyu 已提交
2626

2627 2628 2629 2630
```javascript
function isDistributedEnabledByBundleCallback(data) {
    console.log('----------- isDistributedEnabledByBundle ------------', data);
};
Z
zengsiyu 已提交
2631

2632 2633 2634
var bundle = {
    bundle: "bundleName1",
}
X
xuezhongzhu 已提交
2635

2636
Notification.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
2637
```
Z
zengsiyu 已提交
2638 2639 2640



2641
## Notification.isDistributedEnabledByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2642

X
xuzhihao 已提交
2643
isDistributedEnabledByBundle(bundle: BundleOption): Promise\<boolean>
X
xuezhongzhu 已提交
2644

F
fangjinliang 已提交
2645
根据应用的包获取应用程序是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2646

2647
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2648

X
xuzhihao 已提交
2649 2650 2651
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2653
**参数:**
Z
zengsiyu 已提交
2654

2655 2656
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2657
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |
Z
zengsiyu 已提交
2658

2659
**返回值:**
X
xuezhongzhu 已提交
2660

2661 2662 2663
| 类型               | 说明            |
| ------------------ | --------------- |
| Promise\<boolean\> | Promise方式返回应用程序是否支持分布式通知的结果。<br/>true 支持。<br/>false 不支持。 |
Z
zengsiyu 已提交
2664

2665
**示例:**
Z
zengsiyu 已提交
2666

2667 2668 2669 2670
```javascript
var bundle = {
    bundle: "bundleName1",
}
Z
zengsiyu 已提交
2671

2672 2673 2674 2675 2676
Notification.isDistributedEnabledByBundle(bundle)
    .then((data) => {
        console.log('-------- isDistributedEnabledByBundle ----------', data);
    });
```
Z
zengsiyu 已提交
2677

X
xuezhongzhu 已提交
2678

2679
## Notification.getDeviceRemindType<sup>8+</sup>
Z
zengsiyu 已提交
2680

X
xuzhihao 已提交
2681
getDeviceRemindType(callback: AsyncCallback\<DeviceRemindType\>): void
Z
zengsiyu 已提交
2682

F
fangjinliang 已提交
2683
获取通知的提醒方式(Callback形式)。
Z
zengsiyu 已提交
2684

2685
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2686

X
xuzhihao 已提交
2687 2688 2689
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2691
**参数:**
X
xuezhongzhu 已提交
2692

2693 2694
| 参数名   | 类型                               | 必填 | 说明                       |
| -------- | --------------------------------- | ---- | -------------------------- |
R
RayShih 已提交
2695
| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype8)\> | 是   | 获取通知的提醒方式的回调函数。 |
Z
zengsiyu 已提交
2696

2697
**示例:**
Z
zengsiyu 已提交
2698

2699 2700 2701 2702
```javascript
function getDeviceRemindTypeCallback(data) {
    console.log('----------- getDeviceRemindType ------------', data);
};
Z
zengsiyu 已提交
2703

2704 2705
Notification.getDeviceRemindType(getDeviceRemindTypeCallback);
```
Z
zengsiyu 已提交
2706

X
xuezhongzhu 已提交
2707

Z
zengsiyu 已提交
2708

2709
## Notification.getDeviceRemindType<sup>8+</sup>
Z
zengsiyu 已提交
2710

X
xuzhihao 已提交
2711
getDeviceRemindType(): Promise\<DeviceRemindType\>
Z
zengsiyu 已提交
2712

F
fangjinliang 已提交
2713
获取通知的提醒方式(Promise形式)。
Z
zengsiyu 已提交
2714

2715
**系统能力**:SystemCapability.Notification.Notification
X
xuezhongzhu 已提交
2716

X
xuzhihao 已提交
2717 2718 2719
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2721
**返回值:**
Z
zengsiyu 已提交
2722

2723 2724
| 类型               | 说明            |
| ------------------ | --------------- |
R
RayShih 已提交
2725
| Promise\<[DeviceRemindType](#deviceremindtype8)\> | Promise方式返回通知的提醒方式的结果。 |
Z
zengsiyu 已提交
2726

2727
**示例:**
Z
zengsiyu 已提交
2728

2729 2730 2731 2732 2733 2734
```javascript
Notification.getDeviceRemindType()
    .then((data) => {
        console.log('-------- getDeviceRemindType ----------', data);
    });
```
Z
zengsiyu 已提交
2735

X
xuzhihao 已提交
2736

2737 2738 2739 2740 2741 2742 2743 2744
## Notification.publishAsBundle<sup>9+</sup>

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

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

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

X
xuzhihao 已提交
2745
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER
2746

X
xuzhihao 已提交
2747
**系统API**: 此接口为系统接口,三方应用不支持调用。
2748

X
xuzhihao 已提交
2749
**参数:**
2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781

| 参数名               | 类型                                        | 必填 | 说明                                          |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
| request              | [NotificationRequest](#notificationrequest) | 是   | 设置要发布通知内容的NotificationRequest对象。 |
| representativeBundle | string                                      | 是   | 被代理应用的包名。                            |
| userId               | number                                      | 是   | 接收通知用户的Id。                            |
| callback             | AsyncCallback                               | 是   | 发布代理通知的回调方法。                      |

**示例:**

```js
//publishAsBundle回调
function publishAsBundleCallback(err) {
	console.info("==========================>publishAsBundleCallback=======================>");
}
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
//通知Request对象
let notificationRequest = {
    id: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}

2782
Notification.publishAsBundle(notificationRequest, representativeBundle, userId, publishAsBundleCallback);
2783 2784 2785 2786 2787 2788 2789 2790 2791 2792
```

## Notification.publishAsBundle<sup>9+</sup>

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

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

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

X
xuzhihao 已提交
2793 2794 2795
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

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

2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
**参数:**


| 参数名               | 类型                                        | 必填 | 说明                                          |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
| request              | [NotificationRequest](#notificationrequest) | 是   | 设置要发布通知内容的NotificationRequest对象。 |
| representativeBundle | string                                      | 是   | 被代理应用的包名。                            |
| userId               | number                                      | 是   | 接收通知用户的Id。                            |

**示例:**

```js
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
//通知Request对象
var notificationRequest = {
    id: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
}

Notification.publishAsBundle(notificationRequest, representativeBundle, userId).then(() => {
	console.info("==========================>publishAsBundleCallback=======================>");
});
```

## Notification.cancelAsBundle<sup>9+</sup>

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

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

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

X
xuzhihao 已提交
2839 2840
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
**参数:**


| 参数名               | 类型          | 必填 | 说明                     |
| -------------------- | ------------- | ---- | ------------------------ |
| id                   | number        | 是   | 通知ID。                 |
| representativeBundle | string        | 是   | 被代理应用的包名。       |
| userId               | number        | 是   | 接收通知用户的Id。       |
| callback             | AsyncCallback | 是   | 取消代理通知的回调方法。 |

**示例:**

```js
//cancelAsBundle
function cancelAsBundleCallback(err) {
	console.info("==========================>cancelAsBundleCallback=======================>");
}
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100

2863
Notification.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
2864 2865 2866 2867
```

## Notification.cancelAsBundle<sup>9+</sup>

X
xuzhihao 已提交
2868
cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise\<void\>
2869 2870 2871 2872 2873

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

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

X
xuzhihao 已提交
2874 2875
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER

2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
**参数:**


| 参数名               | 类型   | 必填 | 说明               |
| -------------------- | ------ | ---- | ------------------ |
| id                   | number | 是   | 通知ID。           |
| representativeBundle | string | 是   | 被代理应用的包名。 |
| userId               | number | 是   | 接收通知用户的Id。 |

**示例:**

```js
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100

Notification.cancelAsBundle(0, representativeBundle, userId).then(() => {
	console.info("==========================>cancelAsBundleCallback=======================>");
});
```

F
fangjinliang 已提交
2898
## Notification.enableNotificationSlot <sup>9+</sup>
F
fangjinliang 已提交
2899 2900 2901 2902 2903 2904 2905

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

设定指定类型的渠道使能状态(Callback形式)。

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

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

X
xuzhihao 已提交
2908 2909
**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

F
fangjinliang 已提交
2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
| bundle   | [BundleOption](#bundleoption) | 是   | 指定包信息。           |
| type     | [SlotType](#slottype)         | 是   | 指定渠道类型。         |
| enable   | boolean                       | 是   | 使能状态。             |
| callback | AsyncCallback\<void\>         | 是   | 设定渠道使能回调函数。 |

**示例:**

```js
//enableNotificationSlot
function enableSlotCallback(err) {
    console.log('===================>enableSlotCallback==================>');
};

Notification.enableNotificationSlot(
    { bundle: "ohos.samples.notification", },
X
xuzhihao 已提交
2929
    Notification.SlotType.SOCIAL_COMMUNICATION,
F
fangjinliang 已提交
2930 2931 2932 2933
    true,
    enableSlotCallback);
```

F
fangjinliang 已提交
2934
## Notification.enableNotificationSlot <sup>9+</sup>
F
fangjinliang 已提交
2935

X
xuzhihao 已提交
2936
enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise\<void> 
F
fangjinliang 已提交
2937 2938 2939 2940 2941

设定指定类型的渠道使能状态(Promise形式)。

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

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

X
xuzhihao 已提交
2944 2945
**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

F
fangjinliang 已提交
2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959
**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| bundle | [BundleOption](#bundleoption) | 是   | 指定包信息。   |
| type   | [SlotType](#slottype)         | 是   | 指定渠道类型。 |
| enable | boolean                       | 是   | 使能状态。     |

**示例:**

```js
//enableNotificationSlot
Notification.enableNotificationSlot(
    { bundle: "ohos.samples.notification", },
X
xuzhihao 已提交
2960
    Notification.SlotType.SOCIAL_COMMUNICATION,
F
fangjinliang 已提交
2961 2962 2963 2964 2965
    true).then(() => {
        console.log('====================>enableNotificationSlot====================>');
    });
```

F
fangjinliang 已提交
2966
## Notification.isNotificationSlotEnabled <sup>9+</sup>
F
fangjinliang 已提交
2967

X
xuzhihao 已提交
2968
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback\<boolean\>): void
F
fangjinliang 已提交
2969 2970 2971 2972 2973

获取指定类型的渠道使能状态(Callback形式)。

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

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

X
xuzhihao 已提交
2976 2977
**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

F
fangjinliang 已提交
2978 2979 2980 2981 2982 2983
**参数:**

| 参数名   | 类型                          | 必填 | 说明                   |
| -------- | ----------------------------- | ---- | ---------------------- |
| bundle   | [BundleOption](#bundleoption) | 是   | 指定包信息。           |
| type     | [SlotType](#slottype)         | 是   | 指定渠道类型。         |
X
xuzhihao 已提交
2984
| callback | AsyncCallback\<boolean\>         | 是   | 设定渠道使能回调函数。 |
F
fangjinliang 已提交
2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995

**示例:**

```js
//isNotificationSlotEnabled
function getEnableSlotCallback(err, data) {
    console.log('===================>getEnableSlotCallback==================');
};

Notification.isNotificationSlotEnabled(
    { bundle: "ohos.samples.notification", },
X
xuzhihao 已提交
2996
    Notification.SlotType.SOCIAL_COMMUNICATION,
F
fangjinliang 已提交
2997 2998 2999
    getEnableSlotCallback);
```

F
fangjinliang 已提交
3000
## Notification.isNotificationSlotEnabled <sup>9+</sup>
F
fangjinliang 已提交
3001

X
xuzhihao 已提交
3002
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\<boolean\>  
F
fangjinliang 已提交
3003 3004 3005 3006 3007

获取指定类型的渠道使能状态(Promise形式)。

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

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

X
xuzhihao 已提交
3010 3011
**需要权限**:ohos.permission.NOTIFICATION_CONTROLLER

F
fangjinliang 已提交
3012 3013 3014 3015 3016 3017 3018
**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| bundle | [BundleOption](#bundleoption) | 是   | 指定包信息。   |
| type   | [SlotType](#slottype)         | 是   | 指定渠道类型。 |

X
xuzhihao 已提交
3019 3020 3021 3022 3023 3024
**返回值:**

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

F
fangjinliang 已提交
3025 3026 3027 3028 3029 3030
**示例:**

```js
//isNotificationSlotEnabled
Notification.isNotificationSlotEnabled(
    { bundle: "ohos.samples.notification", },
X
xuzhihao 已提交
3031 3032
    Notification.SlotType.SOCIAL_COMMUNICATION
    ).then((data) => {
F
fangjinliang 已提交
3033 3034 3035 3036
      console.log('====================>isNotificationSlotEnabled====================>');
    });
```

X
xuzhihao 已提交
3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 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 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178

## Notification.setSyncNotificationEnabledForUninstallApp<sup>9+</sup>

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

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

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| userId | number | 是   | 用户Id。   |
| enable   | boolean         | 是   | 是否将通知同步到未安装应用程序的设备。true:是。false:否。 |
| callback | AsyncCallback\<void\>         | 是   | 设置是否将通知同步到未安装应用程序的设备的回调函数。 |

**示例:**

```js
let userId = 100;
let enable = true;

function setSyncNotificationEnabledForUninstallAppCallback(err) {
    console.log('setSyncNotificationEnabledForUninstallAppCallback');
}

Notification.setSyncNotificationEnabledForUninstallApp(userId, enable, setSyncNotificationEnabledForUninstallAppCallback);
```


## Notification.setSyncNotificationEnabledForUninstallApp<sup>9+</sup>

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

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

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| userId | number | 是   | 用户Id。   |
| enable   | boolean         | 是   | 是否将通知同步到未安装应用程序的设备。true:是。false:否。 |

**示例:**

```js
let userId = 100;
let enable = true;

Notification.setSyncNotificationEnabledForUninstallApp(userId, enable)
    .then((data) => {
        console.log('setSyncNotificationEnabledForUninstallApp, data:', data);
    })
    .catch((err) => {
        console.log('setSyncNotificationEnabledForUninstallApp, err:', err);
    });
```


## Notification.getSyncNotificationEnabledForUninstallApp<sup>9+</sup>

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

获取是否同步通知到未安装应用程序的设备的结果(callback形式)。

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| userId | number | 是   | 用户Id。   |
| callback | AsyncCallback\<boolean\>    | 是   | 获取是否同步通知到未安装应用程序的设备的结果的回调函数。true:是。false:否。 |

**示例:**

```js
let userId = 100;

function getSyncNotificationEnabledForUninstallAppCallback(err, data) {
    console.log('getSyncNotificationEnabledForUninstallAppCallback, data: ', data);
}

Notification.getSyncNotificationEnabledForUninstallApp(userId, getSyncNotificationEnabledForUninstallAppCallback);
```


## Notification.getSyncNotificationEnabledForUninstallApp<sup>9+</sup>

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

获取是否同步通知到未安装应用程序的设备的结果(Promise形式)。

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

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

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

**参数:**

| 参数名 | 类型                          | 必填 | 说明           |
| ------ | ----------------------------- | ---- | -------------- |
| userId | number | 是   | 用户Id。   |

**返回值:**

| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回获取是否同步通知到未安装应用程序的设备的结果。true:是。false:否。 |

**示例:**

```js
let userId = 100;

Notification.getSyncNotificationEnabledForUninstallApp(userId)
    .then((data) => {
        console.log('getSyncNotificationEnabledForUninstallApp, data: ', data);
    })
    .catch((err) => {
        console.log('getSyncNotificationEnabledForUninstallApp, err: ', err);
    });
```



3179 3180
## NotificationSubscriber

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

3183 3184
### onConsume

X
xuzhihao 已提交
3185
onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void
3186 3187 3188 3189 3190

接收通知回调函数。

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

X
xuzhihao 已提交
3191 3192
**系统API**: 此接口为系统接口,三方应用不支持调用。

3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | AsyncCallback\<[SubscribeCallbackData](#subscribecallbackdata)\> | 是 | 回调返回接收到的通知信息。 |

**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onConsumeCallback(data) {
    console.info('===> onConsume in test');
    let req = data.request;
    console.info('===> onConsume callback req.id:' + req.id);
    let wantAgent = data.wantAgent;
    wantAgent .getWant(wantAgent)
        .then((data1) => {
3217
            console.log('===> getWant success want:' + JSON.stringify(data1));
3218 3219
        })
        .catch((err) => {
3220
            console.error('===> getWant failed because' + JSON.stringify(err));
3221
        });
3222
    console.info('===> onConsume callback req.wantAgent:' + JSON.stringify(req.wantAgent));
3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
};

var subscriber = {
    onConsume: onConsumeCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onCancel

X
xuzhihao 已提交
3234
onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void
3235 3236 3237 3238 3239

删除通知回调函数。

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

X
xuzhihao 已提交
3240 3241
**系统API**: 此接口为系统接口,三方应用不支持调用。

3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | AsyncCallback\<[SubscribeCallbackData](#subscribecallbackdata)\> | 是 | 回调返回接收到的通知信息。 |

**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onCancelCallback(data) {
    console.info('===> onCancel in test');
    let req = data.request;
    console.info('===> onCancel callback req.id:' + req.id);
}

var subscriber = {
    onCancel: onCancelCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onUpdate

X
xuzhihao 已提交
3274
onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void
3275 3276 3277 3278 3279

更新通知排序回调函数。

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

X
xuzhihao 已提交
3280 3281
**系统API**: 此接口为系统接口,三方应用不支持调用。

3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 回调返回接收到的通知信息。 |

**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onUpdateCallback() {
    console.info('===> onUpdate in test');
}

var subscriber = {
    onUpdate: onUpdateCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onConnect

X
xuzhihao 已提交
3312
onConnect?:() => void
3313 3314 3315 3316 3317

注册订阅回调函数。

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

X
xuzhihao 已提交
3318 3319
**系统API**: 此接口为系统接口,三方应用不支持调用。

3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343
**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onConnectCallback() {
    console.info('===> onConnect in test');
}

var subscriber = {
    onConnect: onConnectCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onDisconnect

X
xuzhihao 已提交
3344
onDisconnect?:() => void
3345 3346 3347 3348 3349

取消订阅回调函数。

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

X
xuzhihao 已提交
3350 3351
**系统API**: 此接口为系统接口,三方应用不支持调用。

3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375
**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onDisconnectCallback() {
    console.info('===> onDisconnect in test');
}

var subscriber = {
    onDisconnect: onDisconnectCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onDestroy

X
xuzhihao 已提交
3376
onDestroy?:() => void
3377 3378 3379 3380 3381

服务失联回调函数。

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

X
xuzhihao 已提交
3382 3383
**系统API**: 此接口为系统接口,三方应用不支持调用。

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407
**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onDestroyCallback() {
    console.info('===> onDestroy in test');
}

var subscriber = {
    onDestroy: onDestroyCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

### onDoNotDisturbDateChange<sup>8+</sup>

X
xuzhihao 已提交
3408
onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate](#donotdisturbdate8)) => void
3409 3410 3411 3412 3413

免打扰时间选项变更回调函数。

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

X
xuzhihao 已提交
3414 3415
**系统API**: 此接口为系统接口,三方应用不支持调用。

3416 3417 3418 3419
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
X
xuzhihao 已提交
3420
| mode | notification.[DoNotDisturbDate](#donotdisturbdate8) | 是 | 回调返回免打扰时间选项变更。 |
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445

**示例:**
```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

function onDoNotDisturbDateChangeCallback() {
    console.info('===> onDoNotDisturbDateChange in test');
}

var subscriber = {
    onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```


### onEnabledNotificationChanged<sup>8+</sup>

X
xuzhihao 已提交
3446
onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) => void
3447 3448 3449 3450 3451

监听应用通知使能变化。

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

X
xuzhihao 已提交
3452 3453
**系统API**: 此接口为系统接口,三方应用不支持调用。

3454 3455 3456 3457
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
R
RayShih 已提交
3458
| callback | AsyncCallback\<[EnabledNotificationCallbackData](#enablednotificationcallbackdata8)\> | 是 | 回调返回监听到的应用信息。 |
3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470

**示例:**

```javascript
function subscribeCallback(err) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribeCallback");
    }
};

3471 3472 3473 3474
function onEnabledNotificationChangedCallback(callbackData) {
    console.info("bundle: ", callbackData.bundle);
    console.info("uid: ", callbackData.uid);
    console.info("enable: ", callbackData.enable);
3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487
};

var subscriber = {
    onEnabledNotificationChanged: onEnabledNotificationChangedCallback
};

Notification.subscribe(subscriber, subscribeCallback);
```

## SubscribeCallbackData

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

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

3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502
| 名称            | 可读 | 可写 | 类型                                              | 必填 | 描述     |
| --------------- | ---- | --- | ------------------------------------------------- | ---- | -------- |
| request         | 是  | 否  | [NotificationRequest](#notificationrequest)       | 是   | 通知内容。 |
| sortingMap      | 是  | 否  | [NotificationSortingMap](#notificationsortingmap) | 否   | 排序信息。 |
| reason          | 是  | 否  | number                                            | 否   | 删除原因。 |
| sound           | 是  | 否  | string                                            | 否   | 通知声音。 |
| vibrationValues | 是  | 否  | Array\<number\>                                   | 否   | 通知震动。 |


## EnabledNotificationCallbackData<sup>8+</sup>

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

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

3505 3506 3507 3508 3509 3510
| 名称   | 可读 | 可写 | 类型    | 必填 | 描述             |
| ------ | ---- | --- | ------- | ---- | ---------------- |
| bundle | 是  | 否  | string  | 是   | 应用的包名。       |
| uid    | 是  | 否  | number  | 是   | 应用的uid。        |
| enable | 是  | 否  | boolean | 是   | 应用通知使能状态。 |

X
xuezhongzhu 已提交
3511

X
xuzhihao 已提交
3512
## DoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
3513

3514
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3515

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

3518 3519
| 名称  | 可读 | 可写 | 类型                                  | 描述                     |
| ----- | ---- | --- | ------------------------------------- | ------------------------ |
3520
| type  | 是  | 否  | [DoNotDisturbType](#donotdisturbtype8) | 指定免打扰设置的时间类型。 |
3521 3522
| begin | 是  | 否  | Date                                  | 指定免打扰设置的起点时间。 |
| end   | 是  | 否  | Date                                  | 指定免打扰设置的终点时间。 |
Z
zhaoyuan17 已提交
3523 3524 3525



3526
## DoNotDisturbType<sup>8+</sup>
Z
zhaoyuan17 已提交
3527

3528
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3529

X
xuzhihao 已提交
3530
**系统API**: 此接口为系统接口,三方应用不支持调用。
Z
zhaoyuan17 已提交
3531

3532 3533
| 名称         | 值               | 说明                                       |
| ------------ | ---------------- | ------------------------------------------ |
3534 3535 3536 3537
| TYPE_NONE    | 0 | 非通知勿扰类型。                           |
| TYPE_ONCE    | 1 | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
| TYPE_DAILY   | 2 | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
| TYPE_CLEARLY | 3 | 以设置时间段(明确年月日时分)执行勿扰。     |
Z
zhaoyuan17 已提交
3538 3539


3540
## ContentType
Z
zhaoyuan17 已提交
3541

3542
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3543

3544 3545
| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
3546 3547 3548 3549 3550
| 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 | 多行文本类型通知。 |
Z
zhaoyuan17 已提交
3551

X
xuzhihao 已提交
3552
## SlotLevel
Z
zhaoyuan17 已提交
3553

3554
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3555

X
xuzhihao 已提交
3556 3557 3558
| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
| LEVEL_NONE                        | 0           | 表示关闭通知功能。     |
F
fangjinliang 已提交
3559 3560 3561 3562
| LEVEL_MIN                         | 1           | 表示通知功能已启用,但状态栏中不显示通知图标,且没有横幅或提示音。 |
| LEVEL_LOW                         | 2           | 表示通知功能已启用,且状态栏中显示通知图标,但没有横幅或提示音。 |
| LEVEL_DEFAULT                     | 3           | 表示通知功能已启用,状态栏中显示通知图标,没有横幅但有提示音。 |
| LEVEL_HIGH                        | 4           | 表示通知功能已启用,状态栏中显示通知图标,有横幅和提示音。 |
Z
zhaoyuan17 已提交
3563 3564


3565
## BundleOption
Z
zhaoyuan17 已提交
3566

3567
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3568

3569 3570 3571 3572
| 名称   | 可读 | 可写 | 类型   | 必填 | 描述   |
| ------ | ---- | --- | ------ | ---- | ------ |
| bundle | 是  | 是  | string | 是   | 包名。   |
| uid    | 是  | 是  | number | 否   | 用户id。 |
Z
zhaoyuan17 已提交
3573 3574 3575



3576
## NotificationKey
Z
zhaoyuan17 已提交
3577

3578
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3579

3580 3581 3582
| 名称  | 可读 | 可写 | 类型   | 必填 | 描述     |
| ----- | ---- | --- | ------ | ---- | -------- |
| id    | 是  | 是  | number | 是   | 通知ID。   |
3583
| label | 是  | 是  | string | 否   | 通知标签。 |
Z
zhaoyuan17 已提交
3584 3585


3586
## SlotType
Z
zhaoyuan17 已提交
3587

3588
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
3589

3590 3591
| 名称                 | 值       | 说明       |
| -------------------- | -------- | ---------- |
3592 3593 3594 3595 3596
| UNKNOWN_TYPE         | 0 | 未知类型。 |
| SOCIAL_COMMUNICATION | 1 | 社交类型。 |
| SERVICE_INFORMATION  | 2 | 服务类型。 |
| CONTENT_INFORMATION  | 3 | 内容类型。 |
| OTHER_TYPES          | 0xFFFF | 其他类型。 |
3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607


## NotificationActionButton

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

| 名称      | 可读 | 可写 | 类型                                            | 必填 | 描述                      |
| --------- | --- | ---- | ----------------------------------------------- | ---- | ------------------------- |
| title     | 是  | 是  | string                                          | 是   | 按钮标题。                  |
| wantAgent | 是  | 是  | WantAgent                                       | 是   | 点击按钮时触发的WantAgent。 |
| extras    | 是  | 是  | { [key: string]: any }                          | 否   | 按钮扩展信息。              |
X
xuzhihao 已提交
3608
| userInput<sup>8+</sup> | 是  | 是  | [NotificationUserInput](#notificationuserinput8) | 否   | 用户输入对象实例。          |
3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680


## NotificationBasicContent

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

| 名称           | 可读 | 可写 | 类型   | 必填 | 描述                               |
| -------------- | ---- | ---- | ------ | ---- | ---------------------------------- |
| title          | 是   | 是   | string | 是   | 通知标题。                         |
| text           | 是   | 是   | string | 是   | 通知内容。                         |
| additionalText | 是   | 是   | string | 否   | 通知次要内容,是对通知内容的补充。 |


## NotificationLongTextContent

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

| 名称           | 可读 | 可写 | 类型   | 必填 | 描述                             |
| -------------- | ---- | --- | ------ | ---- | -------------------------------- |
| title          | 是  | 是  | string | 是   | 通知标题。                         |
| text           | 是  | 是  | string | 是   | 通知内容。                         |
| additionalText | 是  | 是  | string | 否   | 通知次要内容,是对通知内容的补充。 |
| longText       | 是  | 是  | string | 是   | 通知的长文本。                     |
| briefText      | 是  | 是  | string | 是   | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | 是  | 是  | string | 是   | 通知展开时的标题。                 |


## NotificationMultiLineContent

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

| 名称           | 可读 | 可写 | 类型            | 必填 | 描述                             |
| -------------- | --- | --- | --------------- | ---- | -------------------------------- |
| title          | 是  | 是  | string          | 是   | 通知标题。                         |
| text           | 是  | 是  | string          | 是   | 通知内容。                         |
| additionalText | 是  | 是  | string          | 否   | 通知次要内容,是对通知内容的补充。 |
| briefText      | 是  | 是  | string          | 是   | 通知概要内容,是对通知内容的总结。 |
| longTitle      | 是  | 是  | string          | 是   | 通知展开时的标题。                 |
| lines          | 是  | 是  | Array\<string\> | 是   | 通知的多行文本。                   |


## NotificationPictureContent

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

| 名称           | 可读 | 可写 | 类型           | 必填 | 描述                             |
| -------------- | ---- | --- | -------------- | ---- | -------------------------------- |
| title          | 是  | 是  | string         | 是   | 通知标题。                         |
| text           | 是  | 是  | string         | 是   | 通知内容。                         |
| additionalText | 是  | 是  | string         | 否   | 通知次要内容,是对通知内容的补充。 |
| briefText      | 是  | 是  | string         | 是   | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | 是  | 是  | string         | 是   | 通知展开时的标题。                 |
| picture        | 是  | 是  | image.PixelMap | 是   | 通知的图片内容。                   |


## NotificationContent

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

| 名称        | 可读 | 可写 | 类型                                                         | 必填 | 描述               |
| ----------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------ |
| contentType | 是  | 是  | [ContentType](#contenttype)                                  | 是   | 通知内容类型。       |
| normal      | 是  | 是  | [NotificationBasicContent](#notificationbasiccontent)        | 否   | 基本类型通知内容。   |
| longText    | 是  | 是  | [NotificationLongTextContent](#notificationlongtextcontent)  | 否   | 长文本类型通知内容。 |
| multiLine   | 是  | 是  | [NotificationMultiLineContent](#notificationmultilinecontent) | 否   | 多行类型通知内容。   |
| picture     | 是  | 是  | [NotificationPictureContent](#notificationpicturecontent)    | 否   | 图片类型通知内容。   |


## NotificationFlagStatus<sup>8+</sup>

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

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

3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732
| 名称           | 值  | 描述                               |
| -------------- | --- | --------------------------------- |
| TYPE_NONE      | 0   | 默认标志。                         |
| TYPE_OPEN      | 1   | 通知标志打开。                     |
| TYPE_CLOSE     | 2   | 通知标志关闭。                     |


## NotificationFlags<sup>8+</sup>

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

| 名称             | 可读 | 可写 | 类型                    | 必填 | 描述                               |
| ---------------- | ---- | ---- | ---------------------- | ---- | --------------------------------- |
| soundEnabled     | 是   | 否   | NotificationFlagStatus | 否   | 是否启用声音提示。                  |
| vibrationEnabled | 是   | 否   | NotificationFlagStatus | 否   | 是否启用振动提醒功能。               |


## NotificationRequest

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

| 名称                  | 可读 | 可写 | 类型                                          | 必填 | 描述                       |
| --------------------- | ---- | --- | --------------------------------------------- | ---- | -------------------------- |
| content               | 是  | 是  | [NotificationContent](#notificationcontent)   | 是   | 通知内容。                   |
| id                    | 是  | 是  | number                                        | 否   | 通知ID。                     |
| slotType              | 是  | 是  | [SlotType](#slottype)                                      | 否   | 通道类型。                   |
| isOngoing             | 是  | 是  | boolean                                       | 否   | 是否进行时通知。             |
| isUnremovable         | 是  | 是  | boolean                                       | 否   | 是否可移除。                 |
| deliveryTime          | 是  | 是  | number                                        | 否   | 通知发送时间。               |
| tapDismissed          | 是  | 是  | boolean                                       | 否   | 通知是否自动清除。           |
| autoDeletedTime       | 是  | 是  | number                                        | 否   | 自动清除的时间。             |
| wantAgent             | 是  | 是  | WantAgent                                     | 否   | 点击跳转的WantAgent。        |
| extraInfo             | 是  | 是  | {[key: string]: any}                          | 否   | 扩展参数。                   |
| color                 | 是  | 是  | number                                        | 否   | 通知背景颜色。               |
| colorEnabled          | 是  | 是  | boolean                                       | 否   | 通知背景颜色是否使能。       |
| isAlertOnce           | 是  | 是  | boolean                                       | 否   | 设置是否仅有一次此通知警报。 |
| isStopwatch           | 是  | 是  | boolean                                       | 否   | 是否显示已用时间。           |
| isCountDown           | 是  | 是  | boolean                                       | 否   | 是否显示倒计时时间。         |
| isFloatingIcon        | 是  | 是  | boolean                                       | 否   | 是否显示状态栏图标。         |
| label                 | 是  | 是  | string                                        | 否   | 通知标签。                   |
| badgeIconStyle        | 是  | 是  | number                                        | 否   | 通知角标类型。               |
| showDeliveryTime      | 是  | 是  | boolean                                       | 否   | 是否显示分发时间。           |
| actionButtons         | 是  | 是  | Array\<[NotificationActionButton](#notificationactionbutton)\>             | 否   | 通知按钮,最多两个按钮。     |
| smallIcon             | 是  | 是  | PixelMap                                      | 否   | 通知小图标。                 |
| largeIcon             | 是  | 是  | PixelMap                                      | 否   | 通知大图标。                 |
| creatorBundleName     | 是  | 否  | string                                        | 否   | 创建通知的包名。             |
| creatorUid            | 是  | 否  | number                                        | 否   | 创建通知的UID。              |
| creatorPid            | 是  | 否  | number                                        | 否   | 创建通知的PID。              |
| creatorUserId<sup>8+</sup>| 是  | 否  | number                                    | 否   | 创建通知的UserId。           |
| hashCode              | 是  | 否  | string                                        | 否   | 通知唯一标识。               |
X
xuzhihao 已提交
3733
| classification        | 是  | 是  | string                                        | 否   | 通知分类。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
3734
| groupName<sup>8+</sup>| 是  | 是  | string                                        | 否   | 组通知名称。                 |
R
RayShih 已提交
3735
| template<sup>8+</sup> | 是  | 是  | [NotificationTemplate](#notificationtemplate8) | 否   | 通知模板。                   |
X
xuzhihao 已提交
3736 3737
| isRemoveAllowed<sup>8+</sup> | 是  | 否  | boolean                                | 否   | 通知是否能被移除。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| source<sup>8+</sup>   | 是  | 否  | number                                        | 否   | 通知源。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
R
RayShih 已提交
3738
| distributedOption<sup>8+</sup>   | 是  | 是  | [DistributedOptions](#distributedoptions8)                 | 否   | 分布式通知的选项。          |
X
xuzhihao 已提交
3739
| deviceId<sup>8+</sup> | 是  | 否  | string                                        | 否   | 通知源的deviceId。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。          |
R
RayShih 已提交
3740
| notificationFlags<sup>8+</sup> | 是  | 否  | [NotificationFlags](#notificationflags8)                    | 否   | 获取NotificationFlags。          |
X
xuzhihao 已提交
3741 3742
| removalWantAgent<sup>9+</sup> | 是  | 是  | WantAgent                    | 否   | 当移除通知时,通知将被重定向到的WantAgent实例。          |
| badgeNumber<sup>9+</sup> | 是  | 是  | number                    | 否   | 应用程序图标上显示的通知数。          |
3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753


## DistributedOptions<sup>8+</sup>

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

| 名称                   | 可读 | 可写 | 类型            | 必填 | 描述                               |
| ---------------------- | ---- | ---- | -------------- | ---- | ---------------------------------- |
| isDistributed          | 是   | 是   | boolean        | 否   | 是否为分布式通知。                  |
| supportDisplayDevices  | 是   | 是   | Array\<string> | 是   | 可以同步通知到的设备类型。           |
| supportOperateDevices  | 是   | 是   | Array\<string> | 否   | 可以打开通知的设备。                |
X
xuzhihao 已提交
3754
| remindType             | 是   | 否   | number         | 否   | 通知的提醒方式。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                    |
3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773


## NotificationSlot

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

| 名称                 | 可读 | 可写 | 类型                  | 必填 | 描述                                       |
| -------------------- | ---- | --- | --------------------- | ---- | ------------------------------------------ |
| type                 | 是  | 是  | [SlotType](#slottype) | 是   | 通道类型。                                   |
| level                | 是  | 是  | number                | 否   | 通知级别,不设置则根据通知渠道类型有默认值。 |
| desc                 | 是  | 是  | string                | 否   | 通知渠道描述信息。                           |
| badgeFlag            | 是  | 是  | boolean               | 否   | 是否显示角标。                               |
| bypassDnd            | 是  | 是  | boolean               | 否   | 置是否在系统中绕过免打扰模式。               |
| lockscreenVisibility | 是  | 是  | boolean               | 否   | 在锁定屏幕上显示通知的模式。                 |
| vibrationEnabled     | 是  | 是  | boolean               | 否   | 是否可振动。                                 |
| sound                | 是  | 是  | string                | 否   | 通知提示音。                                 |
| lightEnabled         | 是  | 是  | boolean               | 否   | 是否闪灯。                                   |
| lightColor           | 是  | 是  | number                | 否   | 通知灯颜色。                                 |
| vibrationValues      | 是  | 是  | Array\<number\>       | 否   | 通知振动样式。                               |
3774
| enabled<sup>9+</sup> | 是  | 否  | boolean               | 否   | 此通知插槽中的启停状态。                      |
3775 3776 3777 3778 3779 3780


## NotificationSorting

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

X
xuzhihao 已提交
3781
**系统API**: 此接口为系统接口,三方应用不支持调用。
3782

3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
| 名称     | 可读 | 可写 | 类型                                  | 必填 | 描述         |
| -------- | ---- | --- | ------------------------------------- | ---- | ------------ |
| slot     | 是  | 否  | [NotificationSlot](#notificationslot) | 是   | 通知通道内容。 |
| hashCode | 是  | 否  | string                                | 是   | 通知唯一标识。 |
| ranking  | 是  | 否  | number                                | 是   | 通知排序序号。 |


## NotificationSortingMap

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

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

3796 3797 3798 3799 3800 3801 3802 3803 3804 3805
| 名称           | 可读 | 可写 | 类型                                                         | 必填 | 描述             |
| -------------- | ---- | --- | ------------------------------------------------------------ | ---- | ---------------- |
| sortings       | 是  | 否  | {[key: string]: [NotificationSorting](#notificationsorting)} | 是   | 通知排序信息数组。 |
| sortedHashCode | 是  | 否  | Array\<string\>                                              | 是   | 通知唯一标识数组。 |


## NotificationSubscribeInfo

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

X
xuzhihao 已提交
3806
**系统API**: 此接口为系统接口,三方应用不支持调用。
3807

3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836
| 名称        | 可读 | 可写 | 类型            | 必填 | 描述                            |
| ----------- | --- | ---- | --------------- | ---- | ------------------------------- |
| bundleNames | 是  | 是  | Array\<string\> | 否   | 指定订阅哪些包名的APP发来的通知。 |
| userId      | 是  | 是  | number          | 否   | 指定订阅哪个用户下发来的通知。    |


## NotificationTemplate<sup>8+</sup>

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

| 名称 | 参数类型               | 可读 | 可写 | 说明       |
| ---- | ---------------------- | ---- | ---- | ---------- |
| name | string                 | 是   | 是   | 模板名称。 |
| data | {[key:string]: Object} | 是   | 是   | 模板数据。 |


## NotificationUserInput<sup>8+</sup>

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

| 名称     | 可读 | 可写 | 类型   | 必填 | 描述                          |
| -------- | --- | ---- | ------ | ---- | ----------------------------- |
| inputKey | 是  | 是  | string | 是   | 用户输入时用于标识此输入的key。 |


## DeviceRemindType<sup>8+</sup>

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

X
xuzhihao 已提交
3837
**系统API**: 此接口为系统接口,三方应用不支持调用。
3838

3839 3840 3841 3842 3843
| 名称                 | 值  | 描述                               |
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
3844
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |
X
xuzhihao 已提交
3845 3846 3847 3848 3849 3850


## SourceType<sup>8+</sup>

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

X
xuzhihao 已提交
3851 3852
**系统API**: 此接口为系统接口,三方应用不支持调用。

X
xuzhihao 已提交
3853 3854 3855 3856 3857
| 名称                 | 值  | 描述                  |
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
| TYPE_TIMER           | 2   | 计划通知。            |