@ohos.notificationManager (NotificationManager模块)
@ohos.notificationManager (NotificationManager模块)
本模块提供通知管理的能力，包括发布、取消发布通知，创建、获取、移除通知通道，获取通知的使能状态、角标使能状态，获取通知的相关信息等。
说明：
本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import notificationManager from '@ohos.notificationManager';
1
notificationManager.publish
publish(request: NotificationRequest, callback: AsyncCallback<void>): void
发布通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
| callback | AsyncCallback<void> | 是 | 发布通知的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600009 | Over max number notifications per second. |
示例：
//publish回调
function publishCallback(err) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("publish success");
}
}
//通知Request对象
let notificationRequest: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
notificationManager.publish(notificationRequest, publishCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
notificationManager.publish
publish(request: NotificationRequest): Promise<void>
发布通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600009 | Over max number notifications per second. |
示例：
// 通知Request对象
let notificationRequest: notificationManager.NotificationRequest = {
notificationId: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
notificationManager.publish(notificationRequest).then(() => {
console.info("publish success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
notificationManager.publish
publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void
发布通知给指定的用户（callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
| userId | number | 是 | 用户ID。 |
| callback | AsyncCallback<void> | 是 | 被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600008 | The user is not exist. |
| 1600009 | Over max number notifications per second. |
示例：
// publish回调
function publishCallback(err) {
if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("publish success");
}
}
// 用户ID
let userId = 1;
// 通知Request对象
let notificationRequest: notificationManager.NotificationRequest = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
notificationManager.publish(notificationRequest, userId, publishCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
notificationManager.publish
publish(request: NotificationRequest, userId: number): Promise<void>
发布通知给指定的用户（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
| userId | number | 是 | 用户ID。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600008 | The user is not exist. |
| 1600009 | Over max number notifications per second. |
示例：
let notificationRequest: notificationManager.NotificationRequest = {
notificationId: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
let userId = 1;
notificationManager.publish(notificationRequest, userId).then(() => {
console.info("publish success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
notificationManager.cancel
cancel(id: number, label: string, callback: AsyncCallback<void>): void
通过通知ID和通知标签取消已发布的通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | number | 是 | 通知ID。 |
| label | string | 是 | 通知标签。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600007 | The notification is not exist. |
示例：
// cancel回调
function cancelCallback(err) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("cancel success");
}
}
notificationManager.cancel(0, "label", cancelCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.cancel
cancel(id: number, label?: string): Promise<void>
取消与指定通知ID相匹配的已发布通知，label可以指定也可以不指定（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | number | 是 | 通知ID。 |
| label | string | 否 | 通知标签。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600007 | The notification is not exist. |
示例：
notificationManager.cancel(0).then(() => {
console.info("cancel success");
});
1
2
3
2
3
notificationManager.cancel
cancel(id: number, callback: AsyncCallback<void>): void
取消与指定通知ID相匹配的已发布通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | number | 是 | 通知ID。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600007 | The notification is not exist. |
示例：
// cancel回调
function cancelCallback(err) {
if (err) {
console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("cancel success");
}
}
notificationManager.cancel(0, cancelCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.cancelAll
cancelAll(callback: AsyncCallback<void>): void
取消所有已发布的通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
示例：
// cancel回调
function cancelAllCallback(err) {
if (err) {
console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("cancelAll success");
}
}
notificationManager.cancelAll(cancelAllCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.cancelAll
cancelAll(): Promise<void>
取消所有已发布的通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.cancelAll().then(() => {
console.info("cancelAll success");
});
1
2
3
2
3
notificationManager.addSlot
addSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
创建通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slot | NotificationSlot | 是 | 要创建的通知通道对象。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// addslot回调
function addSlotCallBack(err) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("addSlot success");
}
}
// 通知slot对象
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot, addSlotCallBack);
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
notificationManager.addSlot
addSlot(slot: NotificationSlot): Promise<void>
创建通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slot | NotificationSlot | 是 | 要创建的通知通道对象。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// 通知slot对象
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot).then(() => {
console.info("addSlot success");
});
1
2
3
4
5
6
7
2
3
4
5
6
7
notificationManager.addSlot
addSlot(type: SlotType, callback: AsyncCallback<void>): void
创建指定类型的通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | SlotType | 是 | 要创建的通知通道的类型。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// addslot回调
function addSlotCallBack(err) {
if (err) {
console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("addSlot success");
}
}
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.addSlot
addSlot(type: SlotType): Promise<void>
创建指定类型的通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | SlotType | 是 | 要创建的通知通道的类型。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
console.info("addSlot success");
});
1
2
3
2
3
notificationManager.addSlots
addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>): void
创建多个通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slots | Array<NotificationSlot> | 是 | 要创建的通知通道对象数组。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// addSlots回调
function addSlotsCallBack(err) {
if (err) {
console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("addSlots success");
}
}
// 通知slot对象
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// 通知slot array 对象
let notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
notificationManager.addSlots
addSlots(slots: Array<NotificationSlot>): Promise<void>
创建多个通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slots | Array<NotificationSlot> | 是 | 要创建的通知通道对象数组。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// 通知slot对象
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// 通知slot array 对象
let notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
notificationManager.addSlots(notificationSlotArray).then(() => {
console.info("addSlots success");
});
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getSlot
getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void
获取一个指定类型的通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slotType | SlotType | 是 | 通知渠道类型，目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | AsyncCallback<NotificationSlot> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// getSlot回调
function getSlotCallback(err,data) {
if (err) {
console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlot success");
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
notificationManager.getSlot
getSlot(slotType: SlotType): Promise<NotificationSlot>
获取一个指定类型的通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slotType | SlotType | 是 | 通知渠道类型，目前分为社交通信、服务提醒、内容咨询和其他类型。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<NotificationSlot> | 以Promise形式返回获取一个通知通道。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data) => {
console.info("getSlot success, data: " + JSON.stringify(data));
});
1
2
3
4
2
3
4
notificationManager.getSlots
getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void
获取此应用程序的所有通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
错误码详细介绍请参考errcode-notification。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<NotificationSlot>> | 是 | 以callback形式返回获取此应用程序的所有通知通道的结果。 |
错误码：
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// getSlots回调
function getSlotsCallback(err,data) {
if (err) {
console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlots success");
}
}
notificationManager.getSlots(getSlotsCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getSlots
getSlots(): Promise<Array<NotificationSlot>>
获取此应用程序的所有通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<NotificationSlot>> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getSlots().then((data) => {
console.info("getSlots success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.removeSlot
removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void
删除指定类型的通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slotType | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
// removeSlot回调
function removeSlotCallback(err) {
if (err) {
console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeSlot success");
}
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType,removeSlotCallback);
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
notificationManager.removeSlot
removeSlot(slotType: SlotType): Promise<void>
删除指定类型的通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| slotType | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
console.info("removeSlot success");
});
1
2
3
4
2
3
4
notificationManager.removeAllSlots
removeAllSlots(callback: AsyncCallback<void>): void
删除所有通知通道（callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function removeAllCallBack(err) {
if (err) {
console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeAllSlots success");
}
}
notificationManager.removeAllSlots(removeAllCallBack);
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
notificationManager.removeAllSlots
removeAllSlots(): Promise<void>
删除所有通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.removeAllSlots().then(() => {
console.info("removeAllSlots success");
});
1
2
3
2
3
notificationManager.setNotificationEnable
setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
设定指定应用的通知使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| enable | boolean | 是 | 使能状态。 |
| callback | AsyncCallback<void> | 是 | 设定通知使能回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function setNotificationEnablenCallback(err) {
if (err) {
console.error(`setNotificationEnablenCallback failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setNotificationEnablenCallback success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false, setNotificationEnablenCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.setNotificationEnable
setNotificationEnable(bundle: BundleOption, enable: boolean): Promise<void>
设定指定应用的通知使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| enable | boolean | 是 | 使能状态。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false).then(() => {
console.info("setNotificationEnable success");
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void
获取指定应用的通知使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| callback | AsyncCallback<void> | 是 | 获取通知使能状态回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function isNotificationEnabledCallback(err, data) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption): Promise<boolean>
获取指定应用的通知使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回获取指定应用的通知使能状态的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle).then((data) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.isNotificationEnabled
isNotificationEnabled(callback: AsyncCallback<boolean>): void
获取通知使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 获取通知使能状态回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function isNotificationEnabledCallback(err, data) {
if (err) {
console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationEnabled success");
}
}
notificationManager.isNotificationEnabled(isNotificationEnabledCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.isNotificationEnabled
isNotificationEnabled(): Promise<boolean>
获取通知使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回获取通知使能状态的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
notificationManager.isNotificationEnabled().then((data) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.displayBadge
displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
设定指定应用的角标使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| enable | boolean | 是 | 使能状态。 |
| callback | AsyncCallback<void> | 是 | 设定角标使能回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function displayBadgeCallback(err) {
if (err) {
console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("displayBadge success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false, displayBadgeCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.displayBadge
displayBadge(bundle: BundleOption, enable: boolean): Promise<void>
设定指定应用的角标使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| enable | boolean | 是 | 使能状态。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false).then(() => {
console.info("displayBadge success");
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>): void
获取指定应用的角标使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| callback | AsyncCallback<void> | 是 | 获取角标使能状态回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function isBadgeDisplayedCallback(err, data) {
if (err) {
console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isBadgeDisplayed success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption): Promise<boolean>
获取指定应用的角标使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回获取指定应用的角标使能状态。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle).then((data) => {
console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.setBadgeNumber10+
setBadgeNumber(badgeNumber: number): Promise<void>
设定角标个数，在应用的桌面图标上呈现（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| badgeNumber | number | 是 | 角标个数。 |
错误码：
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600012 | No memory space. |
示例：
let badgeNumber = 10
notificationManager.setBadgeNumber(badgeNumber).then(() => {
console.info("displayBadge success");
});
1
2
3
4
2
3
4
notificationManager.setBadgeNumber10+
setBadgeNumber(badgeNumber: number, callback: AsyncCallback<void>): void
设定角标个数，在应用的桌面图标上呈现（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| badgeNumber | number | 是 | 角标个数。 |
| callback | AsyncCallback<void> | 是 | 设定角标回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600012 | No memory space. |
示例：
function setBadgeNumberCallback(err) {
if (err) {
console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
} else {
console.info("displayBadge success");
}
}
let badgeNumber = 10
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
notificationManager.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>): void
设定指定应用的通知通道（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| slot | NotificationSlot | 是 | 通知通道。 |
| callback | AsyncCallback<void> | 是 | 设定通知通道回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function setSlotByBundleCallback(err) {
if (err) {
console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setSlotByBundle success");
}
}
let bundle = {
bundle: "bundleName1",
};
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
notificationManager.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise<void>
设定指定应用的通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| slot | NotificationSlot | 是 | 通知通道。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
let notificationSlot = {
type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
console.info("setSlotByBundle success");
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>): void
获取指定应用的所有通知通道（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| callback | AsyncCallback<Array<NotificationSlot>> | 是 | 获取通知通道回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function getSlotsByBundleCallback(err, data) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotsByBundle success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption): Promise<Array<NotificationSlot>>
获取指定应用的所有通知通道（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<NotificationSlot>> | 以Promise形式返回获取指定应用的通知通道。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle).then((data) => {
console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>): void
获取指定应用的通知通道数量（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
| callback | AsyncCallback<number> | 是 | 获取通知通道数量回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function getSlotNumByBundleCallback(err, data) {
if (err) {
console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getSlotNumByBundle success");
}
}
let bundle = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption): Promise<number>
获取指定应用的通知通道数量（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 指定应用的包信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<number> | 以Promise形式返回获取指定应用的通知通道数量。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.getSlotNumByBundle(bundle).then((data) => {
console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
});
1
2
3
4
5
6
2
3
4
5
6
notificationManager.getAllActiveNotifications
getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void
获取当前未删除的所有通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<NotificationRequest>> | 是 | 获取活动通知回调函数。 |
错误码：
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function getAllActiveNotificationsCallback(err, data) {
if (err) {
console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getAllActiveNotifications success");
}
}
notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getAllActiveNotifications
getAllActiveNotifications(): Promise<Array<NotificationRequest>>
获取当前未删除的所有通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<NotificationRequest>> | 以Promise形式返回获取活动通知。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getAllActiveNotifications().then((data) => {
console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.getActiveNotificationCount
getActiveNotificationCount(callback: AsyncCallback<number>): void
获取当前应用未删除的通知数（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<number> | 是 | 获取未删除通知数回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function getActiveNotificationCountCallback(err, data) {
if (err) {
console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getActiveNotificationCount success");
}
}
notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getActiveNotificationCount
getActiveNotificationCount(): Promise<number>
获取当前应用未删除的通知数（Promise形式）。
系统能力：SystemCapability.Notification.Notification
返回值：
| 类型 | 说明 |
|---|---|
| Promise<number> | 以Promise形式返回获取当前应用未删除通知数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getActiveNotificationCount().then((data) => {
console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.getActiveNotifications
getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void
获取当前应用未删除的通知列表（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<NotificationRequest>> | 是 | 获取当前应用通知列表回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function getActiveNotificationsCallback(err, data) {
if (err) {
console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getActiveNotifications success");
}
}
notificationManager.getActiveNotifications(getActiveNotificationsCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getActiveNotifications
getActiveNotifications(): Promise<Array<NotificationRequest>>
获取当前应用未删除的通知列表（Promise形式）。
系统能力：SystemCapability.Notification.Notification
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<NotificationRequest>> | 以Promise形式返回获取当前应用通知列表。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getActiveNotifications().then((data) => {
console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.cancelGroup
cancelGroup(groupName: string, callback: AsyncCallback<void>): void
取消本应用指定组下的通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| groupName | string | 是 | 通知组名称，此名称需要在发布通知时通过NotificationRequest对象指定。 |
| callback | AsyncCallback<void> | 是 | 取消本应用指定组下通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function cancelGroupCallback(err) {
if (err) {
console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("cancelGroup success");
}
}
let groupName = "GroupName";
notificationManager.cancelGroup(groupName, cancelGroupCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.cancelGroup
cancelGroup(groupName: string): Promise<void>
取消本应用指定组下的通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| groupName | string | 是 | 通知组名称。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
let groupName = "GroupName";
notificationManager.cancelGroup(groupName).then(() => {
console.info("cancelGroup success");
});
1
2
3
4
2
3
4
notificationManager.removeGroupByBundle
removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback<void>): void
删除指定应用的指定组下的通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| groupName | string | 是 | 通知组名称。 |
| callback | AsyncCallback<void> | 是 | 删除指定应用指定组下通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
function removeGroupByBundleCallback(err) {
if (err) {
console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("removeGroupByBundle success");
}
}
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
notificationManager.removeGroupByBundle
removeGroupByBundle(bundle: BundleOption, groupName: string): Promise<void>
删除指定应用的指定组下的通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| groupName | string | 是 | 通知组名称。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundleOption = {bundle: "Bundle"};
let groupName = "GroupName";
notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("removeGroupByBundle success");
});
1
2
3
4
5
2
3
4
5
notificationManager.setDoNotDisturbDate
setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback<void>): void
设置免打扰时间（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| date | DoNotDisturbDate | 是 | 免打扰时间选项。 |
| callback | AsyncCallback<void> | 是 | 设置免打扰时间回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function setDoNotDisturbDateCallback(err) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setDoNotDisturbDate success");
}
}
let doNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
notificationManager.setDoNotDisturbDate
setDoNotDisturbDate(date: DoNotDisturbDate): Promise<void>
设置免打扰时间（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| date | DoNotDisturbDate | 是 | 免打扰时间选项。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
let doNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("setDoNotDisturbDate success");
});
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
notificationManager.setDoNotDisturbDate
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback<void>): void
指定用户设置免打扰时间（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| date | DoNotDisturbDate | 是 | 免打扰时间选项。 |
| userId | number | 是 | 设置免打扰时间的用户ID。 |
| callback | AsyncCallback<void> | 是 | 设置免打扰时间回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
function setDoNotDisturbDateCallback(err) {
if (err) {
console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setDoNotDisturbDate success");
}
}
let doNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
notificationManager.setDoNotDisturbDate
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise<void>
指定用户设置免打扰时间（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| date | DoNotDisturbDate | 是 | 免打扰时间选项。 |
| userId | number | 是 | 设置免打扰时间的用户ID。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let doNotDisturbDate = {
type: notificationManager.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId = 1;
notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
console.info("setDoNotDisturbDate success");
});
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getDoNotDisturbDate
getDoNotDisturbDate(callback: AsyncCallback<DoNotDisturbDate>): void
查询免打扰时间（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<DoNotDisturbDate> | 是 | 查询免打扰时间回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function getDoNotDisturbDateCallback(err,data) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
}
}
notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getDoNotDisturbDate
getDoNotDisturbDate(): Promise<DoNotDisturbDate>
查询免打扰时间（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<DoNotDisturbDate> | 以Promise形式返回获取查询到的免打扰时间。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getDoNotDisturbDate().then((data) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.getDoNotDisturbDate
getDoNotDisturbDate(userId: number, callback: AsyncCallback<DoNotDisturbDate>): void
查询指定用户的免打扰时间（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<DoNotDisturbDate> | 是 | 查询免打扰时间回调函数。 |
| userId | number | 是 | 用户ID。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
function getDoNotDisturbDateCallback(err,data) {
if (err) {
console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDoNotDisturbDate success");
}
}
let userId = 1;
notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getDoNotDisturbDate
getDoNotDisturbDate(userId: number): Promise<DoNotDisturbDate>
查询指定用户的免打扰时间（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userId | number | 是 | 用户ID。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<DoNotDisturbDate> | 以Promise形式返回获取查询到的免打扰时间。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let userId = 1;
notificationManager.getDoNotDisturbDate(userId).then((data) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
});
1
2
3
4
5
2
3
4
5
notificationManager.isSupportDoNotDisturbMode
isSupportDoNotDisturbMode(callback: AsyncCallback<boolean>): void
查询是否支持免打扰功能（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<boolean> | 是 | 查询是否支持免打扰功能回调函数。 |
错误码：
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function isSupportDoNotDisturbModeCallback(err,data) {
if (err) {
console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isSupportDoNotDisturbMode success");
}
}
notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.isSupportDoNotDisturbMode
isSupportDoNotDisturbMode(): Promise<boolean>
查询是否支持勿扰模式功能（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回获取是否支持免打扰功能的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.isSupportDoNotDisturbMode().then((data) => {
console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.isSupportTemplate
isSupportTemplate(templateName: string, callback: AsyncCallback<boolean>): void
查询模板是否存在（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| templateName | string | 是 | 模板名称。 |
| callback | AsyncCallback<boolean> | 是 | 查询模板是否存在的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600011 | Read template config failed. |
示例：
let templateName = 'process';
function isSupportTemplateCallback(err, data) {
if (err) {
console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isSupportTemplate success");
}
}
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
notificationManager.isSupportTemplate
isSupportTemplate(templateName: string): Promise<boolean>
查询模板是否存在（Promise形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| templateName | string | 是 | 模板名称。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | Promise方式返回模板是否存在的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600011 | Read template config failed. |
示例：
let templateName = 'process';
notificationManager.isSupportTemplate(templateName).then((data) => {
console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});
1
2
3
4
5
2
3
4
5
notificationManager.requestEnableNotification
requestEnableNotification(callback: AsyncCallback<void>): void
应用请求通知使能（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 应用请求通知使能的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function requestEnableNotificationCallback(err) {
if (err) {
console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("requestEnableNotification success");
}
};
notificationManager.requestEnableNotification(requestEnableNotificationCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.requestEnableNotification
requestEnableNotification(): Promise<void>
应用请求通知使能（Promise形式）。
系统能力：SystemCapability.Notification.Notification
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.requestEnableNotification().then(() => {
console.info("requestEnableNotification success");
});
1
2
3
2
3
notificationManager.setDistributedEnable
setDistributedEnable(enable: boolean, callback: AsyncCallback<void>): void
设置设备是否支持分布式通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否支持。 |
| callback | AsyncCallback<void> | 是 | 设置设备是否支持分布式通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
示例：
function setDistributedEnableCallback() {
if (err) {
console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setDistributedEnable success");
}
};
let enable = true;
notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.setDistributedEnable
setDistributedEnable(enable: boolean): Promise<void>
设置设备是否支持分布式通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否支持。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
示例：
let enable = true;
notificationManager.setDistributedEnable(enable).then(() => {
console.info("setDistributedEnable success");
});
1
2
3
4
5
2
3
4
5
notificationManager.isDistributedEnabled
isDistributedEnabled(callback: AsyncCallback<boolean>): void
查询设备是否支持分布式通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<boolean> | 是 | 设备是否支持分布式通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
示例：
function isDistributedEnabledCallback(err, data) {
if (err) {
console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isDistributedEnabled success " + JSON.stringify(data));
}
};
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.isDistributedEnabled
isDistributedEnabled(): Promise<boolean>
查询设备是否支持分布式通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | Promise方式返回设备是否支持分布式通知的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
示例：
notificationManager.isDistributedEnabled()
.then((data) => {
console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
});
1
2
3
4
2
3
4
notificationManager.setDistributedEnableByBundle
setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
设置指定应用是否支持分布式通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| enable | boolean | 是 | 是否支持。 |
| callback | AsyncCallback<void> | 是 | 应用程序是否支持分布式通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
| 17700001 | The specified bundle name was not found. |
示例：
function setDistributedEnableByBundleCallback(err) {
if (err) {
console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("enableDistributedByBundle success");
}
};
let bundle = {
bundle: "bundleName1",
};
let enable = true
notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
notificationManager.setDistributedEnableByBundle
setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise<void>
设置指定应用是否支持分布式通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包。 |
| enable | boolean | 是 | 是否支持。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
let enable = true
notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
console.info("setDistributedEnableByBundle success");
});
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.isDistributedEnabledByBundle
isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback<boolean>): void
根据应用的包获取应用程序是否支持分布式通知（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包。 |
| callback | AsyncCallback<boolean> | 是 | 查询指定应用是否支持分布式通知的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
| 17700001 | The specified bundle name was not found. |
示例：
function isDistributedEnabledByBundleCallback(data) {
if (err) {
console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
}
};
let bundle = {
bundle: "bundleName1",
};
notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
notificationManager.isDistributedEnabledByBundle
isDistributedEnabledByBundle(bundle: BundleOption): Promise<boolean>
查询指定应用是否支持分布式通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | Promise方式返回指定应用是否支持分布式通知的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600010 | Distributed operation failed. |
| 17700001 | The specified bundle name was not found. |
示例：
let bundle = {
bundle: "bundleName1",
};
notificationManager.isDistributedEnabledByBundle(bundle).then((data) => {
console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
});
1
2
3
4
5
6
7
2
3
4
5
6
7
notificationManager.getDeviceRemindType
getDeviceRemindType(callback: AsyncCallback<DeviceRemindType>): void
获取通知的提醒方式（Callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<DeviceRemindType> | 是 | 获取通知提醒方式的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
function getDeviceRemindTypeCallback(err, data) {
if (err) {
console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("getDeviceRemindType success");
}
};
notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
notificationManager.getDeviceRemindType
getDeviceRemindType(): Promise<DeviceRemindType>
获取通知的提醒方式（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<DeviceRemindType> | Promise方式返回获取通知提醒方式的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
示例：
notificationManager.getDeviceRemindType().then((data) => {
console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
});
1
2
3
2
3
notificationManager.publishAsBundle
publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void
发布代理通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER，ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
| representativeBundle | string | 是 | 被代理应用的包名。 |
| userId | number | 是 | 用户ID。 |
| callback | AsyncCallback | 是 | 发布代理通知的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600008 | The user is not exist. |
| 1600009 | Over max number notifications per second. |
示例：
//publishAsBundle回调
function callback(err) {
if (err) {
console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("publishAsBundle success");
}
}
// 被代理应用的包名
let representativeBundle = "com.example.demo";
// 用户ID
let userId = 100;
// NotificationRequest对象
let request = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
notificationManager.publishAsBundle(request, representativeBundle, userId, callback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
notificationManager.publishAsBundle
publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise<void>
发布代理通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
需要权限: ohos.permission.NOTIFICATION_CONTROLLER，ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| request | NotificationRequest | 是 | 用于设置要发布通知的内容和相关配置信息。 |
| representativeBundle | string | 是 | 被代理应用的包名。 |
| userId | number | 是 | 用户ID。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600004 | Notification is not enabled. |
| 1600005 | Notification slot is not enabled. |
| 1600008 | The user is not exist. |
| 1600009 | Over max number notifications per second. |
示例：
// 被代理应用的包名
let representativeBundle = "com.example.demo";
// 用户ID
let userId = 100;
// NotificationRequest对象
let request = {
id: 1,
content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
console.info("publishAsBundle success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
notificationManager.cancelAsBundle
cancelAsBundle(id: number, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void
取消代理通知（callback形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限: ohos.permission.NOTIFICATION_CONTROLLER，ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | number | 是 | 通知ID。 |
| representativeBundle | string | 是 | 被代理应用的包名。 |
| userId | number | 是 | 用户ID。 |
| callback | AsyncCallback | 是 | 取消代理通知的回调方法。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600007 | The notification is not exist. |
| 1600008 | The user is not exist. |
示例：
// cancelAsBundle
function cancelAsBundleCallback(err) {
if (err) {
console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("cancelAsBundle success");
}
}
// 被代理应用的包名
let representativeBundle = "com.example.demo";
// 用户ID
let userId = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
notificationManager.cancelAsBundle
cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise<void>
取消代理通知（Promise形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限: ohos.permission.NOTIFICATION_CONTROLLER，ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API: 此接口为系统接口，三方应用不支持调用。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | number | 是 | 通知ID。 |
| representativeBundle | string | 是 | 被代理应用的包名。 |
| userId | number | 是 | 用户ID。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600007 | The notification is not exist. |
| 1600008 | The user is not exist. |
示例：
// 被代理应用的包名
let representativeBundle = "com.example.demo";
// 用户ID
let userId = 100;
notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
console.info("cancelAsBundle success");
});
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
notificationManager.setNotificationEnableSlot
setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback<void>): void
设置指定应用的指定渠道类型的使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| type | SlotType | 是 | 指定渠道类型。 |
| enable | boolean | 是 | 使能状态。 |
| callback | AsyncCallback<void> | 是 | 设置渠道使能回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
// setNotificationEnableSlot
function setNotificationEnableSlotCallback(err) {
if (err) {
console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setNotificationEnableSlot success");
}
};
notificationManager.setNotificationEnableSlot(
{ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION,
true,
setNotificationEnableSlotCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
notificationManager.setNotificationEnableSlot
setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise<void>
设置指定应用的指定渠道类型的使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| type | SlotType | 是 | 渠道类型。 |
| enable | boolean | 是 | 使能状态。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
// setNotificationEnableSlot
notificationManager.setNotificationEnableSlot(
{ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION,
true).then(() => {
console.info("setNotificationEnableSlot success");
});
1
2
3
4
5
6
7
2
3
4
5
6
7
notificationManager.isNotificationSlotEnabled
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback<boolean>): void
获取指定应用的指定渠道类型的使能状态（Callback形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| type | SlotType | 是 | 渠道类型。 |
| callback | AsyncCallback<boolean> | 是 | 获取渠道使能状态回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
// isNotificationSlotEnabled
function getEnableSlotCallback(err, data) {
if (err) {
console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("isNotificationSlotEnabled success");
}
};
notificationManager.isNotificationSlotEnabled(
{ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION,
getEnableSlotCallback);
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
notificationManager.isNotificationSlotEnabled
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise<boolean>
获取指定应用的指定渠道类型的使能状态（Promise形式）。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bundle | BundleOption | 是 | 应用的包信息。 |
| type | SlotType | 是 | 渠道类型。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回指定类型的渠道使能状态。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 17700001 | The specified bundle name was not found. |
示例：
// isNotificationSlotEnabled
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data) => {
console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
});
1
2
3
4
5
2
3
4
5
notificationManager.setSyncNotificationEnabledWithoutApp
setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback<void>): void
设置是否将通知同步到未安装应用程序的设备(callback形式)。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userId | number | 是 | 用户ID。 |
| enable | boolean | 是 | 是否启用。 |
| callback | AsyncCallback<void> | 是 | 设置是否将通知同步到未安装应用程序的设备的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let userId = 100;
let enable = true;
function callback(err) {
if (err) {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("setSyncNotificationEnabledWithoutApp success");
}
}
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
notificationManager.setSyncNotificationEnabledWithoutApp
setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise<void>
设置是否将通知同步到未安装应用程序的设备(Promise形式)。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userId | number | 是 | 用户ID。 |
| enable | boolean | 是 | 是否启用。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 以Promise形式返回设置是否将通知同步到未安装应用程序的设备的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let userId = 100;
let enable = true;
notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err) => {
console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
});
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
notificationManager.getSyncNotificationEnabledWithoutApp
getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback<boolean>): void
获取同步通知到未安装应用程序设备的开关是否开启(callback形式)。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userId | number | 是 | 用户ID。 |
| callback | AsyncCallback<boolean> | 是 | 获取同步通知到未安装应用程序设备的开关是否开启的回调函数。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let userId = 100;
function getSyncNotificationEnabledWithoutAppCallback(err, data) {
if (err) {
console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
} else {
console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
}
}
notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
notificationManager.getSyncNotificationEnabledWithoutApp
getSyncNotificationEnabledWithoutApp(userId: number): Promise<boolean>
获取同步通知到未安装应用程序设备的开关是否开启(Promise形式)。
系统能力：SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
需要权限：ohos.permission.NOTIFICATION_CONTROLLER
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userId | number | 是 | 用户ID。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<boolean> | 以Promise形式返回获取同步通知到未安装应用程序设备的开关是否开启的结果。 |
错误码：
错误码详细介绍请参考errcode-notification。
| 错误码ID | 错误信息 |
|---|---|
| 1600001 | Internal error. |
| 1600002 | Marshalling or unmarshalling error. |
| 1600003 | Failed to connect service. |
| 1600008 | The user is not exist. |
示例：
let userId = 100;
notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data) => {
console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err) => {
console.info('getSyncNotificationEnabledWithoutApp, err:' + err);
});
1
2
3
4
5
6
2
3
4
5
6
DoNotDisturbDate
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| type | DoNotDisturbType | 是 | 是 | 免打扰设置的时间类型。 |
| begin | Date | 是 | 是 | 免打扰设置的起点时间。 |
| end | Date | 是 | 是 | 免打扰设置的终点时间。 |
DoNotDisturbType
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
|---|---|---|
| TYPE_NONE | 0 | 非通知勿扰类型。 |
| TYPE_ONCE | 1 | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
| TYPE_DAILY | 2 | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
| TYPE_CLEARLY | 3 | 以设置时间段(明确年月日时分)执行勿扰。 |
ContentType
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 |
|---|---|---|
| NOTIFICATION_CONTENT_BASIC_TEXT | NOTIFICATION_CONTENT_BASIC_TEXT | 普通类型通知。 |
| NOTIFICATION_CONTENT_LONG_TEXT | NOTIFICATION_CONTENT_LONG_TEXT | 长文本类型通知。 |
| NOTIFICATION_CONTENT_PICTURE | NOTIFICATION_CONTENT_PICTURE | 图片类型通知。 |
| NOTIFICATION_CONTENT_CONVERSATION | NOTIFICATION_CONTENT_CONVERSATION | 社交类型通知。 |
| NOTIFICATION_CONTENT_MULTILINE | NOTIFICATION_CONTENT_MULTILINE | 多行文本类型通知。 |
SlotLevel
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 |
|---|---|---|
| LEVEL_NONE | 0 | 表示关闭通知功能。 |
| LEVEL_MIN | 1 | 表示通知功能已启用，但状态栏中不显示通知图标，且没有横幅或提示音。 |
| LEVEL_LOW | 2 | 表示通知功能已启用，且状态栏中显示通知图标，但没有横幅或提示音。 |
| LEVEL_DEFAULT | 3 | 表示通知功能已启用，状态栏中显示通知图标，没有横幅但有提示音。 |
| LEVEL_HIGH | 4 | 表示通知功能已启用，状态栏中显示通知图标，有横幅和提示音。 |
BundleOption
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| bundle | string | 是 | 是 | 应用的包信息。 |
| uid | number | 是 | 是 | 用户ID。 |
SlotType
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 |
|---|---|---|
| UNKNOWN_TYPE | 0 | 未知类型。 |
| SOCIAL_COMMUNICATION | 1 | 社交类型。 |
| SERVICE_INFORMATION | 2 | 服务类型。 |
| CONTENT_INFORMATION | 3 | 内容类型。 |
| OTHER_TYPES | 0xFFFF | 其他类型。 |
NotificationActionButton
描述通知中显示的操作按钮。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 是 | 按钮标题。 |
| wantAgent | WantAgent | 是 | 是 | 点击按钮时触发的WantAgent。 |
| extras | { [key: string]: any } | 是 | 是 | 按钮扩展信息。 |
| userInput | NotificationUserInput | 是 | 是 | 用户输入对象实例。 |
NotificationBasicContent
描述普通文本通知。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
NotificationLongTextContent
描述长文本通知。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| longText | string | 是 | 是 | 通知的长文本。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
NotificationMultiLineContent
描述多行文本通知。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| longTitle | string | 是 | 是 | 通知展开时的标题。 |
| lines | Array<string> | 是 | 是 | 通知的多行文本。 |
NotificationPictureContent
描述附有图片的通知。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
| picture | image.PixelMap | 是 | 是 | 通知的图片内容。 |
NotificationContent
描述通知类型。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| contentType | ContentType | 是 | 是 | 通知内容类型。 |
| normal | NotificationBasicContent | 是 | 是 | 基本类型通知内容。 |
| longText | NotificationLongTextContent | 是 | 是 | 长文本类型通知内容。 |
| multiLine | NotificationMultiLineContent | 是 | 是 | 多行类型通知内容。 |
| picture | NotificationPictureContent | 是 | 是 | 图片类型通知内容。 |
NotificationFlagStatus
描述通知标志状态。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统接口：此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
|---|---|---|
| TYPE_NONE | 0 | 默认标志。 |
| TYPE_OPEN | 1 | 通知标志打开。 |
| TYPE_CLOSE | 2 | 通知标志关闭。 |
NotificationFlags
描述通知标志的实例。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| soundEnabled | NotificationFlagStatus | 是 | 否 | 是否启用声音提示。 |
| vibrationEnabled | NotificationFlagStatus | 是 | 否 | 是否启用振动提醒功能。 |
NotificationRequest
描述通知的请求。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| content | NotificationContent | 是 | 是 | 通知内容。 |
| id | number | 是 | 是 | 通知ID。 |
| slotType | SlotType | 是 | 是 | 通道类型。 |
| isOngoing | boolean | 是 | 是 | 是否进行时通知。 |
| isUnremovable | boolean | 是 | 是 | 是否可移除。 |
| deliveryTime | number | 是 | 是 | 通知发送时间。 |
| tapDismissed | boolean | 是 | 是 | 通知是否自动清除。 |
| autoDeletedTime | number | 是 | 是 | 自动清除的时间。 |
| wantAgent | WantAgent | 是 | 是 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 |
| extraInfo | {[key: string]: any} | 是 | 是 | 扩展参数。 |
| color | number | 是 | 是 | 通知背景颜色。预留能力，暂未支持。 |
| colorEnabled | boolean | 是 | 是 | 通知背景颜色是否使能。预留能力，暂未支持。 |
| isAlertOnce | boolean | 是 | 是 | 设置是否仅有一次此通知提醒。 |
| isStopwatch | boolean | 是 | 是 | 是否显示已用时间。 |
| isCountDown | boolean | 是 | 是 | 是否显示倒计时时间。 |
| isFloatingIcon | boolean | 是 | 是 | 是否显示状态栏图标。 |
| label | string | 是 | 是 | 通知标签。 |
| badgeIconStyle | number | 是 | 是 | 通知角标类型。 |
| showDeliveryTime | boolean | 是 | 是 | 是否显示分发时间。 |
| actionButtons | Array<NotificationActionButton> | 是 | 是 | 通知按钮，最多三个按钮。 |
| smallIcon | image.PixelMap | 是 | 是 | 通知小图标。可选字段，大小不超过30KB。 |
| largeIcon | image.PixelMap | 是 | 是 | 通知大图标。可选字段，大小不超过30KB。 |
| creatorBundleName | string | 是 | 否 | 创建通知的包名。 |
| creatorUid | number | 是 | 否 | 创建通知的UID。 |
| creatorPid | number | 是 | 否 | 创建通知的PID。 |
| creatorUserId | number | 是 | 否 | 创建通知的UserId。 |
| hashCode | string | 是 | 否 | 通知唯一标识。 |
| classification | string | 是 | 是 | 通知分类。 系统API: 此接口为系统接口，三方应用不支持调用。 |
| groupName | string | 是 | 是 | 组通知名称。 |
| template | NotificationTemplate | 是 | 是 | 通知模板。 |
| isRemoveAllowed | boolean | 是 | 否 | 通知是否能被移除。 系统API: 此接口为系统接口，三方应用不支持调用。 |
| source | number | 是 | 否 | 通知源。 系统API: 此接口为系统接口，三方应用不支持调用。 |
| distributedOption | DistributedOptions | 是 | 是 | 分布式通知的选项。 |
| deviceId | string | 是 | 否 | 通知源的deviceId。 系统API: 此接口为系统接口，三方应用不支持调用。 |
| notificationFlags | NotificationFlags | 是 | 否 | 获取NotificationFlags。 |
| removalWantAgent | WantAgent | 是 | 是 | 当移除通知时，通知将被重定向到的WantAgent实例。 |
| badgeNumber | number | 是 | 是 | 应用程序图标上显示的通知数。 |
DistributedOptions
描述分布式选项。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| isDistributed | boolean | 是 | 是 | 是否为分布式通知。 |
| supportDisplayDevices | Array<string> | 是 | 是 | 可以同步通知到的设备列表。 |
| supportOperateDevices | Array<string> | 是 | 是 | 可以打开通知的设备列表。 |
| remindType | number | 是 | 否 | 通知的提醒方式。 系统API: 此接口为系统接口，三方应用不支持调用。 |
NotificationSlot
描述通知槽
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| type | SlotType | 是 | 是 | 通道类型。 |
| level | number | 是 | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | string | 是 | 是 | 通知渠道描述信息。 |
| badgeFlag | boolean | 是 | 是 | 是否显示角标。 |
| bypassDnd | boolean | 是 | 是 | 置是否在系统中绕过免打扰模式。 |
| lockscreenVisibility | number | 是 | 是 | 在锁定屏幕上显示通知的模式。 |
| vibrationEnabled | boolean | 是 | 是 | 是否可振动。 |
| sound | string | 是 | 是 | 通知提示音。 |
| lightEnabled | boolean | 是 | 是 | 是否闪灯。 |
| lightColor | number | 是 | 是 | 通知灯颜色。 |
| vibrationValues | Array<number> | 是 | 是 | 通知振动样式。 |
| enabled9+ | boolean | 是 | 否 | 此通知插槽中的启停状态。 |
NotificationTemplate
通知模板。
系统能力：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| name | string | 是 | 是 | 模板名称。 |
| data | {[key:string]: Object} | 是 | 是 | 模板数据。 |
NotificationUserInput
保存用户输入的通知消息。
系统能力：SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| inputKey | string | 是 | 是 | 用户输入时用于标识此输入的key。 |
DeviceRemindType
系统能力：SystemCapability.Notification.Notification
系统API: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
|---|---|---|
| IDLE_DONOT_REMIND | 0 | 设备未被使用，无需提醒。 |
| IDLE_REMIND | 1 | 提醒设备未被使用。 |
| ACTIVE_DONOT_REMIND | 2 | 设备正在使用，无需提醒。 |
| ACTIVE_REMIND | 3 | 提醒设备正在使用。 |
SourceType
系统能力：SystemCapability.Notification.Notification
系统API: 此接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
|---|---|---|
| TYPE_NORMAL | 0 | 一般通知。 |
| TYPE_CONTINUOUS | 1 | 连续通知。 |
| TYPE_TIMER | 2 | 计划通知。 |