js-apis-notification.md 111.4 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.notification (Notification模块)
Z
zhaoyuan17 已提交
2

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

> **说明:**
>
7
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zhongjianfei 已提交
8 9
>
> 通知订阅和取消订阅仅对系统应用开放。
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
| 参数名     | 类型                                        | 必填 | 说明                                        |
X
xuzhihao 已提交
28
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
Z
zhongjianfei 已提交
29 30
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| callback | AsyncCallback\<void\>                       | 是   | 发布通知的回调方法。                        |
Z
zhaoyuan17 已提交
31

X
xuzhihao 已提交
32
**示例:**
Z
zhaoyuan17 已提交
33 34

```js
Z
zhongjianfei 已提交
35
// publish回调
Z
zhaoyuan17 已提交
36
function publishCallback(err) {
F
fangJinliang1 已提交
37
    if (err.code) {
38
        console.error(`publish failed, code is ${err.code}`);
F
fangJinliang1 已提交
39 40 41
    } else {
        console.info("publish success");
    }
Z
zhaoyuan17 已提交
42
}
Z
zhongjianfei 已提交
43
// 通知Request对象
F
fangJinliang1 已提交
44
let notificationRequest = {
Z
zhaoyuan17 已提交
45 46
    id: 1,
    content: {
Z
zengsiyu 已提交
47
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
Z
zhaoyuan17 已提交
48 49 50 51 52 53
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
54 55
};
Notification.publish(notificationRequest, publishCallback);
Z
zhaoyuan17 已提交
56 57
```

X
xuzhihao 已提交
58
## Notification.publish
Z
zhaoyuan17 已提交
59

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

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

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

X
xuzhihao 已提交
66 67
**参数:**

X
xuzhihao 已提交
68
| 参数名     | 类型                                        | 必填 | 说明                                        |
X
xuzhihao 已提交
69
| -------- | ------------------------------------------- | ---- | ------------------------------------------- |
Z
zhongjianfei 已提交
70
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
X
xuzhihao 已提交
71

X
xuzhihao 已提交
72
**示例:**
Z
zhaoyuan17 已提交
73 74

```js
Z
zhongjianfei 已提交
75
// 通知Request对象
F
fangJinliang1 已提交
76
let notificationRequest = {
Z
zhaoyuan17 已提交
77 78
    notificationId: 1,
    content: {
Z
zengsiyu 已提交
79
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
Z
zhaoyuan17 已提交
80 81 82 83 84 85
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
86
};
Z
zengsiyu 已提交
87
Notification.publish(notificationRequest).then(() => {
Z
zhongjianfei 已提交
88
	console.info("publish success");
Z
zhaoyuan17 已提交
89 90 91 92
});

```

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

X
xuzhihao 已提交
95
publish(request: NotificationRequest, userId: number, callback: AsyncCallback\<void\>): void
96

Z
zhongjianfei 已提交
97
发布通知给指定的用户(callback形式)。
98 99 100

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

X
xuzhihao 已提交
101 102 103
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

105 106
**参数:**

X
xuzhihao 已提交
107
| 参数名     | 类型                                        | 必填 | 说明                                        |
X
xuzhihao 已提交
108
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
Z
zhongjianfei 已提交
109 110
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| userId   | number                                      | 是   | 用户ID。                           |
X
xuzhihao 已提交
111
| callback | AsyncCallback\<void\>                       | 是   | 被指定的回调方法。                           |
112 113 114 115

**示例:**

```js
Z
zhongjianfei 已提交
116
// publish回调
117
function publishCallback(err) {
F
fangJinliang1 已提交
118
    if (err.code) {
119
        console.error(`publish failed, code is ${err.code}`);
F
fangJinliang1 已提交
120 121 122
    } else {
        console.info("publish success");
    }
123
}
Z
zhongjianfei 已提交
124
// 用户ID
F
fangJinliang1 已提交
125
let userId = 1;
Z
zhongjianfei 已提交
126
// 通知Request对象
F
fangJinliang1 已提交
127
let notificationRequest = {
128 129 130 131 132 133 134 135 136
    id: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
137
};
138 139 140 141 142
Notification.publish(notificationRequest, userId, publishCallback);
```

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

X
xuzhihao 已提交
143
publish(request: NotificationRequest, userId: number): Promise\<void\>
144

Z
zhongjianfei 已提交
145
发布通知给指定的用户(Promise形式)。
146 147 148

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

X
xuzhihao 已提交
149 150 151
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

153 154
**参数:**

