閱讀(629) 書簽贊(0) 我要糾錯(cuò)

通知管理的能力

2024-01-23 13:00 更新

本模塊提供通知管理的能力，包括發(fā)布、取消發(fā)布通知，創(chuàng)建、獲取、移除通知通道，訂閱、取消訂閱通知，獲取通知的使能狀態(tài)、角標(biāo)使能狀態(tài)，獲取通知的相關(guān)信息等。

說(shuō)明

本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

通知訂閱和取消訂閱僅對(duì)系統(tǒng)應(yīng)用開放。

導(dǎo)入模塊


import Notification from '@ohos.notification';

Notification.publish

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

發(fā)布通知（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
request	NotificationRequest	是	用于設(shè)置要發(fā)布通知的內(nèi)容和相關(guān)配置信息。
callback	AsyncCallback<void>	是	發(fā)布通知的回調(diào)方法。

示例：


// publish回調(diào)
function publishCallback(err) {
    if (err.code) {
        console.info("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish success");
    }
}
// 通知Request對(duì)象
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>

發(fā)布通知（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
request	NotificationRequest	是	用于設(shè)置要發(fā)布通知的內(nèi)容和相關(guān)配置信息。

示例：


// 通知Request對(duì)象
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

通過(guò)通知ID和通知標(biāo)簽取消已發(fā)布的通知（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
id	number	是	通知ID。
label	string	是	通知標(biāo)簽。
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


// cancel回調(diào)
function cancelCallback(err) {
    if (err.code) {
        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相匹配的已發(fā)布通知，label可以指定也可以不指定（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
id	number	是	通知ID。
label	string	否	通知標(biāo)簽。

示例：


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

Notification.cancel

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

取消與指定通知ID相匹配的已發(fā)布通知（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
id	number	是	通知ID。
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


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

Notification.cancelAll

cancelAll(callback: AsyncCallback<void>): void

取消所有已發(fā)布的通知（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


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

Notification.cancelAll

cancelAll(): Promise<void>

取消所有已發(fā)布的通知（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

示例：


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

Notification.addSlot

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

創(chuàng)建指定類型的通知通道（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
type	SlotType	是	要?jiǎng)?chuàng)建的通知通道的類型。
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


// addslot回調(diào)
function addSlotCallBack(err) {
    if (err.code) {
        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>

創(chuàng)建指定類型的通知通道（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
type	SlotType	是	要?jiǎng)?chuàng)建的通知通道的類型。

示例：


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

Notification.getSlot

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

獲取一個(gè)指定類型的通知通道（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
slotType	SlotType	是	通知渠道類型，目前分為社交通信、服務(wù)提醒、內(nèi)容咨詢和其他類型。
callback	AsyncCallback<NotificationSlot>	是	表示被指定的回調(diào)方法。

示例：


