通知管理的能力

导入模块

import Notification from '@ohos.notificationManager';

Notification.publish

publish(request: NotificationRequest, callback: AsyncCallback<void>): void

发布通知（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

//publish回调
function publishCallback(err) {
    if (err) {
        console.info("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish success");
    }
}
//通知Request对象
let 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<void>

发布通知（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// 通知Request对象
let 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("publish success");
});

Notification.cancel

cancel(id: number, label: string, callback: AsyncCallback<void>): void

通过通知ID和通知标签取消已发布的通知（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// cancel回调
function cancelCallback(err) {
    if (err) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
}
Notification.cancel(0, "label", cancelCallback);

Notification.cancel

cancel(id: number, label?: string): Promise<void>

取消与指定通知ID相匹配的已发布通知，label可以指定也可以不指定（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

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

Notification.cancel

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

取消与指定通知ID相匹配的已发布通知（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// cancel回调
function cancelCallback(err) {
    if (err) {
        console.info("cancel failed " + JSON.stringify(err));
    } else {
        console.info("cancel success");
    }
}
Notification.cancel(0, cancelCallback);

Notification.cancelAll

cancelAll(callback: AsyncCallback<void>): void

取消所有已发布的通知（callback形式）。

系统能力：SystemCapability.Notification.Notification

错误码：

错误码详细介绍请参考errcode-notification。

参数：

示例：

// cancel回调
function cancelAllCallback(err) {
    if (err) {
        console.info("cancelAll failed " + JSON.stringify(err));
    } else {
        console.info("cancelAll success");
    }
}
Notification.cancelAll(cancelAllCallback);

Notification.cancelAll

cancelAll(): Promise<void>

取消所有已发布的通知（Promise形式）。

系统能力：SystemCapability.Notification.Notification

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.cancelAll().then(() => {
    console.info("cancelAll success");
});

Notification.addSlot

addSlot(type: SlotType, callback: AsyncCallback<void>): void

创建指定类型的通知通道（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// addslot回调
function addSlotCallBack(err) {
    if (err) {
        console.info("addSlot failed " + JSON.stringify(err));
    } else {
        console.info("addSlot success");
    }
}
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);

Notification.addSlot

addSlot(type: SlotType): Promise<void>

创建指定类型的通知通道（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => {
    console.info("addSlot success");
});

Notification.getSlot

getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void

获取一个指定类型的通知通道（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// getSlot回调
function getSlotCallback(err,data) {
    if (err) {
        console.info("getSlot failed " + JSON.stringify(err));
    } else {
        console.info("getSlot success");
    }
}
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType, getSlotCallback);

Notification.getSlot

getSlot(slotType: SlotType): Promise<NotificationSlot>

获取一个指定类型的通知通道（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType).then((data) => {
    console.info("getSlot success, data: " + JSON.stringify(data));
});

Notification.getSlots

getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void

获取此应用程序的所有通知通道（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// getSlots回调
function getSlotsCallback(err,data) {
    if (err) {
        console.info("getSlots failed " + JSON.stringify(err));
    } else {
        console.info("getSlots success");
    }
}
Notification.getSlots(getSlotsCallback);

Notification.getSlots

getSlots(): Promise<Array<NotificationSlot>>

获取此应用程序的所有通知通道（Promise形式）。

系统能力：SystemCapability.Notification.Notification

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.getSlots().then((data) => {
    console.info("getSlots success, data: " + JSON.stringify(data));
});

Notification.removeSlot

removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void

删除指定类型的通知通道（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

// removeSlot回调
function removeSlotCallback(err) {
    if (err) {
        console.info("removeSlot failed " + JSON.stringify(err));
    } else {
        console.info("removeSlot success");
    }
}
let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType,removeSlotCallback);

Notification.removeSlot

removeSlot(slotType: SlotType): Promise<void>

删除指定类型的通知通道（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

let slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then(() => {
    console.info("removeSlot success");
});

Notification.removeAllSlots

removeAllSlots(callback: AsyncCallback<void>): void

删除所有通知通道（callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function removeAllCallBack(err) {
    if (err) {
        console.info("removeAllSlots failed " + JSON.stringify(err));
    } else {
        console.info("removeAllSlots success");
    }
}
Notification.removeAllSlots(removeAllCallBack);

Notification.removeAllSlots