X
xuzhihao 已提交
155
| 参数名     |  类型                                        | 必填 | 说明                                        |
X
xuzhihao 已提交
156
| -------- | ----------------------------------------- | ---- | ------------------------------------------- |
Z
zhongjianfei 已提交
157 158
| request  | [NotificationRequest](#notificationrequest) | 是   | 用于设置要发布通知的内容和相关配置信息。 |
| userId   | number                                      | 是   | 用户ID。                           |
159 160 161 162

**示例:**

```js
F
fangJinliang1 已提交
163
let notificationRequest = {
164 165 166 167 168 169 170 171 172
    notificationId: 1,
    content: {
        contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
F
fangJinliang1 已提交
173
};
174

F
fangJinliang1 已提交
175
let userId = 1;
176 177

Notification.publish(notificationRequest, userId).then(() => {
Z
zhongjianfei 已提交
178
	console.info("publish success");
179 180
});
```
Z
zhaoyuan17 已提交
181 182


X
xuzhihao 已提交
183
## Notification.cancel
Z
zhaoyuan17 已提交
184

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

Z
zhongjianfei 已提交
187
通过通知ID和通知标签取消已发布的通知(callback形式)。
Z
zhaoyuan17 已提交
188

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

X
xuzhihao 已提交
191
**参数:**
Z
zhaoyuan17 已提交
192

X
xuzhihao 已提交
193
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
194 195 196 197
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| label    | string                | 是   | 通知标签。             |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
198

X
xuzhihao 已提交
199
**示例:**
Z
zhaoyuan17 已提交
200 201

```js
Z
zhongjianfei 已提交
202
// cancel回调
Z
zhaoyuan17 已提交
203
function cancelCallback(err) {
F
fangJinliang1 已提交
204 205 206 207 208
    if (err.code) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
Z
zhaoyuan17 已提交
209
}
F
fangJinliang1 已提交
210
Notification.cancel(0, "label", cancelCallback);
Z
zhaoyuan17 已提交
211 212 213 214
```



X
xuzhihao 已提交
215
## Notification.cancel
Z
zhaoyuan17 已提交
216

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

Z
zhongjianfei 已提交
219
取消与指定通知ID相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
Z
zhaoyuan17 已提交
220

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

X
xuzhihao 已提交
223
**参数:**
Z
zhaoyuan17 已提交
224

X
xuzhihao 已提交
225
| 参数名  | 类型   | 必填 | 说明     |
X
xuzhihao 已提交
226 227 228
| ----- | ------ | ---- | -------- |
| id    | number | 是   | 通知ID。   |
| label | string | 否   | 通知标签。 |
Z
zhaoyuan17 已提交
229

X
xuzhihao 已提交
230
**示例:**
Z
zhaoyuan17 已提交
231 232

```js
Z
zengsiyu 已提交
233
Notification.cancel(0).then(() => {
Z
zhongjianfei 已提交
234
	console.info("cancel success");
Z
zhaoyuan17 已提交
235 236 237 238 239
});
```



X
xuzhihao 已提交
240
## Notification.cancel
Z
zhaoyuan17 已提交
241

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

Z
zhongjianfei 已提交
244
取消与指定通知ID相匹配的已发布通知(callback形式)。
Z
zhaoyuan17 已提交
245

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

X
xuzhihao 已提交
248
**参数:**
Z
zhaoyuan17 已提交
249

X
xuzhihao 已提交
250
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
251 252 253
| -------- | --------------------- | ---- | -------------------- |
| id       | number                | 是   | 通知ID。               |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
254

X
xuzhihao 已提交
255
**示例:**
Z
zhaoyuan17 已提交
256 257

```js
Z
zhongjianfei 已提交
258
// cancel回调
Z
zhaoyuan17 已提交
259
function cancelCallback(err) {
F
fangJinliang1 已提交
260 261 262 263 264
    if (err.code) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
Z
zhaoyuan17 已提交
265
}
F
fangJinliang1 已提交
266
Notification.cancel(0, cancelCallback);
Z
zhaoyuan17 已提交
267 268 269 270
```



X
xuzhihao 已提交
271
## Notification.cancelAll
Z
zhaoyuan17 已提交
272

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

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

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

X
xuzhihao 已提交
279
**参数:**
Z
zhaoyuan17 已提交
280

X
xuzhihao 已提交
281
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
282 283
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
284

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

```js
Z
zhongjianfei 已提交
288
// cancel回调
Z
zengsiyu 已提交
289
function cancelAllCallback(err) {
F
fangJinliang1 已提交
290 291 292 293 294
    if (err.code) {
        console.info("cancelAll failed " + JSON.stringify(err));
    } else {
        console.info("cancelAll success");
    }
Z
zhaoyuan17 已提交
295
}
F
fangJinliang1 已提交
296
Notification.cancelAll(cancelAllCallback);
Z
zhaoyuan17 已提交
297 298
```

X
xuzhihao 已提交
299
## Notification.cancelAll
Z
zhaoyuan17 已提交
300

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

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

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

X
xuzhihao 已提交
307
**示例:**
Z
zhaoyuan17 已提交
308 309

```js
Z
zengsiyu 已提交
310
Notification.cancelAll().then(() => {
Z
zhongjianfei 已提交
311
	console.info("cancelAll success");
Z
zhaoyuan17 已提交
312 313 314
});
```

X
xuzhihao 已提交
315
## Notification.addSlot
Z
zhaoyuan17 已提交
316

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

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

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

X
xuzhihao 已提交
323 324 325
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
327
**参数:**
Z
zhaoyuan17 已提交
328

X
xuzhihao 已提交
329
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
330 331 332
| -------- | --------------------- | ---- | -------------------- |
| slot     | [NotificationSlot](#notificationslot)       | 是   | 要创建的通知通道对象。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
333

X
xuzhihao 已提交
334
**示例:**
Z
zhaoyuan17 已提交
335 336

```js
Z
zhongjianfei 已提交
337
// addslot回调
Z
zhaoyuan17 已提交
338
function addSlotCallBack(err) {
F
fangJinliang1 已提交
339 340 341 342 343
    if (err.code) {
        console.info("addSlot failed " + JSON.stringify(err));
    } else {
        console.info("addSlot success");
    }
Z
zhaoyuan17 已提交
344
}
Z
zhongjianfei 已提交
345
// 通知slot对象
F
fangJinliang1 已提交
346
let notificationSlot = {
X
xuchenghua09 已提交
347
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
348 349
};
Notification.addSlot(notificationSlot, addSlotCallBack);
Z
zhaoyuan17 已提交
350 351
```

X
xuzhihao 已提交
352
## Notification.addSlot
Z
zhaoyuan17 已提交
353

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

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

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

X
xuzhihao 已提交
360 361 362
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
364
**参数:**
Z
zhaoyuan17 已提交
365

X
xuzhihao 已提交
366
| 参数名 | 类型             | 必填 | 说明                 |
X
xuzhihao 已提交
367 368
| ---- | ---------------- | ---- | -------------------- |
| slot | [NotificationSlot](#notificationslot) | 是   | 要创建的通知通道对象。 |
Z
zhaoyuan17 已提交
369

X
xuzhihao 已提交
370
**示例:**
Z
zhaoyuan17 已提交
371 372

```js
Z
zhongjianfei 已提交
373
// 通知slot对象
F
fangJinliang1 已提交
374
let notificationSlot = {
X
xuchenghua09 已提交
375
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
376
};
Z
zengsiyu 已提交
377
Notification.addSlot(notificationSlot).then(() => {
Z
zhongjianfei 已提交
378
	console.info("addSlot success");
Z
zhaoyuan17 已提交
379 380 381
});
```

X
xuzhihao 已提交
382
## Notification.addSlot
Z
zhaoyuan17 已提交
383

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

Z
zhongjianfei 已提交
386
创建指定类型的通知通道(callback形式)。
Z
zhaoyuan17 已提交
387

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

X
xuzhihao 已提交
390
**参数:**
Z
zhaoyuan17 已提交
391

X
xuzhihao 已提交
392
| 参数名     | 类型                  | 必填 | 说明                   |
X
xuzhihao 已提交
393 394 395
| -------- | --------------------- | ---- | ---------------------- |
| type     | [SlotType](#slottype)              | 是   | 要创建的通知通道的类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。   |
Z
zhaoyuan17 已提交
396

X
xuzhihao 已提交
397
**示例:**
Z
zhaoyuan17 已提交
398 399

```js
Z
zhongjianfei 已提交
400
// addslot回调
Z
zhaoyuan17 已提交
401
function addSlotCallBack(err) {
F
fangJinliang1 已提交
402 403 404 405 406
    if (err.code) {
        console.info("addSlot failed " + JSON.stringify(err));
    } else {
        console.info("addSlot success");
    }
Z
zhaoyuan17 已提交
407
}
F
fangJinliang1 已提交
408
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);
Z
zhaoyuan17 已提交
409 410
```

X
xuzhihao 已提交
411
## Notification.addSlot
Z
zhaoyuan17 已提交
412

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

Z
zhongjianfei 已提交
415
创建指定类型的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
416

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

X
xuzhihao 已提交
419
**参数:**
Z
zhaoyuan17 已提交
420

X
xuzhihao 已提交
421
| 参数名 | 类型     | 必填 | 说明                   |
X
xuzhihao 已提交
422 423
| ---- | -------- | ---- | ---------------------- |
| type | [SlotType](#slottype) | 是   | 要创建的通知通道的类型。 |
Z
zhaoyuan17 已提交
424

X
xuzhihao 已提交
425
**示例:**
Z
zhaoyuan17 已提交
426 427

```js
Z
zengsiyu 已提交
428
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => {
Z
zhongjianfei 已提交
429
	console.info("addSlot success");
Z
zhaoyuan17 已提交
430 431 432
});
```

X
xuzhihao 已提交
433
## Notification.addSlots
Z
zhaoyuan17 已提交
434

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

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

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

X
xuzhihao 已提交
441 442 443
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
445
**参数:**
Z
zhaoyuan17 已提交
446

X
xuzhihao 已提交
447
| 参数名     | 类型                      | 必填 | 说明                     |
X
xuzhihao 已提交
448 449 450
| -------- | ------------------------- | ---- | ------------------------ |
| slots    | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |
| callback | AsyncCallback\<void\>     | 是   | 表示被指定的回调方法。     |
Z
zhaoyuan17 已提交
451

X
xuzhihao 已提交
452
**示例:**
Z
zhaoyuan17 已提交
453 454

```js
Z
zhongjianfei 已提交
455
// addSlots回调
Z
zhaoyuan17 已提交
456
function addSlotsCallBack(err) {
F
fangJinliang1 已提交
457 458 459 460 461
    if (err.code) {
        console.info("addSlots failed " + JSON.stringify(err));
    } else {
        console.info("addSlots success");
    }
Z
zhaoyuan17 已提交
462
}
Z
zhongjianfei 已提交
463
// 通知slot对象
F
fangJinliang1 已提交
464
let notificationSlot = {
X
xuchenghua09 已提交
465
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
466
};
Z
zhongjianfei 已提交
467
// 通知slot array 对象
F
fangJinliang1 已提交
468
let notificationSlotArray = new Array();
Z
zengsiyu 已提交
469
notificationSlotArray[0] = notificationSlot;
Z
zhaoyuan17 已提交
470

F
fangJinliang1 已提交
471
Notification.addSlots(notificationSlotArray, addSlotsCallBack);
Z
zhaoyuan17 已提交
472 473
```

X
xuzhihao 已提交
474
## Notification.addSlots
Z
zhaoyuan17 已提交
475

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

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

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

X
xuzhihao 已提交
482 483 484
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
486
**参数:**
Z
zhaoyuan17 已提交
487

X
xuzhihao 已提交
488
| 参数名  | 类型                      | 必填 | 说明                     |
X
xuzhihao 已提交
489 490
| ----- | ------------------------- | ---- | ------------------------ |
| slots | Array\<[NotificationSlot](#notificationslot)\> | 是   | 要创建的通知通道对象数组。 |
Z
zhaoyuan17 已提交
491

X
xuzhihao 已提交
492
**示例:**
Z
zhaoyuan17 已提交
493 494

```js
Z
zhongjianfei 已提交
495
// 通知slot对象
F
fangJinliang1 已提交
496
let notificationSlot = {
X
xuchenghua09 已提交
497
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
498
};
Z
zhongjianfei 已提交
499
// 通知slot array 对象
F
fangJinliang1 已提交
500
let notificationSlotArray = new Array();
Z
zengsiyu 已提交
501
notificationSlotArray[0] = notificationSlot;
Z
zhaoyuan17 已提交
502

Z
zengsiyu 已提交
503
Notification.addSlots(notificationSlotArray).then(() => {
Z
zhongjianfei 已提交
504
	console.info("addSlots success");
Z
zhaoyuan17 已提交
505 506 507
});
```

X
xuzhihao 已提交
508
## Notification.getSlot
Z
zhaoyuan17 已提交
509

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

Z
zhongjianfei 已提交
512
获取一个指定类型的通知通道(callback形式)。
Z
zhaoyuan17 已提交
513

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

X
xuzhihao 已提交
516
**参数:**
Z
zhaoyuan17 已提交
517

X
xuzhihao 已提交
518
| 参数名     | 类型                              | 必填 | 说明                                                        |
X
xuzhihao 已提交
519
| -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
Z
zhongjianfei 已提交
520
| slotType | [SlotType](#slottype)                          | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
X
xuzhihao 已提交
521
| callback | AsyncCallback\<[NotificationSlot](#notificationslot)\> | 是   | 表示被指定的回调方法。                                        |
Z
zhaoyuan17 已提交
522

X
xuzhihao 已提交
523
**示例:**
Z
zhaoyuan17 已提交
524 525

```js
Z
zhongjianfei 已提交
526 527
// getSlot回调
function getSlotCallback(err, data) {
F
fangJinliang1 已提交
528 529 530 531 532
    if (err.code) {
        console.info("getSlot failed " + JSON.stringify(err));
    } else {
        console.info("getSlot success");
    }
Z
zhaoyuan17 已提交
533
}
F
fangJinliang1 已提交
534 535
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType, getSlotCallback);
Z
zhaoyuan17 已提交
536 537
```

X
xuzhihao 已提交
538
## Notification.getSlot
Z
zhaoyuan17 已提交
539

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

Z
zhongjianfei 已提交
542
获取一个指定类型的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
543

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

X
xuzhihao 已提交
546
**参数:**
Z
zhaoyuan17 已提交
547

X
xuzhihao 已提交
548
| 参数名     | 类型     | 必填 | 说明                                                        |
X
xuzhihao 已提交
549
| -------- | -------- | ---- | ----------------------------------------------------------- |
Z
zhongjianfei 已提交
550
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
Z
zhaoyuan17 已提交
551

X
xuzhihao 已提交
552
**返回值:**
Z
zhaoyuan17 已提交
553

X
xuzhihao 已提交
554 555 556 557 558
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<NotificationSlot\> | 以Promise形式返回获取一个通知通道。 |

**示例:**
Z
zhaoyuan17 已提交
559 560

```js
F
fangJinliang1 已提交
561
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zhaoyuan17 已提交
562
Notification.getSlot(slotType).then((data) => {
Z
zhongjianfei 已提交
563
	console.info("getSlot success, data: " + JSON.stringify(data));
X
xuchenghua09 已提交
564
});
Z
zhaoyuan17 已提交
565 566
```

X
xuzhihao 已提交
567
## Notification.getSlots
Z
zhaoyuan17 已提交
568

569
getSlots(callback: AsyncCallback\<Array\<NotificationSlot>>): void
Z
zhaoyuan17 已提交
570

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

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

X
xuzhihao 已提交
575
**参数:**
Z
zhaoyuan17 已提交
576

X
xuzhihao 已提交
577
| 参数名     | 类型                              | 必填 | 说明                 |
X
xuzhihao 已提交
578
| -------- | --------------------------------- | ---- | -------------------- |
579
| callback | AsyncCallback\<Array\<[NotificationSlot](#notificationslot)>> | 是   | 以callback形式返回获取此应用程序的所有通知通道的结果。 |
Z
zhaoyuan17 已提交
580

X
xuzhihao 已提交
581
**示例:**
Z
zhaoyuan17 已提交
582 583

```js
Z
zhongjianfei 已提交
584 585
// getSlots回调
function getSlotsCallback(err, data) {
F
fangJinliang1 已提交
586 587 588 589 590
    if (err.code) {
        console.info("getSlots failed " + JSON.stringify(err));
    } else {
        console.info("getSlots success");
    }
Z
zhaoyuan17 已提交
591
}
F
fangJinliang1 已提交
592
Notification.getSlots(getSlotsCallback);
Z
zhaoyuan17 已提交
593 594
```

X
xuzhihao 已提交
595
## Notification.getSlots
Z
zhaoyuan17 已提交
596

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

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

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

X
xuzhihao 已提交
603
**返回值:**
Z
zhaoyuan17 已提交
604

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

X
xuzhihao 已提交
609
**示例:**
Z
zhaoyuan17 已提交
610 611 612

```js
Notification.getSlots().then((data) => {
Z
zhongjianfei 已提交
613
	console.info("getSlots success, data: " + JSON.stringify(data));
X
xuchenghua09 已提交
614
});
Z
zhaoyuan17 已提交
615 616
```

X
xuzhihao 已提交
617
## Notification.removeSlot
Z
zhaoyuan17 已提交
618

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

Z
zhongjianfei 已提交
621
删除指定类型的通知通道(callback形式)。
Z
zhaoyuan17 已提交
622

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

X
xuzhihao 已提交
625
**参数:**
Z
zhaoyuan17 已提交
626

X
xuzhihao 已提交
627
| 参数名     | 类型                  | 必填 | 说明                                                        |
X
xuzhihao 已提交
628 629 630
| -------- | --------------------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype)              | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。                                        |
Z
zhaoyuan17 已提交
631

X
xuzhihao 已提交
632
**示例:**
Z
zhaoyuan17 已提交
633 634

```js
Z
zhongjianfei 已提交
635
// removeSlot回调
Z
zhaoyuan17 已提交
636
function removeSlotCallback(err) {
F
fangJinliang1 已提交
637 638 639 640 641
    if (err.code) {
        console.info("removeSlot failed " + JSON.stringify(err));
    } else {
        console.info("removeSlot success");
    }
Z
zhaoyuan17 已提交
642
}
F
fangJinliang1 已提交
643 644
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType,removeSlotCallback);
Z
zhaoyuan17 已提交
645 646
```

X
xuzhihao 已提交
647
## Notification.removeSlot
Z
zhaoyuan17 已提交
648

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

Z
zhongjianfei 已提交
651
删除指定类型的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
652

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

X
xuzhihao 已提交
655
**参数:**
Z
zhaoyuan17 已提交
656

X
xuzhihao 已提交
657
| 参数名     | 类型     | 必填 | 说明                                                        |
X
xuzhihao 已提交
658 659
| -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | [SlotType](#slottype) | 是   | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
Z
zhaoyuan17 已提交
660

X
xuzhihao 已提交
661
**示例:**
Z
zhaoyuan17 已提交
662 663

```js
F
fangJinliang1 已提交
664
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Z
zengsiyu 已提交
665
Notification.removeSlot(slotType).then(() => {
Z
zhongjianfei 已提交
666
	console.info("removeSlot success");
X
xuchenghua09 已提交
667
});
Z
zhaoyuan17 已提交
668 669
```

X
xuzhihao 已提交
670
## Notification.removeAllSlots
Z
zhaoyuan17 已提交
671

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

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

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

X
xuzhihao 已提交
678
**参数:**
Z
zhaoyuan17 已提交
679

X
xuzhihao 已提交
680
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
681 682
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 表示被指定的回调方法。 |
Z
zhaoyuan17 已提交
683

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

```js
function removeAllCallBack(err) {
F
fangJinliang1 已提交
688 689 690 691 692
    if (err.code) {
        console.info("removeAllSlots failed " + JSON.stringify(err));
    } else {
        console.info("removeAllSlots success");
    }
Z
zhaoyuan17 已提交
693
}
F
fangJinliang1 已提交
694
Notification.removeAllSlots(removeAllCallBack);
Z
zhaoyuan17 已提交
695 696
```

X
xuzhihao 已提交
697
## Notification.removeAllSlots
Z
zhaoyuan17 已提交
698

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

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

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

X
xuzhihao 已提交
705
**示例:**
Z
zhaoyuan17 已提交
706 707

```js
Z
zengsiyu 已提交
708
Notification.removeAllSlots().then(() => {
Z
zhongjianfei 已提交
709
	console.info("removeAllSlots success");
Z
zhaoyuan17 已提交
710 711 712
});
```

X
xuzhihao 已提交
713
## Notification.subscribe
Z
zhaoyuan17 已提交
714

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

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

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

X
xuzhihao 已提交
721 722 723
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
725
**参数:**
Z
zhaoyuan17 已提交
726

X
xuzhihao 已提交
727
| 参数名       | 类型                      | 必填 | 说明             |
X
xuzhihao 已提交
728
| ---------- | ------------------------- | ---- | ---------------- |
729
| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber)    | 是   | 通知订阅对象。     |
Z
zhongjianfei 已提交
730
| info       | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 是   | 通知订阅信息。 |
X
xuzhihao 已提交
731
| callback   | AsyncCallback\<void\>     | 是   | 订阅动作回调函数。 |
Z
zhaoyuan17 已提交
732

X
xuzhihao 已提交
733
**示例:**
Z
zhaoyuan17 已提交
734 735

```js
Z
zhongjianfei 已提交
736
// subscribe回调
Z
zhaoyuan17 已提交
737
function subscribeCallback(err) {
F
fangJinliang1 已提交
738 739 740 741 742
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe success");
    }
Z
zhaoyuan17 已提交
743
}
744
function onConsumeCallback(data) {
F
fangJinliang1 已提交
745
	console.info("Consume callback: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
746
}
F
fangJinliang1 已提交
747
let subscriber = {
X
xuchenghua09 已提交
748
    onConsume: onConsumeCallback
F
fangJinliang1 已提交
749 750
};
let info = {
Z
zhongjianfei 已提交
751
    bundleNames: ["bundleName1", "bundleName2"]
F
fangJinliang1 已提交
752
};
Z
zhaoyuan17 已提交
753 754 755
Notification.subscribe(subscriber, info, subscribeCallback);
```

X
xuzhihao 已提交
756
## Notification.subscribe
Z
zhaoyuan17 已提交
757

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

Z
zhongjianfei 已提交
760
订阅当前用户下所有应用的通知(callback形式)。
Z
zhaoyuan17 已提交
761

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

X
xuzhihao 已提交
764 765 766
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
768
**参数:**
Z
zhaoyuan17 已提交
769

X
xuzhihao 已提交
770
| 参数名       | 类型                   | 必填 | 说明             |
X
xuzhihao 已提交
771
| ---------- | ---------------------- | ---- | ---------------- |
772
| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是   | 通知订阅对象。     |
X
xuzhihao 已提交
773
| callback   | AsyncCallback\<void\>  | 是   | 订阅动作回调函数。 |
Z
zhaoyuan17 已提交
774

X
xuzhihao 已提交
775
**示例:**
Z
zhaoyuan17 已提交
776 777 778

```js
function subscribeCallback(err) {
F
fangJinliang1 已提交
779 780 781 782 783
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe success");
    }
Z
zhaoyuan17 已提交
784
}
785
function onConsumeCallback(data) {
F
fangJinliang1 已提交
786
	console.info("Consume callback: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
787
}
F
fangJinliang1 已提交
788
let subscriber = {
X
xuchenghua09 已提交
789
    onConsume: onConsumeCallback
F
fangJinliang1 已提交
790
};
Z
zhaoyuan17 已提交
791 792 793
Notification.subscribe(subscriber, subscribeCallback);
```

X
xuzhihao 已提交
794
## Notification.subscribe
Z
zhaoyuan17 已提交
795

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

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

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

X
xuzhihao 已提交
802 803 804
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
806
**参数:**
Z
zhaoyuan17 已提交
807

X
xuzhihao 已提交
808
| 参数名       | 类型                      | 必填 | 说明         |
X
xuzhihao 已提交
809
| ---------- | ------------------------- | ---- | ------------ |
810
| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber)    | 是   | 通知订阅对象。 |
Z
zhongjianfei 已提交
811
| info       | [NotificationSubscribeInfo](#notificationsubscribeinfo) | 否   | 通知订阅信息。   |
Z
zhaoyuan17 已提交
812

X
xuzhihao 已提交
813
**示例:**
Z
zhaoyuan17 已提交
814 815

```js
816
function onConsumeCallback(data) {
X
xuzhihao 已提交
817
    console.info("Consume callback: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
818
}
F
fangJinliang1 已提交
819
let subscriber = {
X
xuchenghua09 已提交
820
    onConsume: onConsumeCallback
Z
zhaoyuan17 已提交
821
};
Z
zengsiyu 已提交
822
Notification.subscribe(subscriber).then(() => {
Z
zhongjianfei 已提交
823
	console.info("subscribe success");
Z
zhaoyuan17 已提交
824 825 826
});
```

X
xuzhihao 已提交
827
## Notification.unsubscribe
Z
zhaoyuan17 已提交
828

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

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

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

X
xuzhihao 已提交
835 836 837
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
839
**参数:**
Z
zhaoyuan17 已提交
840

X
xuzhihao 已提交
841
| 参数名       | 类型                   | 必填 | 说明                 |
X
xuzhihao 已提交
842
| ---------- | ---------------------- | ---- | -------------------- |
843
| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是   | 通知订阅对象。         |
X
xuzhihao 已提交
844
| callback   | AsyncCallback\<void\>  | 是   | 取消订阅动作回调函数。 |
Z
zhaoyuan17 已提交
845

X
xuzhihao 已提交
846
**示例:**
Z
zhaoyuan17 已提交
847 848 849

```js
function unsubscribeCallback(err) {
F
fangJinliang1 已提交
850 851 852 853 854
    if (err.code) {
        console.info("unsubscribe failed " + JSON.stringify(err));
    } else {
        console.info("unsubscribe success");
    }
Z
zhaoyuan17 已提交
855
}
Y
yuyaozhi 已提交
856 857
function onDisconnectCallback() {
	console.info("subscribe disconnect");
Z
zhaoyuan17 已提交
858
}
F
fangJinliang1 已提交
859
let subscriber = {
Z
zhongjianfei 已提交
860
    onDisconnect: onDisconnectCallback
F
fangJinliang1 已提交
861
};
Z
zhaoyuan17 已提交
862 863 864
Notification.unsubscribe(subscriber, unsubscribeCallback);
```

X
xuzhihao 已提交
865
## Notification.unsubscribe
Z
zhaoyuan17 已提交
866

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

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

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

X
xuzhihao 已提交
873 874 875
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
877
**参数:**
Z
zhaoyuan17 已提交
878

X
xuzhihao 已提交
879
| 参数名       | 类型                   | 必填 | 说明         |
X
xuzhihao 已提交
880
| ---------- | ---------------------- | ---- | ------------ |
881
| subscriber | [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md#notificationsubscriber) | 是   | 通知订阅对象。 |
Z
zhaoyuan17 已提交
882

X
xuzhihao 已提交
883
**示例:**
Z
zhaoyuan17 已提交
884 885

```js
Y
yuyaozhi 已提交
886 887
function onDisconnectCallback() {
	console.info("subscribe disconnect");
Z
zhaoyuan17 已提交
888
}
F
fangJinliang1 已提交
889
let subscriber = {
Z
zhongjianfei 已提交
890
    onDisconnect: onDisconnectCallback
Z
zhaoyuan17 已提交
891
};
Z
zengsiyu 已提交
892
Notification.unsubscribe(subscriber).then(() => {
Z
zhongjianfei 已提交
893
	console.info("unsubscribe success");
Z
zhaoyuan17 已提交
894 895 896
});
```

X
xuzhihao 已提交
897
## Notification.enableNotification
Z
zhaoyuan17 已提交
898

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

Z
zhongjianfei 已提交
901
设定指定应用的通知使能状态(Callback形式)。
Z
zhaoyuan17 已提交
902

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

X
xuzhihao 已提交
905 906 907
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
909
**参数:**
Z
zhaoyuan17 已提交
910

X
xuzhihao 已提交
911
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
912
| -------- | --------------------- | ---- | -------------------- |
Z
zhongjianfei 已提交
913
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。        |
X
xuzhihao 已提交
914 915
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知使能回调函数。 |
Z
zhaoyuan17 已提交
916

X
xuzhihao 已提交
917
**示例:**
Z
zhaoyuan17 已提交
918 919 920

```js
function enableNotificationCallback(err) {
F
fangJinliang1 已提交
921 922 923 924 925
    if (err.code) {
        console.info("enableNotification failed " + JSON.stringify(err));
    } else {
        console.info("enableNotification success");
    }
Z
zhaoyuan17 已提交
926
}
F
fangJinliang1 已提交
927
let bundle = {
Z
zengsiyu 已提交
928
    bundle: "bundleName1",
F
fangJinliang1 已提交
929
};
Z
zhaoyuan17 已提交
930 931 932
Notification.enableNotification(bundle, false, enableNotificationCallback);
```

X
xuzhihao 已提交
933
## Notification.enableNotification
Z
zhaoyuan17 已提交
934

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

Z
zhongjianfei 已提交
937
设定指定应用的通知使能状态(Promise形式)。
Z
zhaoyuan17 已提交
938

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

X
xuzhihao 已提交
941 942 943
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
945
**参数:**
Z
zhaoyuan17 已提交
946

X
xuzhihao 已提交
947
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
948
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
949
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
X
xuzhihao 已提交
950
| enable | boolean      | 是   | 使能状态。   |
Z
zhaoyuan17 已提交
951

X
xuzhihao 已提交
952
**示例:**
Z
zhaoyuan17 已提交
953 954

```js
F
fangJinliang1 已提交
955
let bundle = {
Z
zengsiyu 已提交
956
    bundle: "bundleName1",
F
fangJinliang1 已提交
957
};
Z
zengsiyu 已提交
958
Notification.enableNotification(bundle, false).then(() => {
Z
zhongjianfei 已提交
959
	console.info("enableNotification success");
Z
zhaoyuan17 已提交
960 961 962
});
```

X
xuzhihao 已提交
963
## Notification.isNotificationEnabled
Z
zhaoyuan17 已提交
964

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

Z
zhongjianfei 已提交
967
获取指定应用的通知使能状态(Callback形式)。
Z
zhaoyuan17 已提交
968

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

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

X
xuzhihao 已提交
973 974
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

X
xuzhihao 已提交
975
**参数:**
Z
zhaoyuan17 已提交
976

X
xuzhihao 已提交
977
| 参数名     | 类型                  | 必填 | 说明                     |
X
xuzhihao 已提交
978
| -------- | --------------------- | ---- | ------------------------ |
Z
zhongjianfei 已提交
979
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。            |
X
xuzhihao 已提交
980
| callback | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |
Z
zhaoyuan17 已提交
981

X
xuzhihao 已提交
982
**示例:**
Z
zhaoyuan17 已提交
983 984 985

```js
function isNotificationEnabledCallback(err, data) {
F
fangJinliang1 已提交
986 987 988 989 990
    if (err.code) {
        console.info("isNotificationEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isNotificationEnabled success");
    }
Z
zhaoyuan17 已提交
991
}
F
fangJinliang1 已提交
992
let bundle = {
Z
zengsiyu 已提交
993
    bundle: "bundleName1",
F
fangJinliang1 已提交
994
};
Z
zhaoyuan17 已提交
995 996 997
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```

X
xuzhihao 已提交
998 999 1000
## Notification.isNotificationEnabled

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

Z
zhongjianfei 已提交
1002
获取指定应用的通知使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1003

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

X
xuzhihao 已提交
1006 1007 1008
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1010
**参数:**
Z
zhaoyuan17 已提交
1011

X
xuzhihao 已提交
1012
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1013
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1014
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1015

X
xuzhihao 已提交
1016
**返回值:**
Z
zhaoyuan17 已提交
1017

Z
zhongjianfei 已提交
1018 1019 1020
| 类型               | 说明                                                |
| ------------------ | --------------------------------------------------- |
| Promise\<boolean\> | 以Promise形式返回获取指定应用的通知使能状态的结果。 |
Z
zhaoyuan17 已提交
1021

X
xuzhihao 已提交
1022
**示例:**
Z
zhaoyuan17 已提交
1023 1024

```js
F
fangJinliang1 已提交
1025
let bundle = {
Z
zengsiyu 已提交
1026
    bundle: "bundleName1",
F
fangJinliang1 已提交
1027
};
Z
zhaoyuan17 已提交
1028
Notification.isNotificationEnabled(bundle).then((data) => {
Z
zhongjianfei 已提交
1029
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1030 1031 1032
});
```

X
xuzhihao 已提交
1033
## Notification.isNotificationEnabled
Z
zhaoyuan17 已提交
1034

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

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

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

X
xuzhihao 已提交
1041 1042 1043
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1045
**参数:**
Z
zhaoyuan17 已提交
1046

X
xuzhihao 已提交
1047
| 参数名     | 类型                  | 必填 | 说明                     |
X
xuzhihao 已提交
1048 1049
| -------- | --------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void\> | 是   | 获取通知使能状态回调函数。 |
Z
zhaoyuan17 已提交
1050

X
xuzhihao 已提交
1051
**示例:**
Z
zhaoyuan17 已提交
1052 1053 1054

```js
function isNotificationEnabledCallback(err, data) {
F
fangJinliang1 已提交
1055 1056 1057 1058 1059
    if (err.code) {
        console.info("isNotificationEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isNotificationEnabled success");
    }
Z
zhaoyuan17 已提交
1060 1061 1062 1063 1064
}

Notification.isNotificationEnabled(isNotificationEnabledCallback);
```

X
xuzhihao 已提交
1065 1066 1067
## Notification.isNotificationEnabled

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

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

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

X
xuzhihao 已提交
1073 1074 1075
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1077
**参数:**
Z
zhaoyuan17 已提交
1078

X
xuzhihao 已提交
1079
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1080
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1081
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1082

X
xuzhihao 已提交
1083
**返回值:**
Z
zhaoyuan17 已提交
1084

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

X
xuzhihao 已提交
1089
**示例:**
Z
zhaoyuan17 已提交
1090 1091 1092

```js
Notification.isNotificationEnabled().then((data) => {
Z
zhongjianfei 已提交
1093
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1094 1095 1096
});
```

X
xuzhihao 已提交
1097
## Notification.displayBadge
Z
zhaoyuan17 已提交
1098

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

Z
zhongjianfei 已提交
1101
设定指定应用的角标使能状态(Callback形式)。
Z
zhaoyuan17 已提交
1102

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

X
xuzhihao 已提交
1105 1106 1107
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1109
**参数:**
Z
zhaoyuan17 已提交
1110

X
xuzhihao 已提交
1111
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
1112
| -------- | --------------------- | ---- | -------------------- |
Z
zhongjianfei 已提交
1113
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。           |
X
xuzhihao 已提交
1114 1115
| enable   | boolean               | 是   | 使能状态。             |
| callback | AsyncCallback\<void\> | 是   | 设定角标使能回调函数。 |
Z
zhaoyuan17 已提交
1116

X
xuzhihao 已提交
1117
**示例:**
Z
zhaoyuan17 已提交
1118 1119 1120

```js
function displayBadgeCallback(err) {
F
fangJinliang1 已提交
1121 1122 1123 1124 1125
    if (err.code) {
        console.info("displayBadge failed " + JSON.stringify(err));
    } else {
        console.info("displayBadge success");
    }
Z
zhaoyuan17 已提交
1126
}
F
fangJinliang1 已提交
1127
let bundle = {
Z
zengsiyu 已提交
1128
    bundle: "bundleName1",
F
fangJinliang1 已提交
1129
};
Z
zhaoyuan17 已提交
1130 1131 1132
Notification.displayBadge(bundle, false, displayBadgeCallback);
```

X
xuzhihao 已提交
1133
## Notification.displayBadge
Z
zhaoyuan17 已提交
1134

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

Z
zhongjianfei 已提交
1137
设定指定应用的角标使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1138

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

X
xuzhihao 已提交
1141 1142 1143
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1145
**参数:**
Z
zhaoyuan17 已提交
1146

X
xuzhihao 已提交
1147
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1148
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1149
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
X
xuzhihao 已提交
1150
| enable | boolean      | 是   | 使能状态。   |
Z
zhaoyuan17 已提交
1151

X
xuzhihao 已提交
1152
**示例:**
Z
zhaoyuan17 已提交
1153 1154

```js
F
fangJinliang1 已提交
1155
let bundle = {
Z
zengsiyu 已提交
1156
    bundle: "bundleName1",
F
fangJinliang1 已提交
1157
};
Z
zengsiyu 已提交
1158
Notification.displayBadge(bundle, false).then(() => {
Z
zhongjianfei 已提交
1159
	console.info("displayBadge success");
Z
zhaoyuan17 已提交
1160 1161 1162
});
```

X
xuzhihao 已提交
1163
## Notification.isBadgeDisplayed
Z
zhaoyuan17 已提交
1164

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

Z
zhongjianfei 已提交
1167
获取指定应用的角标使能状态(Callback形式)。
Z
zhaoyuan17 已提交
1168

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

X
xuzhihao 已提交
1171 1172 1173
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1175
**参数:**
Z
zhaoyuan17 已提交
1176

X
xuzhihao 已提交
1177
| 参数名     | 类型                  | 必填 | 说明                     |
X
xuzhihao 已提交
1178
| -------- | --------------------- | ---- | ------------------------ |
Z
zhongjianfei 已提交
1179
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。               |
X
xuzhihao 已提交
1180
| callback | AsyncCallback\<void\> | 是   | 获取角标使能状态回调函数。 |
Z
zhaoyuan17 已提交
1181

X
xuzhihao 已提交
1182
**示例:**
Z
zhaoyuan17 已提交
1183 1184 1185

```js
function isBadgeDisplayedCallback(err, data) {
F
fangJinliang1 已提交
1186 1187 1188 1189 1190
    if (err.code) {
        console.info("isBadgeDisplayed failed " + JSON.stringify(err));
    } else {
        console.info("isBadgeDisplayed success");
    }
Z
zhaoyuan17 已提交
1191
}
F
fangJinliang1 已提交
1192
let bundle = {
Z
zengsiyu 已提交
1193
    bundle: "bundleName1",
F
fangJinliang1 已提交
1194
};
Z
zhaoyuan17 已提交
1195 1196 1197
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
```

X
xuzhihao 已提交
1198
## Notification.isBadgeDisplayed
Z
zhaoyuan17 已提交
1199

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

Z
zhongjianfei 已提交
1202
获取指定应用的角标使能状态(Promise形式)。
Z
zhaoyuan17 已提交
1203

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

X
xuzhihao 已提交
1206 1207 1208
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1210
**参数:**
Z
zhaoyuan17 已提交
1211

X
xuzhihao 已提交
1212
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1213
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1214
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1215

X
xuzhihao 已提交
1216
**返回值:**
Z
zhaoyuan17 已提交
1217

X
xuzhihao 已提交
1218 1219
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
Z
zhongjianfei 已提交
1220
| Promise\<boolean\> | 以Promise形式返回获取指定应用的角标使能状态。 |
X
xuzhihao 已提交
1221 1222

**示例:**
Z
zhaoyuan17 已提交
1223 1224

```js
F
fangJinliang1 已提交
1225
let bundle = {
Z
zengsiyu 已提交
1226
    bundle: "bundleName1",
F
fangJinliang1 已提交
1227
};
Z
zhaoyuan17 已提交
1228
Notification.isBadgeDisplayed(bundle).then((data) => {
Z
zhongjianfei 已提交
1229
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1230 1231 1232
});
```

X
xuzhihao 已提交
1233
## Notification.setSlotByBundle
Z
zhaoyuan17 已提交
1234

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

Z
zhongjianfei 已提交
1237
设定指定应用的通知通道(Callback形式)。
Z
zhaoyuan17 已提交
1238

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

X
xuzhihao 已提交
1241 1242 1243
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1245
**参数:**
Z
zhaoyuan17 已提交
1246

X
xuzhihao 已提交
1247
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
1248
| -------- | --------------------- | ---- | -------------------- |
Z
zhongjianfei 已提交
1249
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。           |
X
xuzhihao 已提交
1250 1251
| slot     | [NotificationSlot](#notificationslot)      | 是   | 通知通道。             |
| callback | AsyncCallback\<void\> | 是   | 设定通知通道回调函数。 |
Z
zhaoyuan17 已提交
1252

X
xuzhihao 已提交
1253
**示例:**
Z
zhaoyuan17 已提交
1254 1255 1256

```js
function setSlotByBundleCallback(err) {
F
fangJinliang1 已提交
1257 1258 1259 1260 1261
    if (err.code) {
        console.info("setSlotByBundle failed " + JSON.stringify(err));
    } else {
        console.info("setSlotByBundle success");
    }
Z
zhaoyuan17 已提交
1262
}
F
fangJinliang1 已提交
1263
let bundle = {
Z
zengsiyu 已提交
1264
    bundle: "bundleName1",
F
fangJinliang1 已提交
1265 1266
};
let notificationSlot = {
X
xuchenghua09 已提交
1267
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1268
};
Z
zhaoyuan17 已提交
1269 1270 1271
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```

X
xuzhihao 已提交
1272
## Notification.setSlotByBundle
Z
zhaoyuan17 已提交
1273

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

Z
zhongjianfei 已提交
1276
设定指定应用的通知通道(Promise形式)。
Z
zhaoyuan17 已提交
1277

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

X
xuzhihao 已提交
1280 1281 1282
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1284
**参数:**
Z
zhaoyuan17 已提交
1285

X
xuzhihao 已提交
1286
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1287
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1288 1289
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
| slot   | [NotificationSlot](#notificationslot) | 是   | 通知通道。 |
Z
zhaoyuan17 已提交
1290

X
xuzhihao 已提交
1291
**示例:**
Z
zhaoyuan17 已提交
1292 1293

```js
F
fangJinliang1 已提交
1294
let bundle = {
Z
zengsiyu 已提交
1295
    bundle: "bundleName1",
F
fangJinliang1 已提交
1296 1297
};
let notificationSlot = {
X
xuchenghua09 已提交
1298
    type: Notification.SlotType.SOCIAL_COMMUNICATION
F
fangJinliang1 已提交
1299
};
1300
Notification.setSlotByBundle(bundle, notificationSlot).then(() => {
Z
zhongjianfei 已提交
1301
	console.info("setSlotByBundle success");
Z
zhaoyuan17 已提交
1302 1303 1304
});
```

X
xuzhihao 已提交
1305
## Notification.getSlotsByBundle
Z
zhaoyuan17 已提交
1306

1307
getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback\<Array\<NotificationSlot>>): void
Z
zhaoyuan17 已提交
1308

Z
zhongjianfei 已提交
1309
获取指定应用的所有通知通道(Callback形式)。
Z
zhaoyuan17 已提交
1310

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

X
xuzhihao 已提交
1313 1314 1315
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1317
**参数:**
Z
zhaoyuan17 已提交
1318

X
xuzhihao 已提交
1319
| 参数名     | 类型                                     | 必填 | 说明                 |
X
xuzhihao 已提交
1320
| -------- | ---------------------------------------- | ---- | -------------------- |
Z
zhongjianfei 已提交
1321
| bundle   | [BundleOption](#bundleoption)                             | 是   | 指定应用的包信息。           |
1322
| callback | AsyncCallback\<Array\<[NotificationSlot](#notificationslot)>> | 是   | 获取通知通道回调函数。 |
Z
zhaoyuan17 已提交
1323

X
xuzhihao 已提交
1324
**示例:**
Z
zhaoyuan17 已提交
1325 1326 1327

```js
function getSlotsByBundleCallback(err, data) {
F
fangJinliang1 已提交
1328 1329 1330 1331 1332
    if (err.code) {
        console.info("getSlotsByBundle failed " + JSON.stringify(err));
    } else {
        console.info("getSlotsByBundle success");
    }
Z
zhaoyuan17 已提交
1333
}
F
fangJinliang1 已提交
1334
let bundle = {
Z
zengsiyu 已提交
1335
    bundle: "bundleName1",
F
fangJinliang1 已提交
1336
};
Z
zhaoyuan17 已提交
1337 1338 1339
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```

X
xuzhihao 已提交
1340
## Notification.getSlotsByBundle
Z
zhaoyuan17 已提交
1341

1342
getSlotsByBundle(bundle: BundleOption): Promise\<Array\<NotificationSlot>>
Z
zhaoyuan17 已提交
1343

Z
zhongjianfei 已提交
1344
获取指定应用的所有通知通道(Promise形式)。
Z
zhaoyuan17 已提交
1345

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

X
xuzhihao 已提交
1348 1349 1350
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1352
**参数:**
Z
zhaoyuan17 已提交
1353

X
xuzhihao 已提交
1354
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1355
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1356
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1357

X
xuzhihao 已提交
1358
**返回值:**
Z
zhaoyuan17 已提交
1359

X
xuzhihao 已提交
1360 1361
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
1362
| Promise\<Array\<[NotificationSlot](#notificationslot)>> | 以Promise形式返回获取指定应用的通知通道。 |
X
xuzhihao 已提交
1363 1364

**示例:**
Z
zhaoyuan17 已提交
1365 1366

```js
F
fangJinliang1 已提交
1367
let bundle = {
Z
zengsiyu 已提交
1368
    bundle: "bundleName1",
F
fangJinliang1 已提交
1369
};
Z
zhaoyuan17 已提交
1370
Notification.getSlotsByBundle(bundle).then((data) => {
Z
zhongjianfei 已提交
1371
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1372 1373 1374
});
```

X
xuzhihao 已提交
1375
## Notification.getSlotNumByBundle
Z
zhaoyuan17 已提交
1376

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

Z
zhongjianfei 已提交
1379
获取指定应用的通知通道数量(Callback形式)。
Z
zhaoyuan17 已提交
1380

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

X
xuzhihao 已提交
1383 1384 1385
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1387
**参数:**
Z
zhaoyuan17 已提交
1388

X
xuzhihao 已提交
1389
| 参数名     | 类型                      | 必填 | 说明                   |
X
xuzhihao 已提交
1390
| -------- | ------------------------- | ---- | ---------------------- |
Z
zhongjianfei 已提交
1391 1392
| bundle   | [BundleOption](#bundleoption)              | 是   | 指定应用的包信息。             |
| callback | AsyncCallback\<number\> | 是   | 获取通知通道数量回调函数。 |
Z
zhaoyuan17 已提交
1393

X
xuzhihao 已提交
1394
**示例:**
Z
zhaoyuan17 已提交
1395 1396

```js
1397
function getSlotNumByBundleCallback(err, data) {
F
fangJinliang1 已提交
1398 1399 1400 1401 1402
    if (err.code) {
        console.info("getSlotNumByBundle failed " + JSON.stringify(err));
    } else {
        console.info("getSlotNumByBundle success");
    }
Z
zhaoyuan17 已提交
1403
}
F
fangJinliang1 已提交
1404
let bundle = {
Z
zengsiyu 已提交
1405
    bundle: "bundleName1",
F
fangJinliang1 已提交
1406
};
Z
zhaoyuan17 已提交
1407 1408 1409
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```

X
xuzhihao 已提交
1410 1411 1412
## Notification.getSlotNumByBundle

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

Z
zhongjianfei 已提交
1414
获取指定应用的通知通道数量(Promise形式)。
Z
zhaoyuan17 已提交
1415

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

X
xuzhihao 已提交
1418 1419 1420
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1422
**参数:**
Z
zhaoyuan17 已提交
1423

X
xuzhihao 已提交
1424
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1425
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1426
| bundle | [BundleOption](#bundleoption) | 是   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1427

X
xuzhihao 已提交
1428
**返回值:**
Z
zhaoyuan17 已提交
1429

X
xuzhihao 已提交
1430 1431
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
Z
zhongjianfei 已提交
1432
| Promise\<number\> | 以Promise形式返回获取指定应用的通知通道数量。 |
Z
zhaoyuan17 已提交
1433

X
xuzhihao 已提交
1434
**示例:**
Z
zhaoyuan17 已提交
1435 1436

```js
F
fangJinliang1 已提交
1437
let bundle = {
Z
zengsiyu 已提交
1438
    bundle: "bundleName1",
F
fangJinliang1 已提交
1439
};
Z
zhaoyuan17 已提交
1440
Notification.getSlotNumByBundle(bundle).then((data) => {
Z
zhongjianfei 已提交
1441
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1442 1443 1444
});
```

X
xuzhihao 已提交
1445
## Notification.remove
Z
zhaoyuan17 已提交
1446

Z
zero-cyc 已提交
1447
remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1448

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

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

X
xuzhihao 已提交
1453 1454 1455
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1457
**参数:**
Z
zhaoyuan17 已提交
1458

X
xuzhihao 已提交
1459
| 参数名            | 类型                                | 必填 | 说明                 |
1460
| --------------- |   ----------------------------------| ---- | -------------------- |
Z
zhongjianfei 已提交
1461
| bundle          | [BundleOption](#bundleoption)       | 是   | 指定应用的包信息。           |
1462
| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是   | 通知键值。             |
1463
| reason          | [RemoveReason](#removereason9)      | 是   | 通知删除原因。         |
X
xuzhihao 已提交
1464
| callback        | AsyncCallback\<void\>               | 是   | 删除指定通知回调函数。 |
Z
zhaoyuan17 已提交
1465

X
xuzhihao 已提交
1466
**示例:**
Z
zhaoyuan17 已提交
1467 1468 1469

```js
function removeCallback(err) {
F
fangJinliang1 已提交
1470 1471 1472 1473 1474
    if (err.code) {
        console.info("remove failed " + JSON.stringify(err));
    } else {
        console.info("remove success");
    }
Z
zhaoyuan17 已提交
1475
}
F
fangJinliang1 已提交
1476
let bundle = {
Z
zengsiyu 已提交
1477
    bundle: "bundleName1",
F
fangJinliang1 已提交
1478 1479
};
let notificationKey = {
Z
zengsiyu 已提交
1480 1481
    id: 0,
    label: "label",
F
fangJinliang1 已提交
1482 1483
};
let reason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Z
zero-cyc 已提交
1484
Notification.remove(bundle, notificationKey, reason, removeCallback);
Z
zhaoyuan17 已提交
1485 1486
```

X
xuzhihao 已提交
1487
## Notification.remove
Z
zhaoyuan17 已提交
1488

Z
zero-cyc 已提交
1489
remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise\<void\>
Z
zhaoyuan17 已提交
1490

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

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

X
xuzhihao 已提交
1495 1496 1497
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1499
**参数:**
Z
zhaoyuan17 已提交
1500

X
xuzhihao 已提交
1501
| 参数名            | 类型            | 必填 | 说明       |
X
xuzhihao 已提交
1502
| --------------- | --------------- | ---- | ---------- |
Z
zhongjianfei 已提交
1503
| bundle          | [BundleOption](#bundleoption)    | 是   | 指定应用的包信息。 |
1504
| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是   | 通知键值。   |
1505
| reason          | [RemoveReason](#removereason9) | 是   | 通知删除原因。         |
Z
zhaoyuan17 已提交
1506

X
xuzhihao 已提交
1507
**示例:**
Z
zhaoyuan17 已提交
1508 1509

```js
F
fangJinliang1 已提交
1510
let bundle = {
Z
zengsiyu 已提交
1511
    bundle: "bundleName1",
F
fangJinliang1 已提交
1512 1513
};
let notificationKey = {
Z
zengsiyu 已提交
1514 1515
    id: 0,
    label: "label",
F
fangJinliang1 已提交
1516 1517
};
let reason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Z
zero-cyc 已提交
1518
Notification.remove(bundle, notificationKey, reason).then(() => {
Z
zhongjianfei 已提交
1519
	console.info("remove success");
Z
zhaoyuan17 已提交
1520 1521 1522
});
```

X
xuzhihao 已提交
1523
## Notification.remove
Z
zhaoyuan17 已提交
1524

Z
zero-cyc 已提交
1525
remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\<void\>): void
Z
zhaoyuan17 已提交
1526

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

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

X
xuzhihao 已提交
1531 1532 1533
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1535
**参数:**
Z
zhaoyuan17 已提交
1536

X
xuzhihao 已提交
1537
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
1538
| -------- | --------------------- | ---- | -------------------- |
1539
| hashCode | string                | 是   | 通知唯一ID。可以通过[onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume)回调的入参[SubscribeCallbackData](#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 |
1540
| reason   | [RemoveReason](#removereason9) | 是   | 通知删除原因。         |
X
xuzhihao 已提交
1541
| callback | AsyncCallback\<void\> | 是   | 删除指定通知回调函数。 |
Z
zhaoyuan17 已提交
1542

X
xuzhihao 已提交
1543
**示例:**
Z
zhaoyuan17 已提交
1544 1545

```js
F
fangJinliang1 已提交
1546
let hashCode = 'hashCode';
1547

Z
zhaoyuan17 已提交
1548
function removeCallback(err) {
F
fangJinliang1 已提交
1549 1550 1551 1552 1553
    if (err.code) {
        console.info("remove failed " + JSON.stringify(err));
    } else {
        console.info("remove success");
    }
Z
zhaoyuan17 已提交
1554
}
F
fangJinliang1 已提交
1555
let reason = Notification.RemoveReason.CANCEL_REASON_REMOVE;
Z
zero-cyc 已提交
1556
Notification.remove(hashCode, reason, removeCallback);
Z
zhaoyuan17 已提交
1557 1558
```

X
xuzhihao 已提交
1559
## Notification.remove
Z
zhaoyuan17 已提交
1560

Z
zero-cyc 已提交
1561
remove(hashCode: string, reason: RemoveReason): Promise\<void\>
Z
zhaoyuan17 已提交
1562

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

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

X
xuzhihao 已提交
1567 1568 1569
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

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

X
xuzhihao 已提交
1573
| 参数名     | 类型       | 必填 | 说明       |
X
xuzhihao 已提交
1574 1575
| -------- | ---------- | ---- | ---------- |
| hashCode | string | 是   | 通知唯一ID。 |
1576
| reason   | [RemoveReason](#removereason9) | 是   | 通知删除原因。         |
Z
zhaoyuan17 已提交
1577

X
xuzhihao 已提交
1578
**示例:**
Z
zhaoyuan17 已提交
1579 1580

```js
F
fangJinliang1 已提交
1581 1582
let hashCode = 'hashCode';
let reason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Z
zero-cyc 已提交
1583
Notification.remove(hashCode, reason).then(() => {
Z
zhongjianfei 已提交
1584
	console.info("remove success");
Z
zhaoyuan17 已提交
1585 1586 1587
});
```

X
xuzhihao 已提交
1588
## Notification.removeAll
Z
zhaoyuan17 已提交
1589

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

Z
zhongjianfei 已提交
1592
删除指定应用的所有通知(Callback形式)。
Z
zhaoyuan17 已提交
1593

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

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

X
xuzhihao 已提交
1598 1599
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

X
xuzhihao 已提交
1600
**参数:**
Z
zhaoyuan17 已提交
1601

X
xuzhihao 已提交
1602
| 参数名     | 类型                  | 必填 | 说明                         |
X
xuzhihao 已提交
1603
| -------- | --------------------- | ---- | ---------------------------- |
Z
zhongjianfei 已提交
1604 1605
| bundle   | [BundleOption](#bundleoption)          | 是   | 指定应用的包信息。                   |
| callback | AsyncCallback\<void\> | 是   | 删除指定应用的所有通知回调函数。 |
Z
zhaoyuan17 已提交
1606

X
xuzhihao 已提交
1607
**示例:**
Z
zhaoyuan17 已提交
1608 1609 1610

```js
function removeAllCallback(err) {
F
fangJinliang1 已提交
1611 1612 1613 1614 1615
    if (err.code) {
        console.info("removeAll failed " + JSON.stringify(err));
    } else {
        console.info("removeAll success");
    }
Z
zhaoyuan17 已提交
1616
}
F
fangJinliang1 已提交
1617
let bundle = {
Z
zengsiyu 已提交
1618
    bundle: "bundleName1",
F
fangJinliang1 已提交
1619
};
Z
zhaoyuan17 已提交
1620 1621 1622
Notification.removeAll(bundle, removeAllCallback);
```

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

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

R
RayShih 已提交
1627
删除所有通知(Callback形式)。
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
| 参数名     | 类型                  | 必填 | 说明                 |
X
xuzhihao 已提交
1638 1639
| -------- | --------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void\> | 是   | 删除所有通知回调函数。 |
Z
zhaoyuan17 已提交
1640

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

```js
function removeAllCallback(err) {
F
fangJinliang1 已提交
1645 1646 1647 1648 1649
    if (err.code) {
        console.info("removeAll failed " + JSON.stringify(err));
    } else {
        console.info("removeAll success");
    }
Z
zhaoyuan17 已提交
1650 1651 1652 1653 1654
}

Notification.removeAll(removeAllCallback);
```

X
xuzhihao 已提交
1655
## Notification.removeAll
Z
zhaoyuan17 已提交
1656

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

Z
zhongjianfei 已提交
1659
删除指定应用的所有通知(Promise形式)。
Z
zhaoyuan17 已提交
1660

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

X
xuzhihao 已提交
1663 1664 1665
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1667
**参数:**
Z
zhaoyuan17 已提交
1668

X
xuzhihao 已提交
1669
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1670
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1671
| bundle | [BundleOption](#bundleoption) | 否   | 指定应用的包信息。 |
Z
zhaoyuan17 已提交
1672

X
xuzhihao 已提交
1673
**示例:**
Z
zhaoyuan17 已提交
1674 1675

```js
Z
zhongjianfei 已提交
1676
// 不指定应用时,删除所有通知
Z
zengsiyu 已提交
1677
Notification.removeAll().then(() => {
Z
zhongjianfei 已提交
1678
	console.info("removeAll success");
Z
zhaoyuan17 已提交
1679 1680 1681
});
```

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

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

Z
zhongjianfei 已提交
1686
删除指定用户下的所有通知(callback形式)。
1687 1688 1689

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

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

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

1694 1695
**参数:**

X
xuzhihao 已提交
1696
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1697
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1698 1699
| userId | number | 是   | 用户ID。 |
| callback | AsyncCallback\<void\> | 是   | 删除指定用户所有通知回调函数。 |
1700 1701 1702 1703 1704

**示例:**

```js
function removeAllCallback(err) {
F
fangJinliang1 已提交
1705 1706 1707 1708 1709
    if (err.code) {
        console.info("removeAll failed " + JSON.stringify(err));
    } else {
        console.info("removeAll success");
    }
1710 1711
}

F
fangJinliang1 已提交
1712
let userId = 1;
1713 1714 1715 1716 1717
Notification.removeAll(userId, removeAllCallback);
```

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

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

Z
zhongjianfei 已提交
1720
删除指定用户下的所有通知(Promise形式)。
1721 1722 1723

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

X
xuzhihao 已提交
1724 1725 1726
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

1728 1729
**参数:**

X
xuzhihao 已提交
1730
| 参数名   | 类型         | 必填 | 说明       |
X
xuzhihao 已提交
1731
| ------ | ------------ | ---- | ---------- |
Z
zhongjianfei 已提交
1732
| userId | number | 是   | 用户ID。 |
1733 1734 1735 1736

**示例:**

```js
F
fangJinliang1 已提交
1737
let userId = 1;
Z
zhongjianfei 已提交
1738 1739 1740
Notification.removeAll(userId).then(() => {
	console.info("removeAll success");
});
1741
```
Z
zhaoyuan17 已提交
1742 1743


X
xuzhihao 已提交
1744
## Notification.getAllActiveNotifications
Z
zhaoyuan17 已提交
1745

1746
getAllActiveNotifications(callback: AsyncCallback\<Array\<NotificationRequest>>): void
Z
zhaoyuan17 已提交
1747

Z
zhongjianfei 已提交
1748
获取当前未删除的所有通知(Callback形式)。
Z
zhaoyuan17 已提交
1749

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

X
xuzhihao 已提交
1752 1753 1754
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
1756
**参数:**
Z
zhaoyuan17 已提交
1757

X
xuzhihao 已提交
1758
| 参数名     | 类型                                                         | 必填 | 说明                 |
X
xuzhihao 已提交
1759
| -------- | ------------------------------------------------------------ | ---- | -------------------- |
1760
| callback | AsyncCallback\<Array\<[NotificationRequest](#notificationrequest)>> | 是   | 获取活动通知回调函数。 |
Z
zhaoyuan17 已提交
1761

X
xuzhihao 已提交
1762
**示例:**
Z
zhaoyuan17 已提交
1763 1764 1765

```js
function getAllActiveNotificationsCallback(err, data) {
F
fangJinliang1 已提交
1766 1767 1768 1769 1770
    if (err.code) {
        console.info("getAllActiveNotifications failed " + JSON.stringify(err));
    } else {
        console.info("getAllActiveNotifications success");
    }
Z
zhaoyuan17 已提交
1771 1772 1773 1774 1775
}

Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
```

X
xuzhihao 已提交
1776
## Notification.getAllActiveNotifications
Z
zhaoyuan17 已提交
1777

1778
getAllActiveNotifications(): Promise\<Array\<[NotificationRequest](#notificationrequest)>>
Z
zhaoyuan17 已提交
1779

Z
zhongjianfei 已提交
1780
获取当前未删除的所有通知(Promise形式)。
Z
zhaoyuan17 已提交
1781

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

X
xuzhihao 已提交
1784 1785
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

X
xuzhihao 已提交
1786
**系统API**: 此接口为系统接口,三方应用不支持调用。
1787

X
xuzhihao 已提交
1788
**返回值:**
Z
zhaoyuan17 已提交
1789

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

X
xuzhihao 已提交
1794
**示例:**
Z
zhaoyuan17 已提交
1795 1796 1797

```js
Notification.getAllActiveNotifications().then((data) => {
Z
zhongjianfei 已提交
1798
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1799 1800 1801
});
```

X
xuzhihao 已提交
1802
## Notification.getActiveNotificationCount
Z
zhaoyuan17 已提交
1803

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

Z
zhongjianfei 已提交
1806
获取当前应用未删除的通知数(Callback形式)。
Z
zhaoyuan17 已提交
1807

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

X
xuzhihao 已提交
1810
**参数:**
Z
zhaoyuan17 已提交
1811

X
xuzhihao 已提交
1812
| 参数名     | 类型                   | 必填 | 说明                   |
X
xuzhihao 已提交
1813
| -------- | ---------------------- | ---- | ---------------------- |
Z
zhongjianfei 已提交
1814
| callback | AsyncCallback\<number\> | 是   | 获取未删除通知数回调函数。 |
Z
zhaoyuan17 已提交
1815

X
xuzhihao 已提交
1816
**示例:**
Z
zhaoyuan17 已提交
1817 1818 1819

```js
function getActiveNotificationCountCallback(err, data) {
F
fangJinliang1 已提交
1820 1821 1822 1823 1824
    if (err.code) {
        console.info("getActiveNotificationCount failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotificationCount success");
    }
Z
zhaoyuan17 已提交
1825 1826 1827 1828 1829
}

Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
```

X
xuzhihao 已提交
1830
## Notification.getActiveNotificationCount
Z
zhaoyuan17 已提交
1831

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

Z
zhongjianfei 已提交
1834
获取当前应用未删除的通知数(Promise形式)。
Z
zhaoyuan17 已提交
1835

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

X
xuzhihao 已提交
1838
**返回值:**
Z
zhaoyuan17 已提交
1839

Z
zhongjianfei 已提交
1840 1841 1842
| 类型              | 说明                                        |
| ----------------- | ------------------------------------------- |
| Promise\<number\> | 以Promise形式返回获取当前应用未删除通知数。 |
Z
zhaoyuan17 已提交
1843

X
xuzhihao 已提交
1844
**示例:**
Z
zhaoyuan17 已提交
1845 1846 1847

```js
Notification.getActiveNotificationCount().then((data) => {
Z
zhongjianfei 已提交
1848
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1849 1850 1851
});
```

X
xuzhihao 已提交
1852
## Notification.getActiveNotifications
Z
zhaoyuan17 已提交
1853

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

Z
zhongjianfei 已提交
1856
获取当前应用未删除的通知列表(Callback形式)。
Z
zhaoyuan17 已提交
1857

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

X
xuzhihao 已提交
1860
**参数:**
Z
zhaoyuan17 已提交
1861

X
xuzhihao 已提交
1862
| 参数名     | 类型                                                         | 必填 | 说明                           |
X
xuzhihao 已提交
1863
| -------- | ------------------------------------------------------------ | ---- | ------------------------------ |
Z
zhongjianfei 已提交
1864
| callback | AsyncCallback<Array\<[NotificationRequest](#notificationrequest)\>> | 是   | 获取当前应用通知列表回调函数。 |
Z
zhaoyuan17 已提交
1865

X
xuzhihao 已提交
1866
**示例:**
Z
zhaoyuan17 已提交
1867 1868 1869

```js
function getActiveNotificationsCallback(err, data) {
F
fangJinliang1 已提交
1870 1871 1872 1873 1874
    if (err.code) {
        console.info("getActiveNotifications failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotifications success");
    }
Z
zhaoyuan17 已提交
1875 1876 1877 1878 1879
}

Notification.getActiveNotifications(getActiveNotificationsCallback);
```

X
xuzhihao 已提交
1880
## Notification.getActiveNotifications
Z
zhaoyuan17 已提交
1881

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

Z
zhongjianfei 已提交
1884
获取当前应用未删除的通知列表(Promise形式)。
Z
zhaoyuan17 已提交
1885

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

X
xuzhihao 已提交
1888
**返回值:**
Z
zhaoyuan17 已提交
1889

Z
zhongjianfei 已提交
1890 1891 1892
| 类型                                                         | 说明                                    |
| ------------------------------------------------------------ | --------------------------------------- |
| Promise\<Array\<[NotificationRequest](#notificationrequest)\>\> | 以Promise形式返回获取当前应用通知列表。 |
Z
zhaoyuan17 已提交
1893

X
xuzhihao 已提交
1894
**示例:**
Z
zhaoyuan17 已提交
1895 1896 1897

```js
Notification.getActiveNotifications().then((data) => {
Z
zhongjianfei 已提交
1898
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
1899 1900 1901
});
```

1902
## Notification.cancelGroup<sup>8+</sup>
Z
zhaoyuan17 已提交
1903

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

Z
zhongjianfei 已提交
1906
取消本应用指定组下的通知(Callback形式)。
Z
zhaoyuan17 已提交
1907

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

X
xuzhihao 已提交
1910
**参数:**
Z
zhaoyuan17 已提交
1911

X
xuzhihao 已提交
1912
| 参数名      | 类型                  | 必填 | 说明                         |
X
xuzhihao 已提交
1913
| --------- | --------------------- | ---- | ---------------------------- |
Z
zhongjianfei 已提交
1914 1915
| groupName | string                | 是   | 通知组名称,此名称需要在发布通知时通过[NotificationRequest](#notificationrequest)对象指定。 |
| callback  | AsyncCallback\<void\> | 是   | 取消本应用指定组下通知的回调函数。 |
Z
zhaoyuan17 已提交
1916

X
xuzhihao 已提交
1917
**示例:**
Z
zhaoyuan17 已提交
1918 1919 1920

```js
function cancelGroupCallback(err) {
F
fangJinliang1 已提交
1921 1922 1923 1924 1925
    if (err.code) {
        console.info("cancelGroup failed " + JSON.stringify(err));
    } else {
        console.info("cancelGroup success");
    }
Z
zhaoyuan17 已提交
1926 1927
}

F
fangJinliang1 已提交
1928
let groupName = "GroupName";
Z
zhaoyuan17 已提交
1929 1930 1931 1932

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

1933
## Notification.cancelGroup<sup>8+</sup>
Z
zhaoyuan17 已提交
1934

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

Z
zhongjianfei 已提交
1937
取消本应用指定组下的通知(Promise形式)。
Z
zhaoyuan17 已提交
1938

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

X
xuzhihao 已提交
1941
**参数:**
Z
zhaoyuan17 已提交
1942

X
xuzhihao 已提交
1943
| 参数名      | 类型   | 必填 | 说明           |
X
xuzhihao 已提交
1944
| --------- | ------ | ---- | -------------- |
Z
zhongjianfei 已提交
1945
| groupName | string | 是   | 通知组名称。 |
Z
zhaoyuan17 已提交
1946

X
xuzhihao 已提交
1947
**示例:**
Z
zhaoyuan17 已提交
1948 1949

```js
F
fangJinliang1 已提交
1950
let groupName = "GroupName";
Z
zhaoyuan17 已提交
1951
Notification.cancelGroup(groupName).then(() => {
Z
zhongjianfei 已提交
1952
	console.info("cancelGroup success");
Z
zhaoyuan17 已提交
1953 1954 1955
});
```

1956
## Notification.removeGroupByBundle<sup>8+</sup>
Z
zhaoyuan17 已提交
1957

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

Z
zhongjianfei 已提交
1960
删除指定应用的指定组下的通知(Callback形式)。
Z
zhaoyuan17 已提交
1961

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

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

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

X
xuzhihao 已提交
1968
**参数:**
Z
zhaoyuan17 已提交
1969

X
xuzhihao 已提交
1970
| 参数名      | 类型                  | 必填 | 说明                         |
X
xuzhihao 已提交
1971
| --------- | --------------------- | ---- | ---------------------------- |
Z
zhongjianfei 已提交
1972 1973 1974
| bundle    | [BundleOption](#bundleoption)          | 是   | 应用的包信息。                   |
| groupName | string                | 是   | 通知组名称。               |
| callback  | AsyncCallback\<void\> | 是   | 删除指定应用指定组下通知的回调函数。 |
Z
zhaoyuan17 已提交
1975

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

```js
function removeGroupByBundleCallback(err) {
F
fangJinliang1 已提交
1980 1981 1982 1983 1984
    if (err.code) {
        console.info("removeGroupByBundle failed " + JSON.stringify(err));
    } else {
        console.info("removeGroupByBundle success");
    }
Z
zhaoyuan17 已提交
1985 1986
}

F
fangJinliang1 已提交
1987 1988
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
Z
zhaoyuan17 已提交
1989 1990 1991 1992

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

1993
## Notification.removeGroupByBundle<sup>8+</sup>
Z
zhaoyuan17 已提交
1994

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

Z
zhongjianfei 已提交
1997
删除指定应用的指定组下的通知(Promise形式)。
Z
zhaoyuan17 已提交
1998

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

X
xuzhihao 已提交
2001 2002 2003
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2005
**参数:**
Z
zhaoyuan17 已提交
2006

X
xuzhihao 已提交
2007
| 参数名      | 类型         | 必填 | 说明           |
X
xuzhihao 已提交
2008
| --------- | ------------ | ---- | -------------- |
Z
zhongjianfei 已提交
2009 2010
| bundle    | [BundleOption](#bundleoption) | 是   | 应用的包信息。     |
| groupName | string       | 是   | 通知组名称。 |
Z
zhaoyuan17 已提交
2011

X
xuzhihao 已提交
2012
**示例:**
Z
zhaoyuan17 已提交
2013 2014

```js
F
fangJinliang1 已提交
2015 2016
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
Z
zhaoyuan17 已提交
2017
Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
Z
zhongjianfei 已提交
2018
	console.info("removeGroupByBundle success");
Z
zhaoyuan17 已提交
2019 2020 2021
});
```

2022
## Notification.setDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2023

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

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

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

X
xuzhihao 已提交
2030 2031 2032
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2034
**参数:**
Z
zhaoyuan17 已提交
2035

X
xuzhihao 已提交
2036
| 参数名     | 类型                  | 必填 | 说明                   |
X
xuzhihao 已提交
2037 2038 2039
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate8)      | 是   | 免打扰时间选项。         |
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |
Z
zhaoyuan17 已提交
2040

X
xuzhihao 已提交
2041
**示例:**
Z
zhaoyuan17 已提交
2042 2043 2044

```js
function setDoNotDisturbDateCallback(err) {
F
fangJinliang1 已提交
2045 2046 2047 2048 2049
    if (err.code) {
        console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("setDoNotDisturbDate success");
    }
Z
zhaoyuan17 已提交
2050 2051
}

F
fangJinliang1 已提交
2052
let doNotDisturbDate = {
Z
zengsiyu 已提交
2053
    type: Notification.DoNotDisturbType.TYPE_ONCE,
X
xuchenghua09 已提交
2054 2055
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2056
};
Z
zhaoyuan17 已提交
2057 2058 2059 2060

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

2061
## Notification.setDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2062

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

Z
zhongjianfei 已提交
2065
设置免打扰时间(Promise形式)。
Z
zhaoyuan17 已提交
2066

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

X
xuzhihao 已提交
2069 2070 2071
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2073
**参数:**
Z
zhaoyuan17 已提交
2074

X
xuzhihao 已提交
2075
| 参数名 | 类型             | 必填 | 说明           |
X
xuzhihao 已提交
2076 2077
| ---- | ---------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#donotdisturbdate8) | 是   | 免打扰时间选项。 |
Z
zhaoyuan17 已提交
2078

X
xuzhihao 已提交
2079
**示例:**
Z
zhaoyuan17 已提交
2080 2081

```js
F
fangJinliang1 已提交
2082
let doNotDisturbDate = {
Z
zengsiyu 已提交
2083
    type: Notification.DoNotDisturbType.TYPE_ONCE,
X
xuchenghua09 已提交
2084 2085
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2086
};
Z
zhaoyuan17 已提交
2087
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
Z
zhongjianfei 已提交
2088
	console.info("setDoNotDisturbDate success");
Z
zhaoyuan17 已提交
2089 2090 2091 2092
});
```


2093 2094 2095 2096
## Notification.setDoNotDisturbDate<sup>8+</sup>

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

R
RayShih 已提交
2097
指定用户设置免打扰时间(Callback形式)。
2098 2099 2100

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

X
xuzhihao 已提交
2101 2102 2103
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2105 2106
**参数:**

X
xuzhihao 已提交
2107
| 参数名     | 类型                  | 必填 | 说明                   |
X
xuzhihao 已提交
2108 2109
| -------- | --------------------- | ---- | ---------------------- |
| date     | [DoNotDisturbDate](#donotdisturbdate8)      | 是   | 免打扰时间选项。         |
Z
zhongjianfei 已提交
2110
| userId   | number                | 是   | 设置免打扰时间的用户ID。 |
X
xuzhihao 已提交
2111
| callback | AsyncCallback\<void\> | 是   | 设置免打扰时间回调函数。 |
2112 2113 2114 2115 2116

**示例:**

```js
function setDoNotDisturbDateCallback(err) {
F
fangJinliang1 已提交
2117 2118 2119 2120 2121
    if (err.code) {
        console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("setDoNotDisturbDate success");
    }
2122 2123
}

F
fangJinliang1 已提交
2124
let doNotDisturbDate = {
2125 2126 2127
    type: Notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2128
};
2129

F
fangJinliang1 已提交
2130
let userId = 1
2131 2132 2133 2134 2135 2136 2137
Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
```

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

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

Z
zhongjianfei 已提交
2138
指定用户设置免打扰时间(Promise形式)。
2139 2140 2141

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

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

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

2146 2147
**参数:**

X
xuzhihao 已提交
2148
| 参数名   | 类型             | 必填 | 说明           |
X
xuzhihao 已提交
2149 2150
| ------ | ---------------- | ---- | -------------- |
| date   | [DoNotDisturbDate](#donotdisturbdate8) | 是   | 免打扰时间选项。 |
Z
zhongjianfei 已提交
2151
| userId | number           | 是   | 设置免打扰时间的用户ID。 |
2152 2153 2154 2155

**示例:**

```js
F
fangJinliang1 已提交
2156
let doNotDisturbDate = {
2157 2158 2159
    type: Notification.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
F
fangJinliang1 已提交
2160
};
2161

F
fangJinliang1 已提交
2162
let userId = 1;
2163 2164

Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
Z
zhongjianfei 已提交
2165
	console.info("setDoNotDisturbDate success");
2166 2167 2168
});
```

Z
zhaoyuan17 已提交
2169

2170
## Notification.getDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2171

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

Z
zhongjianfei 已提交
2174
查询免打扰时间(Callback形式)。
Z
zhaoyuan17 已提交
2175

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

X
xuzhihao 已提交
2178 2179 2180
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2182
**参数:**
Z
zhaoyuan17 已提交
2183

X
xuzhihao 已提交
2184
| 参数名     | 类型                              | 必填 | 说明                   |
X
xuzhihao 已提交
2185 2186
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是   | 查询免打扰时间回调函数。 |
Z
zhaoyuan17 已提交
2187

X
xuzhihao 已提交
2188
**示例:**
Z
zhaoyuan17 已提交
2189 2190

```js
Z
zhongjianfei 已提交
2191
function getDoNotDisturbDateCallback(err, data) {
F
fangJinliang1 已提交
2192 2193 2194 2195 2196
    if (err.code) {
        console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("getDoNotDisturbDate success");
    }
Z
zhaoyuan17 已提交
2197 2198 2199 2200 2201
}

Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
```

2202
## Notification.getDoNotDisturbDate<sup>8+</sup>
Z
zhaoyuan17 已提交
2203

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

Z
zhongjianfei 已提交
2206
查询免打扰时间(Promise形式)。
Z
zhaoyuan17 已提交
2207

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

X
xuzhihao 已提交
2210 2211 2212
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2214
**返回值:**
Z
zhaoyuan17 已提交
2215

Z
zhongjianfei 已提交
2216 2217 2218
| 类型                                              | 说明                                      |
| ------------------------------------------------- | ----------------------------------------- |
| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询到的免打扰时间。 |
Z
zhaoyuan17 已提交
2219

X
xuzhihao 已提交
2220
**示例:**
Z
zhaoyuan17 已提交
2221 2222 2223

```js
Notification.getDoNotDisturbDate().then((data) => {
Z
zhongjianfei 已提交
2224
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
2225 2226 2227 2228
});
```


2229 2230 2231 2232
## Notification.getDoNotDisturbDate<sup>8+</sup>

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

Z
zhongjianfei 已提交
2233
查询指定用户的免打扰时间(Callback形式)。
2234 2235 2236

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

X
xuzhihao 已提交
2237 2238 2239 2240
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2241 2242
**参数:**

X
xuzhihao 已提交
2243
| 参数名     | 类型                              | 必填 | 说明                   |
X
xuzhihao 已提交
2244 2245
| -------- | --------------------------------- | ---- | ---------------------- |
| callback | AsyncCallback\<[DoNotDisturbDate](#donotdisturbdate8)\> | 是   | 查询免打扰时间回调函数。 |
Z
zhongjianfei 已提交
2246
| userId   | number                            | 是   | 用户ID。 |
2247 2248 2249 2250 2251

**示例:**

```js
function getDoNotDisturbDateCallback(err,data) {
F
fangJinliang1 已提交
2252 2253 2254 2255 2256
    if (err.code) {
        console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
    } else {
        console.info("getDoNotDisturbDate success");
    }
2257 2258
}

F
fangJinliang1 已提交
2259
let userId = 1;
2260 2261 2262 2263 2264 2265 2266 2267

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

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

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

Z
zhongjianfei 已提交
2268
查询指定用户的免打扰时间(Promise形式)。
2269 2270 2271

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

X
xuzhihao 已提交
2272 2273 2274 2275
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2276 2277
**参数:**

X
xuzhihao 已提交
2278
| 参数名     | 类型                              | 必填 | 说明                   |
X
xuzhihao 已提交
2279
| -------- | --------------------------------- | ---- | ---------------------- |
Z
zhongjianfei 已提交
2280
| userId   | number                            | 是   | 用户ID。 |
2281 2282 2283

**返回值:**

Z
zhongjianfei 已提交
2284 2285 2286
| 类型                                              | 说明                                      |
| ------------------------------------------------- | ----------------------------------------- |
| Promise\<[DoNotDisturbDate](#donotdisturbdate8)\> | 以Promise形式返回获取查询到的免打扰时间。 |
2287 2288 2289 2290

**示例:**

```js
F
fangJinliang1 已提交
2291
let userId = 1;
2292 2293

Notification.getDoNotDisturbDate(userId).then((data) => {
Z
zhongjianfei 已提交
2294
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
2295 2296 2297
});
```

Z
zhaoyuan17 已提交
2298

2299
## Notification.supportDoNotDisturbMode<sup>8+</sup>
Z
zhaoyuan17 已提交
2300

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

Z
zhongjianfei 已提交
2303
查询是否支持免打扰功能(Callback形式)。
Z
zhaoyuan17 已提交
2304

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

X
xuzhihao 已提交
2307 2308 2309
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2311
**参数:**
Z
zhaoyuan17 已提交
2312

X
xuzhihao 已提交
2313
| 参数名     | 类型                     | 必填 | 说明                             |
X
xuzhihao 已提交
2314
| -------- | ------------------------ | ---- | -------------------------------- |
Z
zhongjianfei 已提交
2315
| callback | AsyncCallback\<boolean\> | 是   | 查询是否支持免打扰功能回调函数。 |
Z
zhaoyuan17 已提交
2316

X
xuzhihao 已提交
2317
**示例:**
Z
zhaoyuan17 已提交
2318 2319 2320

```js
function supportDoNotDisturbModeCallback(err,data) {
F
fangJinliang1 已提交
2321 2322 2323 2324 2325
    if (err.code) {
        console.info("supportDoNotDisturbMode failed " + JSON.stringify(err));
    } else {
        console.info("supportDoNotDisturbMode success");
    }
Z
zhaoyuan17 已提交
2326 2327 2328 2329 2330
}

Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
```

2331
## Notification.supportDoNotDisturbMode<sup>8+</sup>
Z
zhaoyuan17 已提交
2332

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

Z
zhongjianfei 已提交
2335
查询是否支持免打扰功能(Promise形式)。
Z
zhaoyuan17 已提交
2336

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

X
xuzhihao 已提交
2339 2340 2341
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2343
**返回值:**
Z
zhaoyuan17 已提交
2344

X
xuzhihao 已提交
2345 2346
| 类型                                                        | 说明                                                         |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
Z
zhongjianfei 已提交
2347
| Promise\<boolean\> | 以Promise形式返回获取是否支持免打扰功能的结果。 |
Z
zhaoyuan17 已提交
2348

X
xuzhihao 已提交
2349
**示例:**
Z
zhaoyuan17 已提交
2350 2351 2352

```js
Notification.supportDoNotDisturbMode().then((data) => {
Z
zhongjianfei 已提交
2353
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
Z
zhaoyuan17 已提交
2354 2355 2356
});
```

2357
## Notification.isSupportTemplate<sup>8+</sup>
Z
zengsiyu 已提交
2358 2359 2360

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

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

X
xuzhihao 已提交
2363 2364 2365
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2366 2367 2368

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

X
xuzhihao 已提交
2372
**示例:**
Z
zengsiyu 已提交
2373 2374

```javascript
F
fangJinliang1 已提交
2375
let templateName = 'process';
Z
zengsiyu 已提交
2376
function isSupportTemplateCallback(err, data) {
F
fangJinliang1 已提交
2377 2378 2379 2380 2381
    if (err.code) {
        console.info("isSupportTemplate failed " + JSON.stringify(err));
    } else {
        console.info("isSupportTemplate success");
    }
Z
zengsiyu 已提交
2382 2383 2384 2385 2386
}

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

2387
## Notification.isSupportTemplate<sup>8+</sup>
Z
zengsiyu 已提交
2388 2389 2390

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

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

X
xuzhihao 已提交
2393 2394 2395
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2396 2397 2398

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

X
xuzhihao 已提交
2401
**返回值:**
Z
zengsiyu 已提交
2402 2403 2404

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

X
xuzhihao 已提交
2407
**示例:**
Z
zengsiyu 已提交
2408 2409

```javascript
F
fangJinliang1 已提交
2410
let templateName = 'process';
Z
zengsiyu 已提交
2411 2412

Notification.isSupportTemplate(templateName).then((data) => {
F
fangJinliang1 已提交
2413
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
Z
zengsiyu 已提交
2414 2415 2416
});
```

2417
## Notification.requestEnableNotification<sup>8+</sup>
Z
zengsiyu 已提交
2418

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

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

X
xuzhihao 已提交
2423 2424 2425
**系统能力**:SystemCapability.Notification.Notification

**参数:**
Z
zengsiyu 已提交
2426 2427 2428

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

X
xuzhihao 已提交
2431
**示例:**
Z
zengsiyu 已提交
2432 2433

```javascript
X
xuzhihao 已提交
2434
function requestEnableNotificationCallback(err) {
F
fangJinliang1 已提交
2435 2436 2437
    if (err.code) {
        console.info("requestEnableNotification failed " + JSON.stringify(err));
    } else {
Z
zhongjianfei 已提交
2438
        console.info("requestEnableNotification success");
F
fangJinliang1 已提交
2439
    }
Z
zengsiyu 已提交
2440 2441
};

2442
Notification.requestEnableNotification(requestEnableNotificationCallback);
Z
zengsiyu 已提交
2443 2444
```

2445
## Notification.requestEnableNotification<sup>8+</sup>
Z
zengsiyu 已提交
2446

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

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

X
xuzhihao 已提交
2451 2452 2453
**系统能力**:SystemCapability.Notification.Notification

**示例:**
Z
zengsiyu 已提交
2454 2455

```javascript
Z
zhongjianfei 已提交
2456 2457 2458
Notification.requestEnableNotification().then(() => {
    console.info("requestEnableNotification success");
});
Z
zengsiyu 已提交
2459 2460 2461
```


2462
## Notification.enableDistributed<sup>8+</sup>
X
xuzhihao 已提交
2463

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

F
fangjinliang 已提交
2466
设置设备是否支持分布式通知(Callback形式)。
X
xuzhihao 已提交
2467 2468 2469

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

X
xuzhihao 已提交
2470 2471 2472
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

X
xuzhihao 已提交
2474 2475
**参数:**

2476 2477
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Z
zhongjianfei 已提交
2478
| enable   | boolean                  | 是   | 是否支持。 |
2479
| callback | AsyncCallback\<void\> | 是   | 设置设备是否支持分布式通知的回调函数。 |
X
xuzhihao 已提交
2480 2481 2482 2483

**示例:**

```javascript
X
xuzhihao 已提交
2484
function enabledNotificationCallback(err) {
F
fangJinliang1 已提交
2485 2486 2487 2488 2489
    if (err.code) {
        console.info("enableDistributed failed " + JSON.stringify(err));
    } else {
        console.info("enableDistributed success");
    }
X
xuzhihao 已提交
2490 2491
};

F
fangJinliang1 已提交
2492
let enable = true;
2493 2494

Notification.enableDistributed(enable, enabledNotificationCallback);
X
xuzhihao 已提交
2495 2496
```

2497
## Notification.enableDistributed<sup>8+</sup>
Z
zengsiyu 已提交
2498

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

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

2503
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2504

X
xuzhihao 已提交
2505 2506 2507
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2509
**参数:**
Z
zengsiyu 已提交
2510

2511 2512
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Z
zhongjianfei 已提交
2513
| enable   | boolean                  | 是   | 是否支持。 |
2514 2515 2516 2517

**示例:**

```javascript
F
fangJinliang1 已提交
2518
let enable = true;
Z
zhongjianfei 已提交
2519 2520 2521
Notification.enableDistributed(enable).then(() => {
    console.info("enableDistributed success");
});
2522 2523 2524 2525 2526
```


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

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

Z
zhongjianfei 已提交
2529
查询设备是否支持分布式通知(Callback形式)。
Z
zengsiyu 已提交
2530

X
xuzhihao 已提交
2531 2532 2533
**系统能力**:SystemCapability.Notification.Notification

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

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

X
xuzhihao 已提交
2539
**示例:**
Z
zengsiyu 已提交
2540 2541

```javascript
X
xuzhihao 已提交
2542
function isDistributedEnabledCallback(err, data) {
F
fangJinliang1 已提交
2543 2544 2545
    if (err.code) {
        console.info("isDistributedEnabled failed " + JSON.stringify(err));
    } else {
X
xuzhihao 已提交
2546
        console.info("isDistributedEnabled success " + JSON.stringify(data));
F
fangJinliang1 已提交
2547
    }
Z
zengsiyu 已提交
2548 2549
};

2550
Notification.isDistributedEnabled(isDistributedEnabledCallback);
Z
zengsiyu 已提交
2551 2552
```

2553
## Notification.isDistributedEnabled<sup>8+</sup>
X
xuezhongzhu 已提交
2554

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

Z
zhongjianfei 已提交
2557
查询设备是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2558

2559
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2560

2561
**返回值:**
Z
zengsiyu 已提交
2562

Z
zhongjianfei 已提交
2563 2564 2565
| 类型               | 说明                                          |
| ------------------ | --------------------------------------------- |
| Promise\<boolean\> | Promise方式返回设备是否支持分布式通知的结果。 |
Z
zengsiyu 已提交
2566

2567
**示例:**
X
xuezhongzhu 已提交
2568

2569
```javascript
Z
zhongjianfei 已提交
2570 2571 2572
Notification.isDistributedEnabled().then((data) => {
    console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
});
2573
```
Z
zengsiyu 已提交
2574 2575


2576
## Notification.enableDistributedByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2577

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

Z
zhongjianfei 已提交
2580
设置指定应用是否支持分布式通知(Callback形式)。
X
xuezhongzhu 已提交
2581

2582
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2583

X
xuzhihao 已提交
2584 2585 2586
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2588
**参数:**
Z
zengsiyu 已提交
2589

2590 2591
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
Z
zhongjianfei 已提交
2592
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包信息。                   |
2593 2594
| enable   | boolean                  | 是   | 是否支持。                       |
| callback | AsyncCallback\<void\> | 是   | 应用程序是否支持分布式通知的回调函数。 |
Z
zengsiyu 已提交
2595

2596
**示例:**
Z
zengsiyu 已提交
2597

2598
```javascript
X
xuzhihao 已提交
2599
function enableDistributedByBundleCallback(err) {
F
fangJinliang1 已提交
2600 2601 2602 2603 2604
    if (err.code) {
        console.info("enableDistributedByBundle failed " + JSON.stringify(err));
    } else {
        console.info("enableDistributedByBundle success");
    }
2605
};
Z
zengsiyu 已提交
2606

F
fangJinliang1 已提交
2607
let bundle = {
2608
    bundle: "bundleName1",
F
fangJinliang1 已提交
2609
};
X
xuezhongzhu 已提交
2610

F
fangJinliang1 已提交
2611
let enable = true;
Z
zengsiyu 已提交
2612

2613 2614
Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundleCallback);
```
Z
zengsiyu 已提交
2615

2616
## Notification.enableDistributedByBundle<sup>8+</sup>
X
xuezhongzhu 已提交
2617

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

Z
zhongjianfei 已提交
2620
设置指定应用是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2621

2622
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2623

X
xuzhihao 已提交
2624 2625 2626
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2628
**参数:**
Z
zengsiyu 已提交
2629

2630 2631
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2632
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |
2633
| enable   | boolean                  | 是   | 是否支持。                  |
X
xuezhongzhu 已提交
2634

2635
**示例:**
Z
zengsiyu 已提交
2636

2637
```javascript
F
fangJinliang1 已提交
2638
let bundle = {
2639
    bundle: "bundleName1",
F
fangJinliang1 已提交
2640
};
Z
zengsiyu 已提交
2641

F
fangJinliang1 已提交
2642
let enable = true;
Z
zhongjianfei 已提交
2643 2644 2645
Notification.enableDistributedByBundle(bundle, enable).then(() => {
    console.info("enableDistributedByBundle success");
});
2646
```
Z
zengsiyu 已提交
2647

2648
## Notification.isDistributedEnabledByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2649

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

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

2654
**系统能力**:SystemCapability.Notification.Notification
X
xuezhongzhu 已提交
2655

X
xuzhihao 已提交
2656 2657 2658
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2660
**参数:**
Z
zengsiyu 已提交
2661

2662 2663
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2664
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                     |
Z
zhongjianfei 已提交
2665
| callback | AsyncCallback\<boolean\> | 是   | 查询指定应用是否支持分布式通知的回调函数。 |
Z
zengsiyu 已提交
2666

2667
**示例:**
Z
zengsiyu 已提交
2668

2669
```javascript
X
xuzhihao 已提交
2670
function isDistributedEnabledByBundleCallback(err, data) {
F
fangJinliang1 已提交
2671 2672 2673
    if (err.code) {
        console.info("isDistributedEnabledByBundle failed " + JSON.stringify(err));
    } else {
X
xuzhihao 已提交
2674
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
F
fangJinliang1 已提交
2675
    }
2676
};
Z
zengsiyu 已提交
2677

F
fangJinliang1 已提交
2678
let bundle = {
2679
    bundle: "bundleName1",
F
fangJinliang1 已提交
2680
};
X
xuezhongzhu 已提交
2681

2682
Notification.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
2683
```
Z
zengsiyu 已提交
2684

2685
## Notification.isDistributedEnabledByBundle<sup>8+</sup>
Z
zengsiyu 已提交
2686

X
xuzhihao 已提交
2687
isDistributedEnabledByBundle(bundle: BundleOption): Promise\<boolean>
X
xuezhongzhu 已提交
2688

Z
zhongjianfei 已提交
2689
查询指定应用是否支持分布式通知(Promise形式)。
Z
zengsiyu 已提交
2690

2691
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2692

X
xuzhihao 已提交
2693 2694 2695
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2697
**参数:**
Z
zengsiyu 已提交
2698

2699 2700
| 参数名   | 类型                     | 必填 | 说明                       |
| -------- | ------------------------ | ---- | -------------------------- |
2701
| bundle   | [BundleOption](#bundleoption)             | 是   | 应用的包。                |
Z
zengsiyu 已提交
2702

2703
**返回值:**
X
xuezhongzhu 已提交
2704

Z
zhongjianfei 已提交
2705 2706 2707
| 类型               | 说明                                              |
| ------------------ | ------------------------------------------------- |
| Promise\<boolean\> | Promise方式返回指定应用是否支持分布式通知的结果。 |
Z
zengsiyu 已提交
2708

2709
**示例:**
Z
zengsiyu 已提交
2710

2711
```javascript
F
fangJinliang1 已提交
2712
let bundle = {
2713
    bundle: "bundleName1",
F
fangJinliang1 已提交
2714
};
Z
zengsiyu 已提交
2715

Z
zhongjianfei 已提交
2716 2717 2718
Notification.isDistributedEnabledByBundle(bundle).then((data) => {
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
2719
```
Z
zengsiyu 已提交
2720

X
xuezhongzhu 已提交
2721

2722
## Notification.getDeviceRemindType<sup>8+</sup>
Z
zengsiyu 已提交
2723

X
xuzhihao 已提交
2724
getDeviceRemindType(callback: AsyncCallback\<DeviceRemindType\>): void
Z
zengsiyu 已提交
2725

F
fangjinliang 已提交
2726
获取通知的提醒方式(Callback形式)。
Z
zengsiyu 已提交
2727

2728
**系统能力**:SystemCapability.Notification.Notification
Z
zengsiyu 已提交
2729

X
xuzhihao 已提交
2730 2731 2732
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2734
**参数:**
X
xuezhongzhu 已提交
2735

2736 2737
| 参数名   | 类型                               | 必填 | 说明                       |
| -------- | --------------------------------- | ---- | -------------------------- |
Z
zhongjianfei 已提交
2738
| callback | AsyncCallback\<[DeviceRemindType](#deviceremindtype8)\> | 是   | 获取通知提醒方式的回调函数。 |
Z
zengsiyu 已提交
2739

2740
**示例:**
Z
zengsiyu 已提交
2741

2742
```javascript
X
xuzhihao 已提交
2743
function getDeviceRemindTypeCallback(err,data) {
F
fangJinliang1 已提交
2744 2745 2746 2747 2748
    if (err.code) {
        console.info("getDeviceRemindType failed " + JSON.stringify(err));
    } else {
        console.info("getDeviceRemindType success");
    }
2749
};
Z
zengsiyu 已提交
2750

2751 2752
Notification.getDeviceRemindType(getDeviceRemindTypeCallback);
```
Z
zengsiyu 已提交
2753

2754
## Notification.getDeviceRemindType<sup>8+</sup>
Z
zengsiyu 已提交
2755

X
xuzhihao 已提交
2756
getDeviceRemindType(): Promise\<DeviceRemindType\>
Z
zengsiyu 已提交
2757

F
fangjinliang 已提交
2758
获取通知的提醒方式(Promise形式)。
Z
zengsiyu 已提交
2759

2760
**系统能力**:SystemCapability.Notification.Notification
X
xuezhongzhu 已提交
2761

X
xuzhihao 已提交
2762 2763 2764
**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER

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

2766
**返回值:**
Z
zengsiyu 已提交
2767

2768 2769
| 类型               | 说明            |
| ------------------ | --------------- |
Z
zhongjianfei 已提交
2770
| Promise\<[DeviceRemindType](#deviceremindtype8)\> | Promise方式返回获取通知提醒方式的结果。 |
Z
zengsiyu 已提交
2771

2772
**示例:**
Z
zengsiyu 已提交
2773

2774
```javascript
Z
zhongjianfei 已提交
2775 2776 2777
Notification.getDeviceRemindType().then((data) => {
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
2778
```
Z
zengsiyu 已提交
2779

2780 2781 2782 2783
## SubscribeCallbackData

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

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

X
xuzhihao 已提交
2786 2787 2788
| 名称            | 类型                                              | 可读 | 可写 | 说明     |
| --------------- | ------------------------------------------------- | ---- | --- | -------- |
| request         | [NotificationRequest](#notificationrequest)       | 是  | 否  | 通知内容。 |
Z
zhongjianfei 已提交
2789
| sortingMap      | [NotificationSortingMap](#notificationsortingmap) | 是  | 否  | 通知排序信息。 |
X
xuzhihao 已提交
2790 2791 2792
| reason          | number                                            | 是  | 否  | 删除原因。 |
| sound           | string                                            | 是  | 否  | 通知声音。 |
| vibrationValues | Array\<number\>                                   | 是  | 否  | 通知震动。 |
2793 2794 2795 2796 2797 2798


## EnabledNotificationCallbackData<sup>8+</sup>

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

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

X
xuzhihao 已提交
2801 2802 2803 2804 2805
| 名称   | 类型    | 可读 | 可写 | 说明             |
| ------ | ------- | ---- | --- | ---------------- |
| bundle | string  | 是  | 否  | 应用的包名。       |
| uid    | number  | 是  | 否  | 应用的uid。        |
| enable | boolean | 是  | 否  | 应用通知使能状态。 |
2806

X
xuezhongzhu 已提交
2807

2808
## DoNotDisturbDate<sup>8+</sup> <sup>deprecated</sup>
Z
zhaoyuan17 已提交
2809

2810
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2811

2812 2813 2814
> **说明:**
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[notificationManager.DoNotDisturbDate](js-apis-notificationManager.md#donotdisturbdate)替代

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

Z
zhongjianfei 已提交
2817 2818 2819 2820 2821
| 名称  | 类型                                   | 可读 | 可写 | 说明                   |
| ----- | -------------------------------------- | ---- | ---- | ---------------------- |
| type  | [DoNotDisturbType](#donotdisturbtype8) | 是   | 是   | 免打扰设置的时间类型。 |
| begin | Date                                   | 是   | 是   | 免打扰设置的起点时间。 |
| end   | Date                                   | 是   | 是   | 免打扰设置的终点时间。 |
Z
zhaoyuan17 已提交
2822

2823
## DoNotDisturbType<sup>8+</sup> <sup>deprecated</sup>
Z
zhaoyuan17 已提交
2824

2825
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2826

2827 2828 2829
> **说明:**
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[notificationManager.DoNotDisturbType](js-apis-notificationManager.md#donotdisturbtype)替代

X
xuzhihao 已提交
2830
**系统API**: 此接口为系统接口,三方应用不支持调用。
Z
zhaoyuan17 已提交
2831

2832 2833
| 名称         | 值               | 说明                                       |
| ------------ | ---------------- | ------------------------------------------ |
2834 2835 2836 2837
| TYPE_NONE    | 0 | 非通知勿扰类型。                           |
| TYPE_ONCE    | 1 | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
| TYPE_DAILY   | 2 | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
| TYPE_CLEARLY | 3 | 以设置时间段(明确年月日时分)执行勿扰。     |
Z
zhaoyuan17 已提交
2838 2839


2840
## ContentType
Z
zhaoyuan17 已提交
2841

2842
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2843

2844 2845
| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
2846 2847 2848 2849 2850
| 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 已提交
2851

X
xuzhihao 已提交
2852
## SlotLevel
Z
zhaoyuan17 已提交
2853

2854
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2855

X
xuzhihao 已提交
2856 2857 2858
| 名称                              | 值          | 说明               |
| --------------------------------- | ----------- | ------------------ |
| LEVEL_NONE                        | 0           | 表示关闭通知功能。     |
F
fangjinliang 已提交
2859 2860 2861 2862
| LEVEL_MIN                         | 1           | 表示通知功能已启用,但状态栏中不显示通知图标,且没有横幅或提示音。 |
| LEVEL_LOW                         | 2           | 表示通知功能已启用,且状态栏中显示通知图标,但没有横幅或提示音。 |
| LEVEL_DEFAULT                     | 3           | 表示通知功能已启用,状态栏中显示通知图标,没有横幅但有提示音。 |
| LEVEL_HIGH                        | 4           | 表示通知功能已启用,状态栏中显示通知图标,有横幅和提示音。 |
Z
zhaoyuan17 已提交
2863 2864


2865
## BundleOption<sup>deprecated</sup>
Z
zhaoyuan17 已提交
2866

2867
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2868

2869 2870 2871 2872
> **说明:**
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption)替代

| 名称   | 类型   | 只读 | 必填 | 说明   |
X
xuzhihao 已提交
2873
| ------ | ------ |---- | --- |  ------ |
2874 2875
| bundle | string | 否  | 是  | 应用的包信息。 |
| uid    | number | 否  | 否  | 用户ID。 |
Z
zhaoyuan17 已提交
2876

2877
## NotificationKey<sup>deprecated</sup>
Z
zhaoyuan17 已提交
2878

2879
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2880

2881 2882 2883
> **说明:**
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[notificationManager.NotificationKey](js-apis-notificationSubscribe.md#notificationkey)替代

X
xuzhihao 已提交
2884 2885 2886 2887
| 名称  | 类型   | 可读 | 可写 | 说明     |
| ----- | ------ | ---- | --- | -------- |
| id    | number | 是  | 是  | 通知ID。   |
| label | string | 是  | 是  | 通知标签。 |
Z
zhaoyuan17 已提交
2888 2889


2890
## SlotType
Z
zhaoyuan17 已提交
2891

2892
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
Z
zhaoyuan17 已提交
2893

2894 2895
| 名称                 | 值       | 说明       |
| -------------------- | -------- | ---------- |
2896 2897 2898 2899 2900
| UNKNOWN_TYPE         | 0 | 未知类型。 |
| SOCIAL_COMMUNICATION | 1 | 社交类型。 |
| SERVICE_INFORMATION  | 2 | 服务类型。 |
| CONTENT_INFORMATION  | 3 | 内容类型。 |
| OTHER_TYPES          | 0xFFFF | 其他类型。 |
2901 2902 2903 2904


## NotificationActionButton

Z
ces doc  
zhuhan 已提交
2905 2906
描述通知中显示的操作按钮。

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

X
xuzhihao 已提交
2909 2910 2911
| 名称      | 类型                                            | 可读 | 可写 | 说明                      |
| --------- | ----------------------------------------------- | --- | ---- | ------------------------- |
| title     | string                                          | 是  | 是  | 按钮标题。                  |
Z
zhongjianfei 已提交
2912
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md)   | 是  | 是  | 点击按钮时触发的WantAgent。 |
X
xuzhihao 已提交
2913 2914
| extras    | { [key: string]: any }                          | 是  | 是  | 按钮扩展信息。              |
| userInput<sup>8+</sup> | [NotificationUserInput](#notificationuserinput8) | 是  | 是  | 用户输入对象实例。          |
2915 2916 2917 2918


## NotificationBasicContent

Z
ces doc  
zhuhan 已提交
2919 2920
描述普通文本通知。

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

X
xuzhihao 已提交
2923 2924 2925 2926
| 名称           | 类型   | 可读 | 可写 | 说明                               |
| -------------- | ------ | ---- | ---- | ---------------------------------- |
| title          | string | 是   | 是   | 通知标题。                         |
| text           | string | 是   | 是   | 通知内容。                         |
Z
zhongjianfei 已提交
2927
| additionalText | string | 是   | 是   | 通知附加内容,是对通知内容的补充。 |
2928 2929 2930 2931


## NotificationLongTextContent

Z
ces doc  
zhuhan 已提交
2932 2933
描述长文本通知。

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

X
xuzhihao 已提交
2936 2937 2938 2939
| 名称           | 类型   | 可读 | 可写 | 说明                             |
| -------------- | ------ | ---- | --- | -------------------------------- |
| title          | string | 是  | 是  | 通知标题。                         |
| text           | string | 是  | 是  | 通知内容。                         |
Z
zhongjianfei 已提交
2940
| additionalText | string | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
X
xuzhihao 已提交
2941 2942 2943
| longText       | string | 是  | 是  | 通知的长文本。                     |
| briefText      | string | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | string | 是  | 是  | 通知展开时的标题。                 |
2944 2945 2946 2947


## NotificationMultiLineContent

Z
ces doc  
zhuhan 已提交
2948 2949
描述多行文本通知。

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

X
xuzhihao 已提交
2952 2953 2954 2955
| 名称           | 类型            | 可读 | 可写 | 说明                             |
| -------------- | --------------- | --- | --- | -------------------------------- |
| title          | string          | 是  | 是  | 通知标题。                         |
| text           | string          | 是  | 是  | 通知内容。                         |
Z
zhongjianfei 已提交
2956
| additionalText | string          | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
X
xuzhihao 已提交
2957 2958 2959
| briefText      | string          | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| longTitle      | string          | 是  | 是  | 通知展开时的标题。                 |
| lines          | Array\<string\> | 是  | 是  | 通知的多行文本。                   |
2960 2961 2962 2963


## NotificationPictureContent

Z
ces doc  
zhuhan 已提交
2964 2965
描述附有图片的通知。

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

X
xuzhihao 已提交
2968 2969 2970 2971
| 名称           | 类型           | 可读 | 可写 | 说明                             |
| -------------- | -------------- | ---- | --- | -------------------------------- |
| title          | string         | 是  | 是  | 通知标题。                         |
| text           | string         | 是  | 是  | 通知内容。                         |
Z
zhongjianfei 已提交
2972
| additionalText | string         | 是  | 是  | 通知附加内容,是对通知内容的补充。 |
X
xuzhihao 已提交
2973 2974
| briefText      | string         | 是  | 是  | 通知概要内容,是对通知内容的总结。 |
| expandedTitle  | string         | 是  | 是  | 通知展开时的标题。                 |
Z
zhongjianfei 已提交
2975
| picture        | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知的图片内容。                   |
2976 2977 2978 2979


## NotificationContent

Z
ces doc  
zhuhan 已提交
2980 2981
描述通知类型。

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

X
xuzhihao 已提交
2984 2985 2986 2987 2988 2989 2990
| 名称        | 类型                                                         | 可读 | 可写 | 说明               |
| ----------- | ------------------------------------------------------------ | ---- | --- | ------------------ |
| contentType | [ContentType](#contenttype)                                  | 是  | 是  | 通知内容类型。       |
| normal      | [NotificationBasicContent](#notificationbasiccontent)        | 是  | 是  | 基本类型通知内容。   |
| longText    | [NotificationLongTextContent](#notificationlongtextcontent)  | 是  | 是  | 长文本类型通知内容。 |
| multiLine   | [NotificationMultiLineContent](#notificationmultilinecontent) | 是  | 是  | 多行类型通知内容。   |
| picture     | [NotificationPictureContent](#notificationpicturecontent)    | 是  | 是  | 图片类型通知内容。   |
2991 2992 2993 2994


## NotificationFlagStatus<sup>8+</sup>

Z
ces doc  
zhuhan 已提交
2995 2996
描述通知标志状态。

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

Z
ces doc  
zhuhan 已提交
2999
**系统接口**:此接口为系统接口,三方应用不支持调用。
3000

X
xuzhihao 已提交
3001
| 名称           | 值  | 说明                               |
3002 3003 3004 3005 3006 3007 3008 3009
| -------------- | --- | --------------------------------- |
| TYPE_NONE      | 0   | 默认标志。                         |
| TYPE_OPEN      | 1   | 通知标志打开。                     |
| TYPE_CLOSE     | 2   | 通知标志关闭。                     |


## NotificationFlags<sup>8+</sup>

Z
ces doc  
zhuhan 已提交
3010 3011
描述通知标志的实例。

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

X
xuzhihao 已提交
3014 3015
| 名称             | 类型                    | 可读 | 可写 | 说明                               |
| ---------------- | ---------------------- | ---- | ---- | --------------------------------- |
Z
zhongjianfei 已提交
3016 3017
| soundEnabled     | [NotificationFlagStatus](#notificationflagstatus8) | 是   | 否   | 是否启用声音提示。                  |
| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus8) | 是   | 否   | 是否启用振动提醒功能。               |
3018 3019 3020 3021


## NotificationRequest

Z
ces doc  
zhuhan 已提交
3022 3023
描述通知的请求。

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

X
xuzhihao 已提交
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035
| 名称                  | 类型                                          | 可读 | 可写 | 说明                       |
| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- |
| content               | [NotificationContent](#notificationcontent)   | 是  | 是  | 通知内容。                   |
| id                    | number                                        | 是  | 是  | 通知ID。                     |
| slotType              | [SlotType](#slottype)                         | 是  | 是  | 通道类型。                   |
| isOngoing             | boolean                                       | 是  | 是  | 是否进行时通知。             |
| isUnremovable         | boolean                                       | 是  | 是  | 是否可移除。                 |
| deliveryTime          | number                                        | 是  | 是  | 通知发送时间。               |
| tapDismissed          | boolean                                       | 是  | 是  | 通知是否自动清除。           |
| autoDeletedTime       | number                                        | 是  | 是  | 自动清除的时间。             |
Z
zhongjianfei 已提交
3036
| wantAgent             | [WantAgent](js-apis-app-ability-wantAgent.md) | 是  | 是  | WantAgent封装了应用的行为意图,点击通知时触发该行为。 |
X
xuzhihao 已提交
3037
| extraInfo             | {[key: string]: any}                          | 是  | 是  | 扩展参数。                   |
Z
zhongjianfei 已提交
3038 3039 3040
| color                 | number                                        | 是  | 是  | 通知背景颜色。预留能力,暂未支持。 |
| colorEnabled          | boolean                                       | 是  | 是  | 通知背景颜色是否使能。预留能力,暂未支持。 |
| isAlertOnce           | boolean                                       | 是  | 是  | 设置是否仅有一次此通知提醒。 |
X
xuzhihao 已提交
3041 3042 3043 3044 3045 3046 3047
| isStopwatch           | boolean                                       | 是  | 是  | 是否显示已用时间。           |
| isCountDown           | boolean                                       | 是  | 是  | 是否显示倒计时时间。         |
| isFloatingIcon        | boolean                                       | 是  | 是  | 是否显示状态栏图标。         |
| label                 | string                                        | 是  | 是  | 通知标签。                   |
| badgeIconStyle        | number                                        | 是  | 是  | 通知角标类型。               |
| showDeliveryTime      | boolean                                       | 是  | 是  | 是否显示分发时间。           |
| actionButtons         | Array\<[NotificationActionButton](#notificationactionbutton)\>             | 是  | 是  | 通知按钮,最多两个按钮。     |
Z
zhongjianfei 已提交
3048 3049
| smallIcon             | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知小图标。可选字段,大小不超过30KB。 |
| largeIcon             | [image.PixelMap](js-apis-image.md#pixelmap7) | 是  | 是  | 通知大图标。可选字段,大小不超过30KB。 |
X
xuzhihao 已提交
3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
| creatorBundleName     | string                                        | 是  | 否  | 创建通知的包名。             |
| creatorUid            | number                                        | 是  | 否  | 创建通知的UID。              |
| creatorPid            | number                                        | 是  | 否  | 创建通知的PID。              |
| creatorUserId<sup>8+</sup>| number                                    | 是  | 否  | 创建通知的UserId。           |
| hashCode              | string                                        | 是  | 否  | 通知唯一标识。               |
| classification        | string                                        | 是  | 是  | 通知分类。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| groupName<sup>8+</sup>| string                                        | 是  | 是  | 组通知名称。                 |
| template<sup>8+</sup> | [NotificationTemplate](#notificationtemplate8) | 是  | 是  | 通知模板。                   |
| isRemoveAllowed<sup>8+</sup> | boolean                                | 是  | 否  | 通知是否能被移除。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| source<sup>8+</sup>   | number                                        | 是  | 否  | 通知源。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                   |
| distributedOption<sup>8+</sup>   | [DistributedOptions](#distributedoptions8)                 | 是  | 是  | 分布式通知的选项。          |
| deviceId<sup>8+</sup> | string                                        | 是  | 否  | 通知源的deviceId。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。          |
| notificationFlags<sup>8+</sup> | [NotificationFlags](#notificationflags8)                    | 是  | 否  | 获取NotificationFlags。          |
Z
zhongjianfei 已提交
3063
| removalWantAgent<sup>9+</sup> | [WantAgent](js-apis-app-ability-wantAgent.md) | 是  | 是  | 当移除通知时,通知将被重定向到的WantAgent实例。          |
X
xuzhihao 已提交
3064
| badgeNumber<sup>9+</sup> | number                    | 是  | 是  | 应用程序图标上显示的通知数。          |
3065 3066 3067

## DistributedOptions<sup>8+</sup>

Z
ces doc  
zhuhan 已提交
3068 3069
描述分布式选项。

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

X
xuzhihao 已提交
3072 3073 3074
| 名称                   | 类型            | 可读 | 可写 | 说明                               |
| ---------------------- | -------------- | ---- | ---- | ---------------------------------- |
| isDistributed          | boolean        | 是   | 是   | 是否为分布式通知。                  |
Z
zhongjianfei 已提交
3075 3076
| supportDisplayDevices  | Array\<string> | 是   | 是   | 可以同步通知到的设备列表。         |
| supportOperateDevices  | Array\<string> | 是   | 是   | 可以打开通知的设备列表。              |
X
xuzhihao 已提交
3077
| remindType             | number         | 是   | 否   | 通知的提醒方式。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。                    |
3078 3079 3080 3081


## NotificationSlot

Z
ces doc  
zhuhan 已提交
3082 3083
描述通知槽

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

X
xuzhihao 已提交
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099
| 名称                 | 类型                  | 可读 | 可写 | 说明                                       |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| type                 | [SlotType](#slottype) | 是  | 是  | 通道类型。                                   |
| level                | number                | 是  | 是  | 通知级别,不设置则根据通知渠道类型有默认值。 |
| desc                 | string                | 是  | 是  | 通知渠道描述信息。                           |
| badgeFlag            | boolean               | 是  | 是  | 是否显示角标。                               |
| bypassDnd            | boolean               | 是  | 是  | 置是否在系统中绕过免打扰模式。               |
| lockscreenVisibility | number                | 是  | 是  | 在锁定屏幕上显示通知的模式。                 |
| vibrationEnabled     | boolean               | 是  | 是  | 是否可振动。                                 |
| sound                | string                | 是  | 是  | 通知提示音。                                 |
| lightEnabled         | boolean               | 是  | 是  | 是否闪灯。                                   |
| lightColor           | number                | 是  | 是  | 通知灯颜色。                                 |
| vibrationValues      | Array\<number\>       | 是  | 是  | 通知振动样式。                               |
| enabled<sup>9+</sup> | boolean               | 是  | 否  | 此通知插槽中的启停状态。                      |
3100 3101 3102 3103


## NotificationSorting

Z
ces doc  
zhuhan 已提交
3104 3105
提供有关活动通知的排序信息。

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

X
xuzhihao 已提交
3108
**系统API**: 此接口为系统接口,三方应用不支持调用。
3109

X
xuzhihao 已提交
3110 3111 3112 3113 3114
| 名称     | 类型                                  | 可读 | 可写 | 说明         |
| -------- | ------------------------------------- | ---- | --- | ------------ |
| slot     | [NotificationSlot](#notificationslot) | 是  | 否  | 通知通道内容。 |
| hashCode | string                                | 是  | 否  | 通知唯一标识。 |
| ranking  | number                                | 是  | 否  | 通知排序序号。 |
3115 3116 3117 3118


## NotificationSortingMap

Z
ces doc  
zhuhan 已提交
3119 3120
提供关于已订阅的所有通知中活动通知的排序信息

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

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

X
xuzhihao 已提交
3125 3126 3127 3128
| 名称           | 类型                                                         | 可读 | 可写 | 说明             |
| -------------- | ------------------------------------------------------------ | ---- | --- | ---------------- |
| sortings       | {[key: string]: [NotificationSorting](#notificationsorting)} | 是  | 否  | 通知排序信息数组。 |
| sortedHashCode | Array\<string\>                                              | 是  | 否  | 通知唯一标识数组。 |
3129 3130 3131 3132


## NotificationSubscribeInfo

Z
ces doc  
zhuhan 已提交
3133 3134
设置订阅所需通知的发布者的信息。

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

X
xuzhihao 已提交
3137
**系统API**: 此接口为系统接口,三方应用不支持调用。
3138

X
xuzhihao 已提交
3139 3140 3141 3142
| 名称        | 类型            | 可读 | 可写 | 说明                            |
| ----------- | --------------- | --- | ---- | ------------------------------- |
| bundleNames | Array\<string\> | 是  | 是  | 指定订阅哪些包名的APP发来的通知。 |
| userId      | number          | 是  | 是  | 指定订阅哪个用户下发来的通知。    |
3143 3144 3145 3146


## NotificationTemplate<sup>8+</sup>

Z
ces doc  
zhuhan 已提交
3147 3148
通知模板。

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

X
xuzhihao 已提交
3151
| 名称 | 类型                    | 可读 | 可写 | 说明       |
3152 3153 3154 3155 3156 3157 3158
| ---- | ---------------------- | ---- | ---- | ---------- |
| name | string                 | 是   | 是   | 模板名称。 |
| data | {[key:string]: Object} | 是   | 是   | 模板数据。 |


## NotificationUserInput<sup>8+</sup>

Z
ces doc  
zhuhan 已提交
3159 3160
保存用户输入的通知消息。

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

X
xuzhihao 已提交
3163 3164 3165
| 名称     | 类型   | 可读 | 可写 | 说明                          |
| -------- | ------ | --- | ---- | ----------------------------- |
| inputKey | string | 是  | 是  | 用户输入时用于标识此输入的key。 |
3166 3167


3168
## DeviceRemindType<sup>8+</sup> <sup>deprecated</sup>
3169 3170 3171

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

X
xuzhihao 已提交
3172
**系统API**: 此接口为系统接口,三方应用不支持调用。
3173

3174 3175 3176
> **说明:**
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[notificationManager.DeviceRemindType](js-apis-notificationManager.md#deviceremindtype)替代

X
xuzhihao 已提交
3177
| 名称                 | 值  | 说明                               |
3178 3179 3180 3181
| -------------------- | --- | --------------------------------- |
| IDLE_DONOT_REMIND    | 0   | 设备未被使用,无需提醒。            |
| IDLE_REMIND          | 1   | 提醒设备未被使用。                 |
| ACTIVE_DONOT_REMIND  | 2   | 设备正在使用,无需提醒。            |
3182
| ACTIVE_REMIND        | 3   | 提醒设备正在使用。                 |
X
xuzhihao 已提交
3183 3184


3185
## SourceType<sup>8+</sup> <sup>deprecated</sup>
X
xuzhihao 已提交
3186 3187 3188

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

X
xuzhihao 已提交
3189 3190
**系统API**: 此接口为系统接口,三方应用不支持调用。

3191 3192 3193
> **说明:**
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[notificationManager.SourceType](js-apis-notificationManager.md#sourcetype)替代

X
xuzhihao 已提交
3194
| 名称                 | 值  | 说明                  |
X
xuzhihao 已提交
3195 3196 3197
| -------------------- | --- | -------------------- |
| TYPE_NORMAL          | 0   | 一般通知。            |
| TYPE_CONTINUOUS      | 1   | 连续通知。            |
Z
zero-cyc 已提交
3198 3199
| TYPE_TIMER           | 2   | 计划通知。            |

3200
## RemoveReason<sup>9+</sup> <sup>deprecated</sup>
Z
zero-cyc 已提交
3201 3202 3203 3204 3205

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

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

3206 3207 3208
> **说明:**
> 从 API version 9开始支持,从API version 9开始废弃。建议使用[notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason)替代

X
xuzhihao 已提交
3209
| 名称                 | 值  | 说明                  |
Z
zero-cyc 已提交
3210
| -------------------- | --- | -------------------- |
3211 3212
| CLICK_REASON_REMOVE<sup>9+</sup>  | 1   | 点击通知后删除通知。    |
| CANCEL_REASON_REMOVE<sup>9+</sup> | 2   | 用户删除通知。         |