Notification模块
导入模块
开发前请熟悉鸿蒙开发指导文档:[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
import Notification from '@ohos.notification';
Notification.publish
publish(request: NotificationRequest, callback: AsyncCallback): void
发布通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
request | 是 | 否 | [NotificationRequest] | 是 | 设置要发布通知内容的NotificationRequest对象。 |
callback | 是 | 否 | AsyncCallback | 是 | 被指定的回调方法。 |
示例:
//publish回调
function publishCallback(err) {
console.info("========================== >publishCallback======================= >");
}
//通知Request对象
var notificationRequest = {
id: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
Notification.publish(notificationRequest, publishCallback)
Notification.publish
publish(request: NotificationRequest): Promise
发布通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
示例:
//通知Request对象
var notificationRequest = {
notificationId: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
Notification.publish(notificationRequest).then(() = > {
console.info("========================== >publishCallback======================= >");
});
Notification.publish8+
publish(request: NotificationRequest, userId: number, callback: AsyncCallback): void
发布通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
request | 是 | 否 | [NotificationRequest] | 是 | 设置要发布通知内容的NotificationRequest对象。 |
userId | 是 | 否 | number | 是 | 接收通知用户的Id。 |
callback | 是 | 否 | AsyncCallback | 是 | 被指定的回调方法。 |
示例:
//publish回调
function publishCallback(err) {
console.info("========================== >publishCallback======================= >");
}
// 接收通知的用户ID
var userId = 1
//通知Request对象
var notificationRequest = {
id: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
Notification.publish(notificationRequest, userId, publishCallback);
Notification.publish8+
publish(request: NotificationRequest, userId: number): Promise
发布通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
request | 是 | 否 | [NotificationRequest] | 是 | 设置要发布通知内容的NotificationRequest对象。 |
userId | 是 | 否 | number | 是 | 接收通知用户的Id。 |
示例:
var notificationRequest = {
notificationId: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
var userId = 1
Notification.publish(notificationRequest, userId).then(() = > {
console.info("========================== >publishCallback======================= >");
});
Notification.cancel
cancel(id: number, label: string, callback: AsyncCallback): void
取消与指定id和label相匹配的已发布通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
id | 是 | 否 | number | 是 | 通知ID。 |
label | 是 | 否 | string | 是 | 通知标签。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//cancel回调
function cancelCallback(err) {
console.info("========================== >cancelCallback======================= >");
}
Notification.cancel(0, "label", cancelCallback)
Notification.cancel
cancel(id: number, label?: string): Promise
取消与指定id相匹配的已发布通知,label可以指定也可以不指定(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
id | 是 | 否 | number | 是 | 通知ID。 |
label | 是 | 否 | string | 否 | 通知标签。 |
示例:
Notification.cancel(0).then(() = > {
console.info("========================== >cancelCallback======================= >");
});
Notification.cancel
cancel(id: number, callback: AsyncCallback): void
取消与指定id相匹配的已发布通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
id | 是 | 否 | number | 是 | 通知ID。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//cancel回调
function cancelCallback(err) {
console.info("========================== >cancelCallback======================= >");
}
Notification.cancel(0, cancelCallback)
Notification.cancelAll
cancelAll(callback: AsyncCallback): void
取消所有已发布的通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//cancel回调
function cancelAllCallback(err) {
console.info("========================== >cancelAllCallback======================= >");
}
Notification.cancelAll(cancelAllCallback)
Notification.cancelAll
cancelAll(): Promise
取消所有已发布的通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
示例:
Notification.cancelAll().then(() = > {
console.info("========================== >cancelAllCallback======================= >");
});
Notification.addSlot
addSlot(slot: NotificationSlot, callback: AsyncCallback): void
创建通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slot | 是 | 否 | [NotificationSlot] | 是 | 要创建的通知通道对象。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//addslot回调
function addSlotCallBack(err) {
console.info("========================== >addSlotCallBack======================= >");
}
//通知slot对象
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Notification.addSlot(notificationSlot, addSlotCallBack)
Notification.addSlot
addSlot(slot: NotificationSlot): Promise
创建通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slot | 是 | 否 | [NotificationSlot] | 是 | 要创建的通知通道对象。 |
示例:
//通知slot对象
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Notification.addSlot(notificationSlot).then(() = > {
console.info("========================== >addSlotCallback======================= >");
});
Notification.addSlot
addSlot(type: SlotType, callback: AsyncCallback): void
创建通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
type | 是 | 否 | [SlotType] | 是 | 要创建的通知通道的类型。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//addslot回调
function addSlotCallBack(err) {
console.info("========================== >addSlotCallBack======================= >");
}
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack)
Notification.addSlot
addSlot(type: SlotType): Promise
创建通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
type | 是 | 否 | [SlotType] | 是 | 要创建的通知通道的类型。 |
示例:
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() = > {
console.info("========================== >addSlotCallback======================= >");
});
Notification.addSlots
addSlots(slots: Array, callback: AsyncCallback): void
创建多个通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slots | 是 | 否 | Array<[NotificationSlot]> | 是 | 要创建的通知通道对象数组。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//addSlots回调
function addSlotsCallBack(err) {
console.info("========================== >addSlotsCallBack======================= >");
}
//通知slot对象
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
//通知slot array 对象
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray, addSlotsCallBack)
Notification.addSlots
addSlots(slots: Array): Promise
创建多个通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slots | 是 | 否 | Array<[NotificationSlot]> | 是 | 要创建的通知通道对象数组。 |
示例:
//通知slot对象
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
//通知slot array 对象
var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray).then(() = > {
console.info("========================== >addSlotCallback======================= >");
});
Notification.getSlot
getSlot(slotType: SlotType, callback: AsyncCallback): void
获取一个通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slotType | 是 | 否 | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
callback | 是 | 否 | AsyncCallback<[NotificationSlot]> | 是 | 表示被指定的回调方法。 |
示例:
//getSlot回调
function getSlotCallback(err,data) {
console.info("========================== >getSlotCallback======================= >");
}
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType, getSlotCallback)
Notification.getSlot
getSlot(slotType: SlotType): Promise
获取一个通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slotType | 是 | 否 | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取一个通知通道。 |
示例:
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType).then((data) = > {
console.info("========================== >getSlotCallback======================= >");
});
Notification.getSlots
getSlots(callback: AsyncCallback>): void
获取此应用程序的所有通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback<[NotificationSlot]> | 是 | 表示被指定的回调方法。 |
示例:
//getSlots回调
function getSlotsCallback(err,data) {
console.info("========================== >getSlotsCallback======================= >");
}
Notification.getSlots(getSlotsCallback)
Notification.getSlots
getSlots(): Promise>
获取此应用程序的所有通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
返回值:
类型 | 说明 |
---|---|
Promise> | 以Promise形式返回获取此应用程序的所有通知通道的结果。 |
示例:
Notification.getSlots().then((data) = > {
console.info("========================== >getSlotsCallback======================= >");
});
Notification.removeSlot
removeSlot(slotType: SlotType, callback: AsyncCallback): void
根据通知通道类型删除创建的通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slotType | 是 | 否 | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
//removeSlot回调
function removeSlotCallback(err) {
console.info("========================== >removeSlotCallback======================= >");
}
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType,removeSlotCallback)
Notification.removeSlot
removeSlot(slotType: SlotType): Promise
根据通知通道类型删除创建的通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slotType | 是 | 否 | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
示例:
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then(() = > {
console.info("========================== >removeSlotCallback======================= >");
});
Notification.removeAllSlots
removeAllSlots(callback: AsyncCallback): void
删除所有通知通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 表示被指定的回调方法。 |
示例:
function removeAllCallBack(err) {
console.info("================ >removeAllCallBack======================= >");
}
Notification.removeAllSlots(removeAllCallBack)
Notification.removeAllSlots
removeAllSlots(): Promise
删除所有通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
示例:
Notification.removeAllSlots().then(() = > {
console.info("========================== >removeAllCallBack======================= >");
});
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback): void
订阅通知并指定订阅信息(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
subscriber | 是 | 否 | [NotificationSubscriber] | 是 | 通知订阅对象。 |
info | 是 | 否 | [NotificationSubscribeInfo] | 是 | 订阅信息。 |
callback | 是 | 否 | AsyncCallback | 是 | 订阅动作回调函数。 |
示例:
//subscribe回调
function subscribeCallback(err) {
console.info("========================== >subscribeCallback======================= >");
}
function onConsumeCallback(data) {
console.info("========================== >onConsumeCallback======================= >");
}
var subscriber = {
onConsume: onConsumeCallback
}
var info = {
bundleNames: ["bundleName1","bundleName2"]
}
Notification.subscribe(subscriber, info, subscribeCallback);
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void
订阅通知并指定订阅信息(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
subscriber | 是 | 否 | [NotificationSubscriber] | 是 | 通知订阅对象。 |
callback | 是 | 否 | AsyncCallback | 是 | 订阅动作回调函数。 |
示例:
function subscribeCallback(err) {
console.info("========================== >subscribeCallback======================= >");
}
function onConsumeCallback(data) {
console.info("========================== >onConsumeCallback======================= >");
}
var subscriber = {
onConsume: onConsumeCallback
}
Notification.subscribe(subscriber, subscribeCallback);
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise
订阅通知并指定订阅信息(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
subscriber | 是 | 否 | [NotificationSubscriber] | 是 | 通知订阅对象。 |
info | 是 | 否 | [NotificationSubscribeInfo] | 否 | 订阅信息。 |
示例:
function onConsumeCallback(data) {
console.info("========================== >onConsumeCallback======================= >");
}
var subscriber = {
onConsume: onConsumeCallback
};
Notification.subscribe(subscriber).then(() = > {
console.info("========================== >subscribeCallback======================= >");
});
Notification.unsubscribe
unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void
取消订阅(callbcak形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
subscriber | 是 | 否 | [NotificationSubscriber] | 是 | 通知订阅对象。 |
callback | 是 | 否 | AsyncCallback | 是 | 取消订阅动作回调函数。 |
示例:
function unsubscribeCallback(err) {
console.info("========================== >unsubscribeCallback======================= >");
}
function onConsumeCallback(data) {
console.info("========================== >onConsumeCallback======================= >");
}
var subscriber = {
onConsume: onConsumeCallback
}
Notification.unsubscribe(subscriber, unsubscribeCallback);
Notification.unsubscribe
unsubscribe(subscriber: NotificationSubscriber): Promise
取消订阅(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
subscriber | 是 | 否 | [NotificationSubscriber] | 是 | 通知订阅对象。 |
示例:
function onConsumeCallback(data) {
console.info("========================== >onConsumeCallback======================= >");
}
var subscriber = {
onConsume: onConsumeCallback
};
Notification.unsubscribe(subscriber).then(() = > {
console.info("========================== >unsubscribeCallback======================= >");
});
Notification.enableNotification
enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void
设定指定包的通知使能状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
enable | 是 | 否 | boolean | 是 | 使能状态。 |
callback | 是 | 否 | AsyncCallback | 是 | 设定通知使能回调函数。 |
示例:
function enableNotificationCallback(err) {
console.info("========================== >enableNotificationCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.enableNotification(bundle, false, enableNotificationCallback);
Notification.enableNotification
enableNotification(bundle: BundleOption, enable: boolean): Promise
设定指定包的通知使能状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
enable | 是 | 否 | boolean | 是 | 使能状态。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.enableNotification(bundle, false).then(() = > {
console.info("========================== >enableNotificationCallback======================= >");
});
Notification.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback): void
获取指定包的通知使能状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
callback | 是 | 否 | AsyncCallback | 是 | 获取通知使能状态回调函数。 |
示例:
function isNotificationEnabledCallback(err, data) {
console.info("========================== >isNotificationEnabledCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
Notification.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption): Promise
获取指定包的通知使能状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取指定包的通知使能状态的结果。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.isNotificationEnabled(bundle).then((data) = > {
console.info("========================== >isNotificationEnabledCallback======================= >");
});
Notification.isNotificationEnabled
isNotificationEnabled(callback: AsyncCallback): void
获取通知使能状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 获取通知使能状态回调函数。 |
示例:
function isNotificationEnabledCallback(err, data) {
console.info("========================== >isNotificationEnabledCallback======================= >");
}
Notification.isNotificationEnabled(isNotificationEnabledCallback);
Notification.isNotificationEnabled
isNotificationEnabled(): Promise
获取通知使能状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取通知使能状态的结果。 |
示例:
Notification.isNotificationEnabled().then((data) = > {
console.info("========================== >isNotificationEnabledCallback======================= >");
});
Notification.displayBadge
displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void
设定指定包的角标使能状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
enable | 是 | 否 | boolean | 是 | 使能状态。 |
callback | 是 | 否 | AsyncCallback | 是 | 设定角标使能回调函数。 |
示例:
function displayBadgeCallback(err) {
console.info("========================== >displayBadgeCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.displayBadge(bundle, false, displayBadgeCallback);
Notification.displayBadge
displayBadge(bundle: BundleOption, enable: boolean): Promise
设定指定包的角标使能状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
enable | 是 | 否 | boolean | 是 | 使能状态。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.displayBadge(bundle, false).then(() = > {
console.info("========================== >displayBadgeCallback======================= >");
});
Notification.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback): void
获取指定包的角标使能状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
callback | 是 | 否 | AsyncCallback | 是 | 获取角标使能状态回调函数。 |
示例:
function isBadgeDisplayedCallback(err, data) {
console.info("========================== >isBadgeDisplayedCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
Notification.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption): Promise
获取指定包的角标使能状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取指定包的角标使能状态。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.isBadgeDisplayed(bundle).then((data) = > {
console.info("========================== >isBadgeDisplayedCallback======================= >");
});
Notification.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback): void
设定指定包的通知通道状态(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
slot | 是 | 否 | [NotificationSlot] | 是 | 通知通道。 |
callback | 是 | 否 | AsyncCallback | 是 | 设定通知通道回调函数。 |
示例:
function setSlotByBundleCallback(err) {
console.info("========================== >setSlotByBundleCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
Notification.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise
设定指定包的通知通道状态(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
slot | 是 | 否 | [NotificationSlot] | 是 | 使能状态。 |
示例:
var bundle = {
bundle: "bundleName1",
}
var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
}
Notification.setSlotByBundle(bundle, notificationSlot).then(() = > {
console.info("========================== >setSlotByBundleCallback======================= >");
});
Notification.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback>): void
获取指定包的通知通道(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
callback | 是 | 否 | AsyncCallback> | 是 | 获取通知通道回调函数。 |
示例:
function getSlotsByBundleCallback(err, data) {
console.info("========================== >getSlotsByBundleCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
Notification.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption): Promise>
获取指定包的通知通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
返回值:
类型 | 说明 |
---|---|
Promise> | 以Promise形式返回获取指定包的通知通道。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.getSlotsByBundle(bundle).then((data) = > {
console.info("========================== >getSlotsByBundleCallback======================= >");
});
Notification.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback): void
获取指定包的通知通道数(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
callback | 是 | 否 | AsyncCallback | 是 | 获取通知通道数回调函数。 |
示例:
function getSlotNumByBundleCallback(err, data) {
console.info("========================== >getSlotNumByBundleCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
Notification.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption): Promise
获取指定包的通知通道数(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取指定包的通知通道数。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.getSlotNumByBundle(bundle).then((data) = > {
console.info("========================== >getSlotNumByBundleCallback======================= >");
});
Notification.remove
remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback): void
删除指定通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
notificationKey | 是 | 否 | [NotificationKey] | 是 | 通知键值。 |
callback | 是 | 否 | AsyncCallback | 是 | 删除指定通知回调函数。 |
示例:
function removeCallback(err) {
console.info("========================== >removeCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
var notificationKey = {
id: 0,
label: "label",
}
Notification.remove(bundle, notificationKey, removeCallback);
Notification.remove
remove(bundle: BundleOption, notificationKey: NotificationKey): Promise
删除指定通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
notificationKey | 是 | 否 | [NotificationKey] | 是 | 通知键值。 |
示例:
var bundle = {
bundle: "bundleName1",
}
var notificationKey = {
id: 0,
label: "label",
}
Notification.remove(bundle, notificationKey).then(() = > {
console.info("========================== >removeCallback======================= >");
});
Notification.remove
remove(hashCode: string, callback: AsyncCallback): void
删除指定通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
hashCode | 是 | 否 | string | 是 | 通知唯一ID。 |
callback | 是 | 否 | AsyncCallback | 是 | 删除指定通知回调函数。 |
示例:
var hashCode = 'hashCode'
function removeCallback(err) {
console.info("========================== >removeCallback======================= >");
}
Notification.remove(hashCode, removeCallback);
Notification.remove
remove(hashCode: string): Promise
删除指定通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
hashCode | 是 | 否 | string | 是 | 通知唯一ID。 |
示例:
var hashCode = 'hashCode'
Notification.remove(hashCode).then(() = > {
console.info("========================== >removeCallback======================= >");
});
Notification.removeAll
removeAll(bundle: BundleOption, callback: AsyncCallback): void
删除指定包的所有通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
callback | 是 | 否 | AsyncCallback | 是 | 删除指定包的所有通知回调函数。 |
示例:
function removeAllCallback(err) {
console.info("========================== >removeAllCallback======================= >");
}
var bundle = {
bundle: "bundleName1",
}
Notification.removeAll(bundle, removeAllCallback);
Notification.removeAll
removeAll(callback: AsyncCallback): void
删除所有通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 删除所有通知回调函数。 |
示例:
function removeAllCallback(err) {
console.info("========================== >removeAllCallback======================= >");
}
Notification.removeAll(removeAllCallback);
Notification.removeAll
removeAll(bundle?: BundleOption): Promise
删除所有通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 否 | 指定包信息。 |
示例:
Notification.removeAll().then(() = > {
console.info("========================== >removeAllCallback======================= >");
});
Notification.removeAll8+
removeAll(userId: number, callback: AsyncCallback): void
删除所有通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
userId | 是 | 否 | number | 是 | 接收通知用户的Id。 |
callback | 是 | 否 | AsyncCallback | 是 | 删除所有通知回调函数。 |
示例:
function removeAllCallback(err) {
console.info("========================== >removeAllCallback======================= >");
}
var userId = 1
Notification.removeAll(userId, removeAllCallback);
Notification.removeAll8+
removeAll(userId: number): Promise
删除所有通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
userId | 是 | 否 | number | 是 | 接收通知用户的Id。 |
示例:
function removeAllCallback(err) {
console.info("========================== >removeAllCallback======================= >");
}
var userId = 1
Notification.removeAll(userId, removeAllCallback);
[](https://gitee.com/openharmony/docs/blob/OpenHarmony-3.2-Beta1/zh-cn/application-dev/reference/apis/js-apis-notification.md#notificationgetallactivenotifications)Notification.getAllActiveNotifications
getAllActiveNotifications(callback: AsyncCallback>): void
获取活动通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback> | 是 | 获取活动通知回调函数。 |
示例:
function getAllActiveNotificationsCallback(err, data) {
console.info("========================== >getAllActiveNotificationsCallback======================= >");
}
Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
Notification.getAllActiveNotifications
getAllActiveNotifications(): Promise>
获取活动通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。removeGroupByBundle
返回值:
类型 | 说明 |
---|---|
Promise> | 以Promise形式返回获取活动通知。 |
示例:
Notification.getAllActiveNotifications().then((data) = > {
console.info("========================== >getAllActiveNotificationsCallback======================= >");
});
Notification.getActiveNotificationCount
getActiveNotificationCount(callback: AsyncCallback): void
获取当前应用的活动通知数(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 获取活动通知数回调函数。 |
示例:
function getActiveNotificationCountCallback(err, data) {
console.info("========================== >getActiveNotificationCountCallback======================= >");
}
Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
Notification.getActiveNotificationCount
getActiveNotificationCount(): Promise
获取当前应用的活动通知数(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取当前应用的活动通知数。 |
示例:
Notification.getActiveNotificationCount().then((data) = > {
console.info("========================== >getActiveNotificationCountCallback======================= >");
});
Notification.getActiveNotifications
getActiveNotifications(callback: AsyncCallback>): void
获取当前应用的活动通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback> | 是 | 获取当前应用的活动通知回调函数。 |
示例:
function getActiveNotificationsCallback(err, data) {
console.info("========================== >getActiveNotificationsCallback======================= >");
}
Notification.getActiveNotifications(getActiveNotificationsCallback);
Notification.getActiveNotifications
getActiveNotifications(): Promise>
获取当前应用的活动通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
返回值:
类型 | 说明 |
---|---|
Promise> | 以Promise形式返回获取当前应用的活动通知。 |
示例:
Notification.getActiveNotifications().then((data) = > {
console.info("========================== >getActiveNotificationsCallback======================= >");
});
Notification.cancelGroup8+
cancelGroup(groupName: string, callback: AsyncCallback): void
取消本应用指定组通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
groupName | 是 | 否 | string | 是 | 指定通知组名称。 |
callback | 是 | 否 | AsyncCallback | 是 | 取消本应用指定组通知回调函数。 |
示例:
function cancelGroupCallback(err) {
console.info("========================== >cancelGroupCallback======================= >");
}
var groupName = "GroupName";
Notification.cancelGroup(groupName, cancelGroupCallback);
Notification.cancelGroup8+
cancelGroup(groupName: string): Promise
取消本应用指定组通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
groupName | 是 | 否 | string | 是 | 指定通知组名称。 |
示例:
var groupName = "GroupName";
Notification.cancelGroup(groupName).then(() = > {
console.info("========================== >cancelGroupPromise======================= >");
});
Notification.removeGroupByBundle8+
removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback): void
删除指定应用指定组通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
groupName | 是 | 否 | string | 是 | 指定通知组名称。 |
callback | 是 | 否 | AsyncCallback | 是 | 删除本应用指定组通知回调函数。 |
示例:
function removeGroupByBundleCallback(err) {
console.info("========================== >removeGroupByBundleCallback======================= >");
}
var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
Notification.removeGroupByBundle8+
removeGroupByBundle(bundle: BundleOption, groupName: string): Promise
删除指定应用指定组通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | [BundleOption] | 是 | 指定包信息。 |
groupName | 是 | 否 | string | 是 | 指定通知组名称。 |
示例:
var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() = > {
console.info("========================== >removeGroupByBundlePromise======================= >");
});
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback): void
设置免打扰时间(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
date | 是 | 否 | [DoNotDisturbDate] | 是 | 免打扰时间选项。 |
callback | 是 | 否 | AsyncCallback | 是 | 设置免打扰时间回调函数。 |
示例:
function setDoNotDisturbDateCallback(err) {
console.info("========================== >setDoNotDisturbDateCallback======================= >");
}
var doNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate): Promise
设置免打扰时间接口(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
date | 是 | 否 | [DoNotDisturbDate] | 是 | 免打扰时间选项。 |
示例:
var doNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() = > {
console.info("========================== >setDoNotDisturbDatePromise======================= >");
});
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback): void
指定用户设置免打扰时间(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
date | 是 | 否 | [DoNotDisturbDate] | 是 | 免打扰时间选项。 |
userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 |
callback | 是 | 否 | AsyncCallback | 是 | 设置免打扰时间回调函数。 |
示例:
function setDoNotDisturbDateCallback(err) {
console.info("========================== >setDoNotDisturbDateCallback======================= >");
}
var doNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
var userId = 1
Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise
指定用户设置免打扰时间接口(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
date | 是 | 否 | [DoNotDisturbDate] | 是 | 免打扰时间选项。 |
userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 |
示例:
var doNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
var userId = 1
Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() = > {
console.info("========================== >setDoNotDisturbDatePromise======================= >");
});
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(callback: AsyncCallback): void
查询免打扰时间接口(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback<[DoNotDisturbDate]> | 是 | 查询免打扰时间回调函数。 |
示例:
function getDoNotDisturbDateCallback(err,data) {
console.info("========================== >getDoNotDisturbDateCallback======================= >");
}
Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(): Promise
查询免打扰时间接口(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
返回值:
类型 | 说明 |
---|---|
Promise<[DoNotDisturbDate]> | 以Promise形式返回获取查询免打扰时间接口。 |
示例:
Notification.getDoNotDisturbDate().then((data) = > {
console.info("========================== >getDoNotDisturbDatePromise======================= >");
});
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(userId: number, callback: AsyncCallback): void
指定用户查询免打扰时间接口(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback<[DoNotDisturbDate]> | 是 | 查询免打扰时间回调函数。 |
userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 |
示例:
function getDoNotDisturbDateCallback(err,data) {
console.info("========================== >getDoNotDisturbDateCallback======================= >");
}
var userId = 1
Notification.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(userId: number): Promise
指定用户查询免打扰时间接口(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
userId | 是 | 否 | number | 是 | 设置免打扰事件的用户ID。 |
返回值:
类型 | 说明 |
---|---|
Promise<[DoNotDisturbDate]> | 以Promise形式返回获取查询免打扰时间接口。 |
示例:
var userId = 1
Notification.getDoNotDisturbDate(userId).then((data) = > {
console.info("========================== >getDoNotDisturbDatePromise======================= >");
});
Notification.supportDoNotDisturbMode8+
supportDoNotDisturbMode(callback: AsyncCallback): void
查询是否支持勿扰模式功能(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
callback | 是 | 否 | AsyncCallback | 是 | 查询是否支持勿扰模式功能回调函数。 |
示例:
function supportDoNotDisturbModeCallback(err,data) {
console.info("========================== >supportDoNotDisturbModeCallback======================= >");
}
Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
Notification.supportDoNotDisturbMode8+
supportDoNotDisturbMode(): Promise
查询是否支持勿扰模式功能(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回获取是否支持勿扰模式功能的结果。 |
示例:
Notification.supportDoNotDisturbMode().then((data) = > {
console.info("========================== >supportDoNotDisturbModePromise======================= >");
});
Notification.isSupportTemplate8+
isSupportTemplate(templateName: string, callback: AsyncCallback): void
查询模板是否存在(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
templateName | string | 是 | 模板名称。 |
callback | AsyncCallback | 是 | 查询模板是否存在的回调函数。 |
示例:
var templateName = 'process';
function isSupportTemplateCallback(err, data) {
console.info("isSupportTemplateCallback");
}
Notification.isSupportTemplate(templateName, isSupportTemplateCallback);
Notification.isSupportTemplate8+
isSupportTemplate(templateName: string): Promise
查询模板是否存在(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
templateName | string | 是 | 模板名称。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise方式返回模板是否存在的结果。 |
示例:
var templateName = 'process';
Notification.isSupportTemplate(templateName).then((data) = > {
console.info("isSupportTemplateCallback");
});
Notification.requestEnableNotification8+
requestEnableNotification(callback: AsyncCallback): void
应用请求通知使能(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 应用请求通知使能的回调函数。 |
示例:
function requestEnableNotificationCallback() {
console.log('------------- requestEnabledNotification --------------');
};
Notification.requestEnableNotification(requestEnableNotificationCallback);
Notification.requestEnableNotification8+
requestEnableNotification(): Promise
应用请求通知使能(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
示例:
Notification.requestEnableNotification()
.then(() = > {
console.info("requestEnableNotification ");
});
Notification.enableDistributed8+
enableDistributed(enable: boolean, callback: AsyncCallback): void
设置设备是否支持分布式通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
enable | boolean | 是 | 是否支持。 true 支持。 false 不支持。 |
callback | AsyncCallback | 是 | 设置设备是否支持分布式通知的回调函数。 |
示例:
function enabledNotificationCallback() {
console.log('----------- enableDistributed ------------');
};
var enable = true
Notification.enableDistributed(enable, enabledNotificationCallback);
Notification.enableDistributed8+
enableDistributed(enable: boolean): Promise
设置设备是否支持分布式通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
enable | boolean | 是 | 是否支持。 true 支持。 false 不支持。 |
示例:
var enable = true
Notification.enableDistributed(enable)
.then(() = > {
console.log('-------- enableDistributed ----------');
});
Notification.isDistributedEnabled8+
isDistributedEnabled(callback: AsyncCallback): void
获取设备是否支持分布式通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 设备是否支持分布式通知的回调函数。 |
示例:
function isDistributedEnabledCallback() {
console.log('----------- isDistributedEnabled ------------');
};
Notification.isDistributedEnabled(isDistributedEnabledCallback);
Notification.isDistributedEnabled8+
isDistributedEnabled(): Promise
获取设备是否支持分布式通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
返回值:
类型 | 说明 |
---|---|
Promise | Promise方式返回设备是否支持分布式通知的结果。 true 支持。 false 不支持。 |
示例:
Notification.isDistributedEnabled()
.then((data) = > {
console.log('-------- isDistributedEnabled ----------');
});
Notification.enableDistributedByBundle8+
enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void
根据应用的包设置应用程序是否支持分布式通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 应用的包。 |
enable | boolean | 是 | 是否支持。 |
callback | AsyncCallback | 是 | 应用程序是否支持分布式通知的回调函数。 |
示例:
function enableDistributedByBundleCallback() {
console.log('----------- enableDistributedByBundle ------------');
};
var bundle = {
bundle: "bundleName1",
}
var enable = true
Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundleCallback);
Notification.enableDistributedByBundle8+
根据bundleenableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise
根据应用的包设置应用程序是否支持分布式通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 应用的包。 |
enable | boolean | 是 | 是否支持。 |
示例:
var bundle = {
bundle: "bundleName1",
}
var enable = true
Notification.enableDistributedByBundle(bundle, enable)
.then(() = > {
console.log('-------- enableDistributedByBundle ----------');
});
Notification.isDistributedEnabledByBundle8+
isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback): void
根据应用的包获取应用程序是否支持分布式通知(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 应用的包。 |
callback | AsyncCallback | 是 | 应用程序是否支持分布式通知的回调函数。 |
示例:
function isDistributedEnabledByBundleCallback(data) {
console.log('----------- isDistributedEnabledByBundle ------------', data);
};
var bundle = {
bundle: "bundleName1",
}
Notification.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
Notification.isDistributedEnabledByBundle8+
isDistributedEnabledByBundle(bundle: BundleOption): Promise
根据应用的包获取应用程序是否支持分布式通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 应用的包。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise方式返回应用程序是否支持分布式通知的结果。 true 支持。 false 不支持。 |
示例:
var bundle = {
bundle: "bundleName1",
}
Notification.isDistributedEnabledByBundle(bundle)
.then((data) = > {
console.log('-------- isDistributedEnabledByBundle ----------', data);
});
Notification.getDeviceRemindType8+
getDeviceRemindType(callback: AsyncCallback): void
获取通知的提醒方式(Callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[DeviceRemindType]> | 是 | 获取通知的提醒方式的回调函数。 |
示例:
function getDeviceRemindTypeCallback(data) {
console.log('----------- getDeviceRemindType ------------', data);
};
Notification.getDeviceRemindType(getDeviceRemindTypeCallback);
Notification.getDeviceRemindType8+
getDeviceRemindType(): Promise
获取通知的提醒方式(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
返回值:
类型 | 说明 |
---|---|
Promise<[DeviceRemindType]> | Promise方式返回通知的提醒方式的结果。 |
示例:
Notification.getDeviceRemindType()
.then((data) = > {
console.log('-------- getDeviceRemindType ----------', data);
});
Notification.enableNotificationSlot9+
enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback): void
设置是否启用应用通道(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 指定的应用的包的信息。 |
type | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
enable | boolean | 是 | 是否启用的标记。true为启用;false为禁用。 |
callback | AsyncCallback | 是 | 获取启用应用通道的回调函数。 |
示例:
var bundleOption = {
bundle: 'bundle',
uid: 1
};
var type = Notification.SlotType.SOCIAL_COMMUNICATION;
var enable = true;
function enableNotificationSlotCallback(data) {
console.log('-------- enableNotificationSlotCallback ---------', data);
}
Notification.enableNotificationSlot(bundleOption, type, enable, enableNotificationSlotCallback);
Notification.enableNotificationSlot9+
enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise
设置是否启用应用通道(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 指定的应用的包的信息。 |
type | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
enable | boolean | 是 | 是否启用的标记。true为启用;false为禁用。 |
示例:
var bundleOption = {
bundle: 'bundle',
uid: 1
};
var type = Notification.SlotType.SOCIAL_COMMUNICATION;
var enable = true;
Notification.enableNotificationSlot(bundleOption, type, enable)
.then((data) = > {
console.log('-------- enableNotificationSlotCallback success ---------', data);
})
.catch((err) = > {
console.log('-------- enableNotificationSlotCallback fail ---------', err);
});
Notification.isNotificationSlotEnabled9+
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback): void
获取应用通道是否启用的结果(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 指定的应用的包的信息。 |
type | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
callback | AsyncCallback | 是 | 获取启用应用通道的回调函数。 |
示例:
var bundleOption = {
bundle: 'bundle',
uid: 1
};
var type = Notification.SlotType.SOCIAL_COMMUNICATION;
function isNotificationSlotEnabledCallback(data) {
console.log('------------ isNotificationSlotEnabledCallback ------------', data);
}
Notification.isNotificationSlotEnabled(bundleOption, type, isNotificationSlotEnabledCallback);
Notification.isNotificationSlotEnabled9+
isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise
获取应用通道是否启用的结果(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundle | [BundleOption] | 是 | 指定的应用的包的信息。 |
type | [SlotType] | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。 |
返回值:
类型 | 说明 |
---|---|
Promise | 以Promise形式返回应用通道是否启用的结果。true为启用;false为禁用。 |
示例:
var bundleOption = {
bundle: 'bundle',
uid: 1
};
var type = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.isNotificationSlotEnabled(bundleOption, type)
.then((data) = > {
console.log('------------ isNotificationSlotEnabledCallback success ------------', data);
})
.catch((err) = > {
console.log('------------ isNotificationSlotEnabledCallback fail ------------', err);
});
Notification.publishAsBundle9+
publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback): void
发布代理通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
request | [NotificationRequest] | 是 | 设置要发布通知内容的NotificationRequest对象。 |
representativeBundle | string | 是 | 被代理应用的包名。 |
userId | number | 是 | 接收通知用户的Id。 |
callback | AsyncCallback | 是 | 发布代理通知的回调方法。 |
示例:
//publishAsBundle回调
function publishAsBundleCallback(err) {
console.info("========================== >publishAsBundleCallback======================= >");
}
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
//通知Request对象
let notificationRequest = {
id: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
Notification.publishAsBundle(notificationRequest, representativeBundle, userId, publishAsBundleCallback);
Notification.publishAsBundle9+
publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise
发布代理通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
request | [NotificationRequest] | 是 | 设置要发布通知内容的NotificationRequest对象。 |
representativeBundle | string | 是 | 被代理应用的包名。 |
userId | number | 是 | 接收通知用户的Id。 |
示例:
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
//通知Request对象
var notificationRequest = {
id: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
}
Notification.publishAsBundle(notificationRequest, representativeBundle, userId).then(() = > {
console.info("========================== >publishAsBundleCallback======================= >");
});
Notification.cancelAsBundle9+
cancelAsBundle(id: number, representativeBundle: string, userId: number, callback: AsyncCallback): void
取消代理通知(callback形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
id | number | 是 | 通知ID。 |
representativeBundle | string | 是 | 被代理应用的包名。 |
userId | number | 是 | 接收通知用户的Id。 |
callback | AsyncCallback | 是 | 取消代理通知的回调方法。 |
示例:
//cancelAsBundle
function cancelAsBundleCallback(err) {
console.info("========================== >cancelAsBundleCallback======================= >");
}
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
Notification.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);
Notification.cancelAsBundle9+
cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise
发布代理通知(Promise形式)。
系统能力 :SystemCapability.Notification.Notification
需要权限 : ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
id | number | 是 | 通知ID。 |
representativeBundle | string | 是 | 被代理应用的包名。 |
userId | number | 是 | 接收通知用户的Id。 |
示例:
// 被代理应用的包名
let representativeBundle = "com.example.demo"
// 接收通知的用户ID
let userId = 100
Notification.cancelAsBundle(0, representativeBundle, userId).then(() = > {
console.info("========================== >cancelAsBundleCallback======================= >");
});
NotificationSubscriber
onConsume
onConsume?: (data: [SubscribeCallbackData]) => void
接收通知回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
data | AsyncCallback<[SubscribeCallbackData]> | 是 | 回调返回接收到的通知信息。 |
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onConsumeCallback(data) {
console.info('=== > onConsume in test');
let req = data.request;
console.info('=== > onConsume callback req.id:' + req.id);
let wantAgent = data.wantAgent;
wantAgent .getWant(wantAgent)
.then((data1) = > {
console.log('=== > getWant success want:' + JSON.stringify(data1));
})
.catch((err) = > {
console.error('=== > getWant failed because' + JSON.stringify(err));
});
console.info('=== > onConsume callback req.wantAgent:' + JSON.stringify(req.wantAgent));
};
var subscriber = {
onConsume: onConsumeCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onCancel
onCancel?:(data: [SubscribeCallbackData]) => void
删除通知回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
data | AsyncCallback<[SubscribeCallbackData]> | 是 | 回调返回接收到的通知信息。 |
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onCancelCallback(data) {
console.info('=== > onCancel in test');
let req = data.request;
console.info('=== > onCancel callback req.id:' + req.id);
}
var subscriber = {
onCancel: onCancelCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onUpdate
onUpdate?:(data: [NotificationSortingMap]) => void
更新通知排序回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
data | [NotificationSortingMap] | 是 | 回调返回接收到的通知信息。 |
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onUpdateCallback() {
console.info('=== > onUpdate in test');
}
var subscriber = {
onUpdate: onUpdateCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onConnect
onConnect?:() => void
注册订阅回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onConnectCallback() {
console.info('=== > onConnect in test');
}
var subscriber = {
onConnect: onConnectCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onDisconnect
onDisconnect?:() => void
取消订阅回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onDisconnectCallback() {
console.info('=== > onDisconnect in test');
}
var subscriber = {
onDisconnect: onDisconnectCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onDestroy
onDestroy?:() => void
服务失联回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onDestroyCallback() {
console.info('=== > onDestroy in test');
}
var subscriber = {
onDestroy: onDestroyCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onDoNotDisturbDateChange8+
onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate]) => void
免打扰时间选项变更回调函数。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
mode | notification.[DoNotDisturbDate] | 是 | 回调返回免打扰时间选项变更。 |
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onDoNotDisturbDateChangeCallback() {
console.info('=== > onDoNotDisturbDateChange in test');
}
var subscriber = {
onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback
};
Notification.subscribe(subscriber, subscribeCallback);
onEnabledNotificationChanged8+
onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData]) => void
监听应用通知使能变化。
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[EnabledNotificationCallbackData]> | 是 | 回调返回监听到的应用信息。 |
示例:
function subscribeCallback(err) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribeCallback");
}
};
function onEnabledNotificationChangedCallback(callbackData) {
console.info("bundle: ", callbackData.bundle);
console.info("uid: ", callbackData.uid);
console.info("enable: ", callbackData.enable);
};
var subscriber = {
onEnabledNotificationChanged: onEnabledNotificationChangedCallback
};
Notification.subscribe(subscriber, subscribeCallback);
SubscribeCallbackData
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
request | 是 | 否 | [NotificationRequest] | 是 | 通知内容。 |
sortingMap | 是 | 否 | [NotificationSortingMap] | 否 | 排序信息。 |
reason | 是 | 否 | number | 否 | 删除原因。 |
sound | 是 | 否 | string | 否 | 通知声音。 |
viationValues | 是 | 否 | Array | 否 | 通知震动。 |
EnabledNotificationCallbackData8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundle | 是 | 否 | string | 是 | 应用的包名。 |
uid | 是 | 否 | number | 是 | 应用的uid。 |
enable | 是 | 否 | boolean | 是 | 应用通知使能状态。 |
DoNotDisturbDate8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 描述 |
---|---|---|---|---|
type | 是 | 否 | [DoNotDisturbType] | 指定免打扰设置的时间类型。 |
begin | 是 | 否 | Date | 指定免打扰设置的起点时间。 |
end | 是 | 否 | Date | 指定免打扰设置的终点时间。 |
DoNotDisturbType8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 值 | 说明 |
---|---|---|
TYPE_NONE | DoNotDisturbType | 非通知勿扰类型。 |
TYPE_ONCE | DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
TYPE_DAILY | DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
TYPE_CLEARLY | DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰。 |
ContentType
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 值 | 说明 |
---|---|---|
NOTIFICATION_CONTENT_BASIC_TEXT | ContentType | 普通类型通知。 |
NOTIFICATION_CONTENT_LONG_TEXT | ContentType | 长文本类型通知。 |
NOTIFICATION_CONTENT_PICTURE | ContentType | 图片类型通知。 |
NOTIFICATION_CONTENT_CONVERSATION | ContentType | 社交类型通知。 |
NOTIFICATION_CONTENT_MULTILINE | ContentType | 多行文本类型通知。 |
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。 |
NotificationKey
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
id | 是 | 是 | number | 是 | 通知ID。 |
label | 是 | 是 | string | 否 | 通知标签。 |
SlotType
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 值 | 说明 |
---|---|---|
UNKNOWN_TYPE | SlotType | 未知类型。 |
SOCIAL_COMMUNICATION | SlotType | 社交类型。 |
SERVICE_INFORMATION | SlotType | 服务类型。 |
CONTENT_INFORMATION | SlotType | 内容类型。 |
OTHER_TYPES | SlotType | 其他类型。 |
NotificationActionButton
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
title | 是 | 是 | string | 是 | 按钮标题。 |
wantAgent | 是 | 是 | WantAgent | 是 | 点击按钮时触发的WantAgent。 |
extras | 是 | 是 | { [key: string]: any } | 否 | 按钮扩展信息。 |
userInput8+ | 是 | 是 | [NotificationUserInput] | 否 | 用户输入对象实例。 |
NotificationBasicContent
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
title | 是 | 是 | string | 是 | 通知标题。 |
text | 是 | 是 | string | 是 | 通知内容。 |
additionalText | 是 | 是 | string | 否 | 通知次要内容,是对通知内容的补充。 |
NotificationLongTextContent
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
title | 是 | 是 | string | 是 | 通知标题。 |
text | 是 | 是 | string | 是 | 通知内容。 |
additionalText | 是 | 是 | string | 否 | 通知次要内容,是对通知内容的补充。 |
longText | 是 | 是 | string | 是 | 通知的长文本。 |
iefText | 是 | 是 | string | 是 | 通知概要内容,是对通知内容的总结。 |
expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
NotificationMultiLineContent
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
title | 是 | 是 | string | 是 | 通知标题。 |
text | 是 | 是 | string | 是 | 通知内容。 |
additionalText | 是 | 是 | string | 否 | 通知次要内容,是对通知内容的补充。 |
iefText | 是 | 是 | string | 是 | 通知概要内容,是对通知内容的总结。 |
longTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
lines | 是 | 是 | Array | 是 | 通知的多行文本。 |
NotificationPictureContent
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
title | 是 | 是 | string | 是 | 通知标题。 |
text | 是 | 是 | string | 是 | 通知内容。 |
additionalText | 是 | 是 | string | 否 | 通知次要内容,是对通知内容的补充。 |
iefText | 是 | 是 | string | 是 | 通知概要内容,是对通知内容的总结。 |
expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
picture | 是 | 是 | image.PixelMap | 是 | 通知的图片内容。 |
NotificationContent
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
contentType | 是 | 是 | [ContentType] | 是 | 通知内容类型。 |
normal | 是 | 是 | [NotificationBasicContent] | 否 | 基本类型通知内容。 |
longText | 是 | 是 | [NotificationLongTextContent] | 否 | 长文本类型通知内容。 |
multiLine | 是 | 是 | [NotificationMultiLineContent] | 否 | 多行类型通知内容。 |
picture | 是 | 是 | [NotificationPictureContent] | 否 | 图片类型通知内容。 |
NotificationFlagStatus8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 值 | 描述 |
---|---|---|
TYPE_NONE | 0 | 默认标志。 |
TYPE_OPEN | 1 | 通知标志打开。 |
TYPE_CLOSE | 2 | 通知标志关闭。 |
NotificationFlags8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
soundEnabled | 是 | 否 | NotificationFlagStatus | 否 | 是否启用声音提示。 |
viationEnabled | 是 | 否 | 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 | 是 | 是 | PixelMap | 否 | 通知小图标。 |
largeIcon | 是 | 是 | PixelMap | 否 | 通知大图标。 |
creatorBundleName | 是 | 否 | string | 否 | 创建通知的包名。 |
creatorUid | 是 | 否 | number | 否 | 创建通知的UID。 |
creatorPid | 是 | 否 | number | 否 | 创建通知的PID。 |
creatorUserId8+ | 是 | 否 | number | 否 | 创建通知的UserId。 |
hashCode | 是 | 否 | string | 否 | 通知唯一标识。 |
classification | 是 | 是 | string | 否 | 通知分类。 系统API : 此接口为系统接口,三方应用不支持调用。 |
groupName8+ | 是 | 是 | string | 否 | 组通知名称。 |
template8+ | 是 | 是 | [NotificationTemplate] | 否 | 通知模板。 |
isRemoveAllowed8+ | 是 | 否 | boolean | 否 | 通知是否能被移除。 系统API : 此接口为系统接口,三方应用不支持调用。 |
source8+ | 是 | 否 | number | 否 | 通知源。 系统API : 此接口为系统接口,三方应用不支持调用。 |
distributedOption8+ | 是 | 是 | [DistributedOptions] | 否 | 分布式通知的选项。 |
deviceId8+ | 是 | 否 | string | 否 | 通知源的deviceId。 系统API : 此接口为系统接口,三方应用不支持调用。 |
notificationFlags8+ | 是 | 否 | [NotificationFlags] | 否 | 获取NotificationFlags。 |
DistributedOptions8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
isDistributed | 是 | 是 | boolean | 否 | 是否为分布式通知。 |
supportDisplayDevices | 是 | 是 | Array | 是 | 可以同步通知到的设备类型。 |
supportOperateDevices | 是 | 是 | Array | 否 | 可以打开通知的设备。 |
remindType | 是 | 否 | number | 否 | 通知的提醒方式。 系统API : 此接口为系统接口,三方应用不支持调用。 |
NotificationSlot
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
type | 是 | 是 | SlotType | 是 | 通道类型。 |
level | 是 | 是 | number | 否 | 通知级别,不设置则根据通知渠道类型有默认值。 |
desc | 是 | 是 | string | 否 | 通知渠道描述信息。 |
badgeFlag | 是 | 是 | boolean | 否 | 是否显示角标。 |
bypassDnd | 是 | 是 | boolean | 否 | 置是否在系统中绕过免打扰模式。 |
lockscreenVisibility | 是 | 是 | boolean | 否 | 在锁定屏幕上显示通知的模式。 |
viationEnabled | 是 | 是 | boolean | 否 | 是否可振动。 |
sound | 是 | 是 | string | 否 | 通知提示音。 |
lightEnabled | 是 | 是 | boolean | 否 | 是否闪灯。 |
lightColor | 是 | 是 | number | 否 | 通知灯颜色。 |
viationValues | 是 | 是 | Array | 否 | 通知振动样式。 |
enabled9+ | 是 | 否 | boolean | 否 | 此通知插槽中的启停状态。 |
NotificationSorting
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
slot | 是 | 否 | [NotificationSlot] | 是 | 通知通道内容。 |
hashCode | 是 | 否 | string | 是 | 通知唯一标识。 |
ranking | 是 | 否 | number | 是 | 通知排序序号。 |
NotificationSortingMap
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
sortings | 是 | 否 | {[key: string]: [NotificationSorting]} | 是 | 通知排序信息数组。 |
sortedHashCode | 是 | 否 | Array | 是 | 通知唯一标识数组。 |
NotificationSubscribeInfo
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
bundleNames | 是 | 是 | Array | 否 | 指定订阅哪些包名的APP发来的通知。 |
userId | 是 | 是 | number | 否 | 指定订阅哪个用户下发来的通知。 |
NotificationTemplate8+
系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 参数类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
name | string | 是 | 是 | 模板名称。 |
data | {[key:string]: Object} | 是 | 是 | 模板数据。 |
NotificationUserInput8+
系统能力 :SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
---|---|---|---|---|---|
inputKey | 是 | 是 | string | 是 | 用户输入时用于标识此输入的key。 |
DeviceRemindType8+
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称 | 值 | 描述 |
---|---|---|
IDLE_DONOT_REMIND | 0 | 设备未被使用,无需提醒。 |
IDLE_REMIND | 1 | 提醒设备未被使用。 |
ACTIVE_DONOT_REMIND | 2 | 设备正在使用,无需提醒。 |
ACTIVE_REMIND | 3 | 提醒设备正在使用。 |
SourceType8+
系统能力 :SystemCapability.Notification.Notification
系统API : 此接口为系统接口,三方应用不支持调用。
名称HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿 | 值 | 描述 |
---|---|---|
TYPE_NORMAL | 0 | 一般通知。 |
TYPE_CONTINUOUS | 1 | 连续通知。 |
TYPE_TIMER | 2 | 计划通知。 |
审核编辑 黄宇
-
接口
+关注
关注
33文章
8494浏览量
150815 -
鸿蒙
+关注
关注
57文章
2306浏览量
42735
发布评论请先 登录
相关推荐
评论