removeAllSlots(): Promise<void>

删除所有通知通道（Promise形式）。

系统能力：SystemCapability.Notification.Notification

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.removeAllSlots().then(() => {
    console.info("removeAllSlots success");
});

Notification.getActiveNotificationCount

getActiveNotificationCount(callback: AsyncCallback<number>): void

获取当前应用未删除的通知数（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function getActiveNotificationCountCallback(err, data) {
    if (err) {
        console.info("getActiveNotificationCount failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotificationCount success");
    }
}

Notification.getActiveNotificationCount(getActiveNotificationCountCallback);

Notification.getActiveNotificationCount

getActiveNotificationCount(): Promise<number>

获取当前应用未删除的通知数（Promise形式）。

系统能力：SystemCapability.Notification.Notification

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.getActiveNotificationCount().then((data) => {
    console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
});

Notification.getActiveNotifications

getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void

获取当前应用未删除的通知列表（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function getActiveNotificationsCallback(err, data) {
    if (err) {
        console.info("getActiveNotifications failed " + JSON.stringify(err));
    } else {
        console.info("getActiveNotifications success");
    }
}

Notification.getActiveNotifications(getActiveNotificationsCallback);

Notification.getActiveNotifications

getActiveNotifications(): Promise<Array<NotificationRequest>>

获取当前应用未删除的通知列表（Promise形式）。

系统能力：SystemCapability.Notification.Notification

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.getActiveNotifications().then((data) => {
    console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
});

Notification.cancelGroup

cancelGroup(groupName: string, callback: AsyncCallback<void>): void

取消本应用指定组下的通知（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function cancelGroupCallback(err) {
    if (err) {
        console.info("cancelGroup failed " + JSON.stringify(err));
    } else {
        console.info("cancelGroup success");
    }
}

let groupName = "GroupName";

Notification.cancelGroup(groupName, cancelGroupCallback);

Notification.cancelGroup

cancelGroup(groupName: string): Promise<void>

取消本应用指定组下的通知（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

let groupName = "GroupName";
Notification.cancelGroup(groupName).then(() => {
    console.info("cancelGroup success");
});

Notification.isSupportTemplate

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

查询模板是否存在（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

let templateName = 'process';
function isSupportTemplateCallback(err, data) {
    if (err) {
        console.info("isSupportTemplate failed " + JSON.stringify(err));
    } else {
        console.info("isSupportTemplate success");
    }
}

Notification.isSupportTemplate(templateName, isSupportTemplateCallback);

Notification.isSupportTemplate

isSupportTemplate(templateName: string): Promise<boolean>

查询模板是否存在（Promise形式）。

系统能力：SystemCapability.Notification.Notification

参数：

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

let templateName = 'process';

Notification.isSupportTemplate(templateName).then((data) => {
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
});

Notification.requestEnableNotification

requestEnableNotification(callback: AsyncCallback<void>): void

应用请求通知使能（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function requestEnableNotificationCallback(err) {
    if (err) {
        console.info("requestEnableNotification failed " + JSON.stringify(err));
    } else {
        console.info("requestEnableNotification success");
    }
};

Notification.requestEnableNotification(requestEnableNotificationCallback);

Notification.requestEnableNotification

requestEnableNotification(): Promise<void>

应用请求通知使能（Promise形式）。

系统能力：SystemCapability.Notification.Notification

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.requestEnableNotification().then(() => {
    console.info("requestEnableNotification success");
});

Notification.isDistributedEnabled

isDistributedEnabled(callback: AsyncCallback<boolean>): void

查询设备是否支持分布式通知（Callback形式）。

系统能力：SystemCapability.Notification.Notification

参数：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

function isDistributedEnabledCallback(err, data) {
    if (err) {
        console.info("isDistributedEnabled failed " + JSON.stringify(err));
    } else {
        console.info("isDistributedEnabled success " + JSON.stringify(data));
    }
};

Notification.isDistributedEnabled(isDistributedEnabledCallback);

Notification.isDistributedEnabled

isDistributedEnabled(): Promise<boolean>

查询设备是否支持分布式通知（Promise形式）。

系统能力：SystemCapability.Notification.Notification

返回值：

错误码：

错误码详细介绍请参考errcode-notification。

示例：

Notification.isDistributedEnabled()
    .then((data) => {
        console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
    });

ContentType

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

SlotType

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