0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

鸿蒙开发接口公共事件与通知:【Notification模块】

jf_46214456 来源:jf_46214456 作者:jf_46214456 2024-05-21 17:04 次阅读

Notification模块

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

导入模块

开发前请熟悉鸿蒙开发指导文档:[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对象。
callbackAsyncCallback被指定的回调方法。

示例:

//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对象。
userIdnumber接收通知用户的Id。
callbackAsyncCallback被指定的回调方法。

示例:

//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对象。
userIdnumber接收通知用户的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

参数:

名称可读可写类型必填描述
idnumber通知ID。
labelstring通知标签
callbackAsyncCallback表示被指定的回调方法。

示例:

//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

参数:

名称可读可写类型必填描述
idnumber通知ID。
labelstring通知标签。

示例:

Notification.cancel(0).then(() = > {
	console.info("========================== >cancelCallback======================= >");
});

Notification.cancel

cancel(id: number, callback: AsyncCallback): void

取消与指定id相匹配的已发布通知(callback形式)。

系统能力 :SystemCapability.Notification.Notification

参数:

名称可读可写类型必填描述
idnumber通知ID。
callbackAsyncCallback表示被指定的回调方法。

示例:

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

Notification.cancelAll

cancelAll(callback: AsyncCallback): void

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

系统能力 :SystemCapability.Notification.Notification

参数:

名称可读可写类型必填描述
callbackAsyncCallback表示被指定的回调方法。

示例:

//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]要创建的通知通道对象。
callbackAsyncCallback表示被指定的回调方法。

示例:

//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]要创建的通知通道的类型。
callbackAsyncCallback表示被指定的回调方法。

示例:

//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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
slotsArray<[NotificationSlot]>要创建的通知通道对象数组。
callbackAsyncCallback表示被指定的回调方法。

示例:

//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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
slotsArray<[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]通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。
callbackAsyncCallback<[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

参数:

名称可读可写类型必填描述
callbackAsyncCallback<[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]通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。
callbackAsyncCallback表示被指定的回调方法。

示例:

//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

参数:

名称可读可写类型必填描述
callbackAsyncCallback表示被指定的回调方法。

示例:

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]订阅信息。
callbackAsyncCallback订阅动作回调函数。

示例:

//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]通知订阅对象。
callbackAsyncCallback订阅动作回调函数。

示例:

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]通知订阅对象。
callbackAsyncCallback取消订阅动作回调函数。

示例:

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]指定包信息。
enableboolean使能状态。
callbackAsyncCallback设定通知使能回调函数。

示例:

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]指定包信息。
enableboolean使能状态。

示例:

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]指定包信息。
callbackAsyncCallback获取通知使能状态回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback获取通知使能状态回调函数。

示例:

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]指定包信息。
enableboolean使能状态。
callbackAsyncCallback设定角标使能回调函数。

示例:

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]指定包信息。
enableboolean使能状态。

示例:

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]指定包信息。
callbackAsyncCallback获取角标使能状态回调函数。

示例:

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]通知通道。
callbackAsyncCallback设定通知通道回调函数。

示例:

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]指定包信息。
callbackAsyncCallback>获取通知通道回调函数。

示例:

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]指定包信息。
callbackAsyncCallback获取通知通道数回调函数。

示例:

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]通知键值。
callbackAsyncCallback删除指定通知回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
hashCodestring通知唯一ID。
callbackAsyncCallback删除指定通知回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
hashCodestring通知唯一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]指定包信息。
callbackAsyncCallback删除指定包的所有通知回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback删除所有通知回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
userIdnumber接收通知用户的Id。
callbackAsyncCallback删除所有通知回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
userIdnumber接收通知用户的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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback>获取活动通知回调函数。

示例:

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

参数:

名称可读可写类型必填描述
callbackAsyncCallback获取活动通知数回调函数。

示例:

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

参数:

名称可读可写类型必填描述
callbackAsyncCallback>获取当前应用的活动通知回调函数。

示例:

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

参数:

名称可读可写类型必填描述
groupNamestring指定通知组名称。
callbackAsyncCallback取消本应用指定组通知回调函数。

示例:

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

var groupName = "GroupName";

Notification.cancelGroup(groupName, cancelGroupCallback);

Notification.cancelGroup8+

cancelGroup(groupName: string): Promise

取消本应用指定组通知(Promise形式)。

系统能力 :SystemCapability.Notification.Notification

参数:

名称可读可写类型必填描述
groupNamestring指定通知组名称。