// getSlot回調(diào)
function getSlotCallback(err, data) {
    if (err.code) {
        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>

獲取一個(gè)指定類型的通知通道（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
slotType	SlotType	是	通知渠道類型，目前分為社交通信、服務(wù)提醒、內(nèi)容咨詢和其他類型。

返回值：

類型	說(shuō)明
Promise<NotificationSlot>	以Promise形式返回獲取一個(gè)通知通道。

示例：


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

獲取此應(yīng)用程序的所有通知通道（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<Array<NotificationSlot>>	是	以callback形式返回獲取此應(yīng)用程序的所有通知通道的結(jié)果。

示例：


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

Notification.getSlots

getSlots(): Promise<Array<NotificationSlot>>

獲取此應(yīng)用程序的所有通知通道（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

返回值：

類型	說(shuō)明
Promise<Array<NotificationSlot>>	以Promise形式返回獲取此應(yīng)用程序的所有通知通道的結(jié)果。

示例：


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

Notification.removeSlot

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

刪除指定類型的通知通道（callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
slotType	SlotType	是	通知渠道類型,目前分為社交通信、服務(wù)提醒、內(nèi)容咨詢和其他類型。
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


// removeSlot回調(diào)
function removeSlotCallback(err) {
    if (err.code) {
        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形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
slotType	SlotType	是	通知渠道類型,目前分為社交通信、服務(wù)提醒、內(nèi)容咨詢和其他類型。

示例：


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

Notification.removeAllSlots

removeAllSlots(callback: AsyncCallback<void>): void

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

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<void>	是	表示被指定的回調(diào)方法。

示例：


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

Notification.removeAllSlots

removeAllSlots(): Promise<void>

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

系統(tǒng)能力：SystemCapability.Notification.Notification

示例：


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

Notification.getActiveNotificationCount

getActiveNotificationCount(callback: AsyncCallback<number>): void

獲取當(dāng)前應(yīng)用未刪除的通知數(shù)（Callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<number>	是	獲取未刪除通知數(shù)回調(diào)函數(shù)。

示例：


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

Notification.getActiveNotificationCount(getActiveNotificationCountCallback);

Notification.getActiveNotificationCount

getActiveNotificationCount(): Promise<number>

獲取當(dāng)前應(yīng)用未刪除的通知數(shù)（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

返回值：

類型	說(shuō)明
Promise<number>	以Promise形式返回獲取當(dāng)前應(yīng)用未刪除通知數(shù)。

示例：


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

Notification.getActiveNotifications

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

獲取當(dāng)前應(yīng)用未刪除的通知列表（Callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<Array<NotificationRequest>>	是	獲取當(dāng)前應(yīng)用通知列表回調(diào)函數(shù)。

示例：


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

Notification.getActiveNotifications(getActiveNotificationsCallback);

Notification.getActiveNotifications

getActiveNotifications(): Promise<Array<NotificationRequest>>

獲取當(dāng)前應(yīng)用未刪除的通知列表（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

返回值：

類型	說(shuō)明
Promise<Array<NotificationRequest>>	以Promise形式返回獲取當(dāng)前應(yīng)用通知列表。

示例：


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

Notification.cancelGroup8+

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

取消本應(yīng)用指定組下的通知（Callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
groupName	string	是	通知組名稱，此名稱需要在發(fā)布通知時(shí)通過(guò)NotificationRequest對(duì)象指定。
callback	AsyncCallback<void>	是	取消本應(yīng)用指定組下通知的回調(diào)函數(shù)。

示例：


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

let groupName = "GroupName";

Notification.cancelGroup(groupName, cancelGroupCallback);

Notification.cancelGroup8+

cancelGroup(groupName: string): Promise<void>

取消本應(yīng)用指定組下的通知（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
groupName	string	是	通知組名稱。

示例：


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

Notification.isSupportTemplate8+

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

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

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
templateName	string	是	模板名稱。
callback	AsyncCallback<boolean>	是	查詢模板是否存在的回調(diào)函數(shù)。

示例：


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

Notification.isSupportTemplate(templateName, isSupportTemplateCallback);

Notification.isSupportTemplate8+

isSupportTemplate(templateName: string): Promise<boolean>

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

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
templateName	string	是	模板名稱。

返回值：

類型	說(shuō)明
Promise<boolean>	Promise方式返回模板是否存在的結(jié)果。

示例：


let templateName = 'process';

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

Notification.requestEnableNotification8+

requestEnableNotification(callback: AsyncCallback<void>): void

應(yīng)用請(qǐng)求通知使能（Callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<void>	是	應(yīng)用請(qǐng)求通知使能的回調(diào)函數(shù)。

示例：


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

Notification.requestEnableNotification(requestEnableNotificationCallback);

Notification.requestEnableNotification8+

requestEnableNotification(): Promise<void>

應(yīng)用請(qǐng)求通知使能（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

示例：


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

Notification.isDistributedEnabled8+

isDistributedEnabled(callback: AsyncCallback<boolean>): void

查詢?cè)O(shè)備是否支持分布式通知（Callback形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

參數(shù)：

參數(shù)名	類型	必填	說(shuō)明
callback	AsyncCallback<boolean>	是	設(shè)備是否支持分布式通知的回調(diào)函數(shù)。

示例：


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

Notification.isDistributedEnabled(isDistributedEnabledCallback);

Notification.isDistributedEnabled8+

isDistributedEnabled(): Promise<boolean>

查詢?cè)O(shè)備是否支持分布式通知（Promise形式）。

系統(tǒng)能力：SystemCapability.Notification.Notification

返回值：

類型	說(shuō)明
Promise<boolean>	Promise方式返回設(shè)備是否支持分布式通知的結(jié)果。

示例：


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

ContentType

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	值	說(shuō)明
NOTIFICATION_CONTENT_BASIC_TEXT	NOTIFICATION_CONTENT_BASIC_TEXT	普通類型通知。
NOTIFICATION_CONTENT_LONG_TEXT	NOTIFICATION_CONTENT_LONG_TEXT	長(zhǎng)文本類型通知。
NOTIFICATION_CONTENT_PICTURE	NOTIFICATION_CONTENT_PICTURE	圖片類型通知。
NOTIFICATION_CONTENT_CONVERSATION	NOTIFICATION_CONTENT_CONVERSATION	社交類型通知。
NOTIFICATION_CONTENT_MULTILINE	NOTIFICATION_CONTENT_MULTILINE	多行文本類型通知。

SlotLevel

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	值	說(shuō)明
LEVEL_NONE	0	表示關(guān)閉通知功能。
LEVEL_MIN	1	表示通知功能已啟用，但狀態(tài)欄中不顯示通知圖標(biāo)，且沒(méi)有橫幅或提示音。
LEVEL_LOW	2	表示通知功能已啟用，且狀態(tài)欄中顯示通知圖標(biāo)，但沒(méi)有橫幅或提示音。
LEVEL_DEFAULT	3	表示通知功能已啟用，狀態(tài)欄中顯示通知圖標(biāo)，沒(méi)有橫幅但有提示音。
LEVEL_HIGH	4	表示通知功能已啟用，狀態(tài)欄中顯示通知圖標(biāo)，有橫幅和提示音。

BundleOption

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
bundle	string	是	是	應(yīng)用的包信息。
uid	number	是	是	用戶ID。

NotificationKey

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
id	number	是	是	通知ID。
label	string	是	是	通知標(biāo)簽。

SlotType

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	值	說(shuō)明
UNKNOWN_TYPE	0	未知類型。
SOCIAL_COMMUNICATION	1	社交類型。
SERVICE_INFORMATION	2	服務(wù)類型。
CONTENT_INFORMATION	3	內(nèi)容類型。
OTHER_TYPES	0xFFFF	其他類型。

NotificationActionButton

描述通知中顯示的操作按鈕。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
title	string	是	是	按鈕標(biāo)題。
wantAgent	WantAgent	是	是	點(diǎn)擊按鈕時(shí)觸發(fā)的WantAgent。
extras	{ [key: string]: any }	是	是	按鈕擴(kuò)展信息。
userInput8+	NotificationUserInput	是	是	用戶輸入對(duì)象實(shí)例。

NotificationBasicContent

描述普通文本通知。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
title	string	是	是	通知標(biāo)題。
text	string	是	是	通知內(nèi)容。
additionalText	string	是	是	通知附加內(nèi)容，是對(duì)通知內(nèi)容的補(bǔ)充。

NotificationLongTextContent

描述長(zhǎng)文本通知。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
title	string	是	是	通知標(biāo)題。
text	string	是	是	通知內(nèi)容。
additionalText	string	是	是	通知附加內(nèi)容，是對(duì)通知內(nèi)容的補(bǔ)充。
longText	string	是	是	通知的長(zhǎng)文本。
briefText	string	是	是	通知概要內(nèi)容，是對(duì)通知內(nèi)容的總結(jié)。
expandedTitle	string	是	是	通知展開時(shí)的標(biāo)題。

NotificationMultiLineContent

描述多行文本通知。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
title	string	是	是	通知標(biāo)題。
text	string	是	是	通知內(nèi)容。
additionalText	string	是	是	通知附加內(nèi)容，是對(duì)通知內(nèi)容的補(bǔ)充。
briefText	string	是	是	通知概要內(nèi)容，是對(duì)通知內(nèi)容的總結(jié)。
longTitle	string	是	是	通知展開時(shí)的標(biāo)題。
lines	Array<string>	是	是	通知的多行文本。

NotificationPictureContent

描述附有圖片的通知。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
title	string	是	是	通知標(biāo)題。
text	string	是	是	通知內(nèi)容。
additionalText	string	是	是	通知附加內(nèi)容，是對(duì)通知內(nèi)容的補(bǔ)充。
briefText	string	是	是	通知概要內(nèi)容，是對(duì)通知內(nèi)容的總結(jié)。
expandedTitle	string	是	是	通知展開時(shí)的標(biāo)題。
picture	image.PixelMap	是	是	通知的圖片內(nèi)容。

NotificationContent

描述通知類型。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
contentType	ContentType	是	是	通知內(nèi)容類型。
normal	NotificationBasicContent	是	是	基本類型通知內(nèi)容。
longText	NotificationLongTextContent	是	是	長(zhǎng)文本類型通知內(nèi)容。
multiLine	NotificationMultiLineContent	是	是	多行類型通知內(nèi)容。
picture	NotificationPictureContent	是	是	圖片類型通知內(nèi)容。

NotificationFlags8+

描述通知標(biāo)志的實(shí)例。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
soundEnabled	NotificationFlagStatus	是	否	是否啟用聲音提示。
vibrationEnabled	NotificationFlagStatus	是	否	是否啟用振動(dòng)提醒功能。

NotificationRequest

描述通知的請(qǐng)求。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
content	NotificationContent	是	是	通知內(nèi)容。
id	number	是	是	通知ID。
slotType	SlotType	是	是	通道類型。
isOngoing	boolean	是	是	是否進(jìn)行時(shí)通知。
isUnremovable	boolean	是	是	是否可移除。
deliveryTime	number	是	是	通知發(fā)送時(shí)間。
tapDismissed	boolean	是	是	通知是否自動(dòng)清除。
autoDeletedTime	number	是	是	自動(dòng)清除的時(shí)間。
wantAgent	WantAgent	是	是	WantAgent封裝了應(yīng)用的行為意圖，點(diǎn)擊通知時(shí)觸發(fā)該行為。
extraInfo	{[key: string]: any}	是	是	擴(kuò)展參數(shù)。
color	number	是	是	通知背景顏色。預(yù)留能力，暫未支持。
colorEnabled	boolean	是	是	通知背景顏色是否使能。預(yù)留能力，暫未支持。
isAlertOnce	boolean	是	是	設(shè)置是否僅有一次此通知提醒。
isStopwatch	boolean	是	是	是否顯示已用時(shí)間。
isCountDown	boolean	是	是	是否顯示倒計(jì)時(shí)時(shí)間。
isFloatingIcon	boolean	是	是	是否顯示狀態(tài)欄圖標(biāo)。
label	string	是	是	通知標(biāo)簽。
badgeIconStyle	number	是	是	通知角標(biāo)類型。
showDeliveryTime	boolean	是	是	是否顯示分發(fā)時(shí)間。
actionButtons	Array<NotificationActionButton>	是	是	通知按鈕，最多兩個(gè)按鈕。
smallIcon	image.PixelMap	是	是	通知小圖標(biāo)?？蛇x字段，大小不超過(guò)30KB。
largeIcon	image.PixelMap	是	是	通知大圖標(biāo)?？蛇x字段，大小不超過(guò)30KB。
creatorBundleName	string	是	否	創(chuàng)建通知的包名。
creatorUid	number	是	否	創(chuàng)建通知的UID。
creatorPid	number	是	否	創(chuàng)建通知的PID。
creatorUserId8+	number	是	否	創(chuàng)建通知的UserId。
hashCode	string	是	否	通知唯一標(biāo)識(shí)。
groupName8+	string	是	是	組通知名稱。
template8+	NotificationTemplate	是	是	通知模板。
distributedOption8+	DistributedOptions	是	是	分布式通知的選項(xiàng)。
notificationFlags8+	NotificationFlags	是	否	獲取NotificationFlags。
removalWantAgent9+	WantAgent	是	是	當(dāng)移除通知時(shí)，通知將被重定向到的WantAgent實(shí)例。
badgeNumber9+	number	是	是	應(yīng)用程序圖標(biāo)上顯示的通知數(shù)。

DistributedOptions8+

描述分布式選項(xiàng)。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
isDistributed	boolean	是	是	是否為分布式通知。
supportDisplayDevices	Array<string>	是	是	可以同步通知到的設(shè)備列表。
supportOperateDevices	Array<string>	是	是	可以打開通知的設(shè)備列表。

NotificationSlot

描述通知槽

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
type	SlotType	是	是	通道類型。
level	number	是	是	通知級(jí)別，不設(shè)置則根據(jù)通知渠道類型有默認(rèn)值。
desc	string	是	是	通知渠道描述信息。
badgeFlag	boolean	是	是	是否顯示角標(biāo)。
bypassDnd	boolean	是	是	置是否在系統(tǒng)中繞過(guò)免打擾模式。
lockscreenVisibility	number	是	是	在鎖定屏幕上顯示通知的模式。
vibrationEnabled	boolean	是	是	是否可振動(dòng)。
sound	string	是	是	通知提示音。
lightEnabled	boolean	是	是	是否閃燈。
lightColor	number	是	是	通知燈顏色。
vibrationValues	Array<number>	是	是	通知振動(dòng)樣式。
enabled9+	boolean	是	否	此通知插槽中的啟停狀態(tài)。

NotificationTemplate8+

通知模板。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
name	string	是	是	模板名稱。
data	{[key:string]: Object}	是	是	模板數(shù)據(jù)。

NotificationUserInput8+

保存用戶輸入的通知消息。

系統(tǒng)能力：SystemCapability.Notification.Notification

名稱	類型	可讀	可寫	說(shuō)明
inputKey	string	是	是

以上內(nèi)容是否對(duì)您有幫助：

← 公共事件的能力

事件中心，提供訂閱、取消訂閱、觸發(fā)事件的能力 →

寫筆記

我要補(bǔ)充

通知管理的能力

導(dǎo)入模塊

Notification.publish

Notification.publish

Notification.cancel

Notification.cancel

Notification.cancel

Notification.cancelAll

Notification.cancelAll

Notification.addSlot

Notification.addSlot

Notification.getSlot

Notification.getSlot

Notification.getSlots

Notification.getSlots

Notification.removeSlot

Notification.removeSlot

Notification.removeAllSlots

Notification.removeAllSlots

Notification.getActiveNotificationCount

Notification.getActiveNotificationCount

Notification.getActiveNotifications

Notification.getActiveNotifications

Notification.cancelGroup8+

Notification.cancelGroup8+

Notification.isSupportTemplate8+

Notification.isSupportTemplate8+

Notification.requestEnableNotification8+

Notification.requestEnableNotification8+

Notification.isDistributedEnabled8+

Notification.isDistributedEnabled8+

ContentType

SlotLevel

BundleOption

NotificationKey

SlotType

NotificationActionButton

NotificationBasicContent

NotificationLongTextContent

NotificationMultiLineContent

NotificationPictureContent

NotificationContent

NotificationFlags8+

NotificationRequest

DistributedOptions8+

NotificationSlot

NotificationTemplate8+

NotificationUserInput8+

推薦文章

推薦教程

推薦課程