示例:

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]指定包信息。
groupNamestring指定通知组名称。
callbackAsyncCallback删除本应用指定组通知回调函数。

示例:

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]指定包信息。
groupNamestring指定通知组名称。

示例:

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]免打扰时间选项。
callbackAsyncCallback设置免打扰时间回调函数。

示例:

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]免打扰时间选项。
userIdnumber设置免打扰事件的用户ID。
callbackAsyncCallback设置免打扰时间回调函数。

示例:

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]免打扰时间选项。
userIdnumber设置免打扰事件的用户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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback<[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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback<[DoNotDisturbDate]>查询免打扰时间回调函数。
userIdnumber设置免打扰事件的用户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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
userIdnumber设置免打扰事件的用户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 : 此接口为系统接口,三方应用不支持调用。

参数:

名称可读可写类型必填描述
callbackAsyncCallback查询是否支持勿扰模式功能回调函数。

示例:

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

参数:

参数名类型必填说明
templateNamestring模板名称。
callbackAsyncCallback查询模板是否存在的回调函数。

示例:

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

Notification.isSupportTemplate(templateName, isSupportTemplateCallback);

Notification.isSupportTemplate8+

isSupportTemplate(templateName: string): Promise

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

系统能力 :SystemCapability.Notification.Notification

参数:

参数名类型必填说明
templateNamestring模板名称。

返回值:

类型说明
PromisePromise方式返回模板是否存在的结果。

示例:

var templateName = 'process';

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

Notification.requestEnableNotification8+

requestEnableNotification(callback: AsyncCallback): void

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

系统能力 :SystemCapability.Notification.Notification

参数:

参数名类型必填说明
callbackAsyncCallback应用请求通知使能的回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
enableboolean是否支持。 true 支持。 false 不支持。
callbackAsyncCallback设置设备是否支持分布式通知的回调函数。

示例:

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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
enableboolean是否支持。 true 支持。 false 不支持。

示例:

var enable = true

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

Notification.isDistributedEnabled8+

isDistributedEnabled(callback: AsyncCallback): void

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

系统能力 :SystemCapability.Notification.Notification

参数:

参数名类型必填说明
callbackAsyncCallback设备是否支持分布式通知的回调函数。

示例:

function isDistributedEnabledCallback() {
    console.log('----------- isDistributedEnabled ------------');
};

Notification.isDistributedEnabled(isDistributedEnabledCallback);

Notification.isDistributedEnabled8+

isDistributedEnabled(): Promise

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

系统能力 :SystemCapability.Notification.Notification

返回值:

类型说明
PromisePromise方式返回设备是否支持分布式通知的结果。 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]应用的包。
enableboolean是否支持。
callbackAsyncCallback应用程序是否支持分布式通知的回调函数。

示例:

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]应用的包。
enableboolean是否支持。

示例:

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]应用的包。
callbackAsyncCallback应用程序是否支持分布式通知的回调函数。

示例:

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]应用的包。

返回值:

类型说明
PromisePromise方式返回应用程序是否支持分布式通知的结果。 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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
callbackAsyncCallback<[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]通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。
enableboolean是否启用的标记。true为启用;false为禁用。
callbackAsyncCallback获取启用应用通道的回调函数。

示例:

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]通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。
enableboolean是否启用的标记。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]通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型。
callbackAsyncCallback获取启用应用通道的回调函数。

示例:

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对象。
representativeBundlestring被代理应用的包名。
userIdnumber接收通知用户的Id。
callbackAsyncCallback发布代理通知的回调方法。

示例:

//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对象。
representativeBundlestring被代理应用的包名。
userIdnumber接收通知用户的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

参数:

参数名类型必填说明
idnumber通知ID。
representativeBundlestring被代理应用的包名。
userIdnumber接收通知用户的Id。
callbackAsyncCallback取消代理通知的回调方法。

示例:

//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

参数:

参数名类型必填说明
idnumber通知ID。
representativeBundlestring被代理应用的包名。
userIdnumber接收通知用户的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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
dataAsyncCallback<[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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
dataAsyncCallback<[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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
modenotification.[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 : 此接口为系统接口,三方应用不支持调用。

参数:

参数名类型必填说明
callbackAsyncCallback<[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]排序信息。
reasonnumber删除原因。
soundstring通知声音。
viationValuesArray通知震动。

EnabledNotificationCallbackData8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称可读可写类型必填描述
bundlestring应用的包名。
uidnumber应用的uid。
enableboolean应用通知使能状态。

DoNotDisturbDate8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称可读可写类型描述
type[DoNotDisturbType]指定免打扰设置的时间类型。
beginDate指定免打扰设置的起点时间。
endDate指定免打扰设置的终点时间。

DoNotDisturbType8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称说明
TYPE_NONEDoNotDisturbType非通知勿扰类型。
TYPE_ONCEDoNotDisturbType以设置时间段(只看小时和分钟)一次执行勿扰。
TYPE_DAILYDoNotDisturbType以设置时间段(只看小时和分钟)每天执行勿扰。
TYPE_CLEARLYDoNotDisturbType以设置时间段(明确年月日时分)执行勿扰。

ContentType

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称说明
NOTIFICATION_CONTENT_BASIC_TEXTContentType普通类型通知。
NOTIFICATION_CONTENT_LONG_TEXTContentType长文本类型通知。
NOTIFICATION_CONTENT_PICTUREContentType图片类型通知。
NOTIFICATION_CONTENT_CONVERSATIONContentType社交类型通知。
NOTIFICATION_CONTENT_MULTILINEContentType多行文本类型通知。

SlotLevel

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称说明
LEVEL_NONE0表示关闭通知功能。
LEVEL_MIN1表示通知功能已启用,但状态栏中不显示通知图标,且没有横幅或提示音。
LEVEL_LOW2表示通知功能已启用,且状态栏中显示通知图标,但没有横幅或提示音。
LEVEL_DEFAULT3表示通知功能已启用,状态栏中显示通知图标,没有横幅但有提示音。
LEVEL_HIGH4表示通知功能已启用,状态栏中显示通知图标,有横幅和提示音。

BundleOption

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
bundlestring包名。
uidnumber用户id。

NotificationKey

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
idnumber通知ID。
labelstring通知标签。

SlotType

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称说明
UNKNOWN_TYPESlotType未知类型。
SOCIAL_COMMUNICATIONSlotType社交类型。
SERVICE_INFORMATIONSlotType服务类型。
CONTENT_INFORMATIONSlotType内容类型。
OTHER_TYPESSlotType其他类型。

NotificationActionButton

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
titlestring按钮标题。
wantAgentWantAgent点击按钮时触发的WantAgent。
extras{ [key: string]: any }按钮扩展信息。
userInput8+[NotificationUserInput]用户输入对象实例。

NotificationBasicContent

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
titlestring通知标题。
textstring通知内容。
additionalTextstring通知次要内容,是对通知内容的补充。

NotificationLongTextContent

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
titlestring通知标题。
textstring通知内容。
additionalTextstring通知次要内容,是对通知内容的补充。
longTextstring通知的长文本。
iefTextstring通知概要内容,是对通知内容的总结。
expandedTitlestring通知展开时的标题。

NotificationMultiLineContent

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
titlestring通知标题。
textstring通知内容。
additionalTextstring通知次要内容,是对通知内容的补充。
iefTextstring通知概要内容,是对通知内容的总结。
longTitlestring通知展开时的标题。
linesArray通知的多行文本。

NotificationPictureContent

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
titlestring通知标题。
textstring通知内容。
additionalTextstring通知次要内容,是对通知内容的补充。
iefTextstring通知概要内容,是对通知内容的总结。
expandedTitlestring通知展开时的标题。
pictureimage.PixelMap通知的图片内容。

NotificationContent

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
contentType[ContentType]通知内容类型。
normal[NotificationBasicContent]基本类型通知内容。
longText[NotificationLongTextContent]长文本类型通知内容。
multiLine[NotificationMultiLineContent]多行类型通知内容。
picture[NotificationPictureContent]图片类型通知内容。

NotificationFlagStatus8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称描述
TYPE_NONE0默认标志。
TYPE_OPEN1通知标志打开。
TYPE_CLOSE2通知标志关闭。

NotificationFlags8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
soundEnabledNotificationFlagStatus是否启用声音提示。
viationEnabledNotificationFlagStatus是否启用振动提醒功能。

NotificationRequest

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
content[NotificationContent]通知内容。
idnumber通知ID。
slotType[SlotType]通道类型。
isOngoingboolean是否进行时通知。
isUnremovableboolean是否可移除。
deliveryTimenumber通知发送时间。
tapDismissedboolean通知是否自动清除。
autoDeletedTimenumber自动清除的时间。
wantAgentWantAgent点击跳转的WantAgent。
extraInfo{[key: string]: any}扩展参数。
colornumber通知背景颜色。
colorEnabledboolean通知背景颜色是否使能。
isAlertOnceboolean设置是否仅有一次此通知警报。
isStopwatchboolean是否显示已用时间。
isCountDownboolean是否显示倒计时时间。
isFloatingIconboolean是否显示状态栏图标。
labelstring通知标签。
badgeIconStylenumber通知角标类型。
showDeliveryTimeboolean是否显示分发时间。
actionButtonsArray<[NotificationActionButton]>通知按钮,最多两个按钮。
smallIconPixelMap通知小图标。
largeIconPixelMap通知大图标。
creatorBundleNamestring创建通知的包名。
creatorUidnumber创建通知的UID。
creatorPidnumber创建通知的PID。
creatorUserId8+number创建通知的UserId。
hashCodestring通知唯一标识。
classificationstring通知分类。 系统API : 此接口为系统接口,三方应用不支持调用。
groupName8+string组通知名称。
template8+[NotificationTemplate]通知模板。
isRemoveAllowed8+boolean通知是否能被移除。 系统API : 此接口为系统接口,三方应用不支持调用。
source8+number通知源。 系统API : 此接口为系统接口,三方应用不支持调用。
distributedOption8+[DistributedOptions]分布式通知的选项。
deviceId8+string通知源的deviceId。 系统API : 此接口为系统接口,三方应用不支持调用。
notificationFlags8+[NotificationFlags]获取NotificationFlags。

DistributedOptions8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
isDistributedboolean是否为分布式通知。
supportDisplayDevicesArray可以同步通知到的设备类型。
supportOperateDevicesArray可以打开通知的设备。
remindTypenumber通知的提醒方式。 系统API : 此接口为系统接口,三方应用不支持调用。

NotificationSlot

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称可读可写类型必填描述
typeSlotType通道类型。
levelnumber通知级别,不设置则根据通知渠道类型有默认值。
descstring通知渠道描述信息。
badgeFlagboolean是否显示角标。
bypassDndboolean置是否在系统中绕过免打扰模式。
lockscreenVisibilityboolean在锁定屏幕上显示通知的模式。
viationEnabledboolean是否可振动。
soundstring通知提示音。
lightEnabledboolean是否闪灯。
lightColornumber通知灯颜色。
viationValuesArray通知振动样式。
enabled9+boolean此通知插槽中的启停状态。

NotificationSorting

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称可读可写类型必填描述
slot[NotificationSlot]通知通道内容。
hashCodestring通知唯一标识。
rankingnumber通知排序序号。

NotificationSortingMap

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称可读可写类型必填描述
sortings{[key: string]: [NotificationSorting]}通知排序信息数组。
sortedHashCodeArray通知唯一标识数组。

NotificationSubscribeInfo

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

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

名称可读可写类型必填描述
bundleNamesArray指定订阅哪些包名的APP发来的通知。
userIdnumber指定订阅哪个用户下发来的通知。

NotificationTemplate8+

系统能力 :以下各项对应的系统能力均为SystemCapability.Notification.Notification

名称参数类型可读可写说明
namestring模板名称。
data{[key:string]: Object}模板数据。

NotificationUserInput8+

系统能力 :SystemCapability.Notification.Notification

名称可读可写类型必填描述
inputKeystring用户输入时用于标识此输入的key。

DeviceRemindType8+

系统能力 :SystemCapability.Notification.Notification

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

名称描述
IDLE_DONOT_REMIND0设备未被使用,无需提醒。
IDLE_REMIND1提醒设备未被使用。
ACTIVE_DONOT_REMIND2设备正在使用,无需提醒。
ACTIVE_REMIND3提醒设备正在使用。

SourceType8+

系统能力 :SystemCapability.Notification.Notification

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

搜狗高速浏览器截图20240326151450.png

名称HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿描述
TYPE_NORMAL0一般通知。
TYPE_CONTINUOUS1连续通知。
TYPE_TIMER2计划通知。

审核编辑 黄宇

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 接口
    +关注

    关注

    33

    文章

    8494

    浏览量

    150815
  • 鸿蒙
    +关注

    关注

    57

    文章

    2306

    浏览量

    42735
收藏 人收藏

    评论

    相关推荐

    鸿蒙开发接口公共事件与通知:【@ohos.commonEvent (公共事模块)】

    模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
    的头像 发表于 05-21 11:13 1021次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.commonEvent (<b class='flag-5'>公共事</b>件<b class='flag-5'>模块</b>)】

    鸿蒙开发接口公共事件与通知:【@ohos.events.emitter (Emitter)】

    模块首批接口从API version 7开始支持。
    的头像 发表于 05-21 16:06 1282次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.events.emitter (Emitter)】

    鸿蒙开发接口公共事件与通知:【@ohos.reminderAgent (后台代理提醒)】

    开发应用时,开发者可以调用后台提醒发布的接口创建定时提醒,包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后,应用可以被冻结或退出,计时和弹出提醒的功能将被后台系统服务代理。
    的头像 发表于 05-25 16:27 685次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.reminderAgent (后台代理提醒)】

    鸿蒙开发接口公共事件与通知:【application/EventHub (EventHub)】

    EventHub模块提供了事件中心,提供订阅、取消订阅、触发事件的能力。
    的头像 发表于 05-25 16:31 719次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【application/EventHub (EventHub)】

    鸿蒙开发接口公共事件与通知:【FFI能力】 N-API在Android、iOS平台应用的使用指导

    N-API接口可以实现ArkTS/TS/JS与C/C++(Native)之间的交互,ArkUI-X中支持的N-API接口情况和使用场景请见[FFI能力(N-API)]。本文档以[ArkUI-X/Samples]中的Native样例工程为例,介绍如何在Android平台上使
    的头像 发表于 05-25 16:33 1835次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【FFI能力】 N-API在Android、iOS平台应用的使用指导

    鸿蒙原生应用/元服务开发-发布基础类型通知开发步骤

    : { contentType: NotificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, // 普通文本类型通知 normal
    发表于 01-02 15:03

    鸿蒙原生应用/元服务开发-通知添加行为意图

    WantAgent提供了封装行为意图的能力,这里所说的行为意图主要是指拉起指定的应用组件及发布公共事件等能力。HarmonyOS支持以通知的形式,将WantAgent从发布方传递至接收方,从而在接收
    发表于 01-05 15:07

    鸿蒙原生应用/元服务开发-消息通知整体说明

    应用/元服务可以通过通知接口发送通知消息,终端用户可以通过通知栏查看通知内容,也可以点击通知来打
    发表于 01-08 15:26

    基于ArkTS语言的OpenHarmony APP应用开发:自定义通知

    /tree/master/samples/d04_CustomNotification API接口:9 2、知识准备 2.1、Notification模块模块提供
    发表于 09-14 15:12

    基于ArkTS语言的OpenHarmony APP应用开发公共事件的订阅和发布

    /d05_CustomCommonEvent API接口:9 2、知识准备 2.1、commonEvent模块 OpenHarmony通过CES(Common Event Service,公共事件服务)为
    发表于 09-18 13:16

    HarmonyOS应用开发-公共事件处理

    开发过程中service想要控制多个ability时,可以考虑使用公共事件处理。发布无序的公共事件: //发布公共事件 同步修改卡片与页面public void subscribeE
    发表于 11-02 15:15

    鸿蒙开发接口Ability框架:【@ohos.ability.wantConstant (wantConstant)】

    wantConstant模块提供want中action和entity的权限列表的能力,包括系统公共事件宏,系统公共事件名称等。
    的头像 发表于 04-30 16:33 585次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b>Ability框架:【@ohos.ability.wantConstant (wantConstant)】

    鸿蒙开发接口公共事件与通知:【FFI能力(Node-API)】

    Node-API是封装底层JavaScript运行时能力的一套Native接口。OpenHarmony的N-API组件对Node-API的接口进行了重新实现,ArkUI-X同样拥有这部分能力,目前支持部分接口,支持列表。
    的头像 发表于 05-21 16:38 909次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【FFI能力(Node-API)】

    鸿蒙语言基础类库:system.notification 通知消息

    以下各项对应的系统能力均为SystemCapability.Notification.Notification
    的头像 发表于 07-18 09:23 282次阅读

    基于ArkTS语言的OpenHarmony APP应用开发公共事件的订阅和发布

    1、程序介绍本示例主要展示了公共事件相关的功能,实现了一个检测用户部分行为的应用。具体而言,本案例实现了如下几个公共事件功能:通过订阅系统公共事件,实现对用户操作行为(亮灭屏、断联网)的监测;通过
    的头像 发表于 09-19 08:05 371次阅读
    基于ArkTS语言的OpenHarmony APP应用<b class='flag-5'>开发</b>:<b class='flag-5'>公共事</b>件的订阅和发布