harmony 鸿蒙@ohos.notification (Notification)
@ohos.notification (Notification)
The Notification module provides notification management capabilities, covering notifications, notification slots, notification subscription, notification enabled status, and notification badge status.
NOTE
The APIs provided by this module are no longer maintained since API version 9. You are advised to use @ohos.notificationManager.
The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Notification subscription and unsubscription APIs are available only to system applications.
Modules to Import
import Notification from '@ohos.notification';
Notification.publish
publish(request: NotificationRequest, callback: AsyncCallback<void>): void
Publishes a notification. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
request | NotificationRequest | Yes | Content and related configuration of the notification to publish. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// publish callback
let publishCallback = (err: Base.BusinessError) => {
if (err) {
console.error(`publish failed, code is ${err}`);
} else {
console.info("publish success");
}
}
// NotificationRequest object
let notificationRequest: NotificationManager.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>
Publishes a notification. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
request | NotificationRequest | Yes | Content and related configuration of the notification to publish. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// NotificationRequest object
let notificationRequest: NotificationManager.NotificationRequest = {
id: 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");
}).catch((err: Base.BusinessError) => {
console.error(`publish failed, code is ${err}`);
});
Notification.publish8+
publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void
Publishes a notification to a specified user. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
request | NotificationRequest | Yes | Content and related configuration of the notification to publish. |
userId | number | Yes | User ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// publish callback
let publishCallback = (err: Base.BusinessError) => {
if (err) {
console.error(`publish failed, code is ${err.code}`);
} else {
console.info("publish success");
}
}
// User ID
let userId: number = 1;
// NotificationRequest object
let notificationRequest: NotificationManager.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<void>
Publishes a notification to a specified user. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
request | NotificationRequest | Yes | Content and related configuration of the notification to publish. |
userId | number | Yes | User ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
let notificationRequest: NotificationManager.NotificationRequest = {
id: 1,
content: {
contentType: Notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "test_title",
text: "test_text",
additionalText: "test_additionalText"
}
}
};
let userId: number = 1;
Notification.publish(notificationRequest, userId).then(() => {
console.info("publish success");
}).catch((err: Base.BusinessError) => {
console.error(`publish failed, code is ${err}`);
});
Notification.cancel
cancel(id: number, label: string, callback: AsyncCallback<void>): void
Cancels a notification with the specified ID and label. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Notification ID. |
label | string | Yes | Notification label. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// cancel callback
let cancelCallback = (err: Base.BusinessError) => {
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>
Cancels a notification with the specified ID and optional label. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Notification ID. |
label | string | No | Notification label. This parameter is left empty by default. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
Notification.cancel(0).then(() => {
console.info("cancel success");
}).catch((err: Base.BusinessError) => {
console.error(`cancel failed, code is ${err}`);
});
Notification.cancel
cancel(id: number, callback: AsyncCallback<void>): void
Cancels a notification with the specified ID. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Notification ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// cancel callback
let cancelCallback = (err: Base.BusinessError) => {
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
Cancels all notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// cancel callback
let cancelAllCallback = (err: Base.BusinessError) => {
if (err) {
console.info("cancelAll failed " + JSON.stringify(err));
} else {
console.info("cancelAll success");
}
}
Notification.cancelAll(cancelAllCallback);
Notification.cancelAll
cancelAll(): Promise<void>
Cancels all notifications. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
Notification.cancelAll().then(() => {
console.info("cancelAll success");
}).catch((err: Base.BusinessError) => {
console.error(`cancelAll failed, code is ${err}`);
});
Notification.addSlot
addSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
Adds a notification slot. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slot | NotificationSlot | Yes | Notification slot to add. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// addSlot callback
let addSlotCallBack = (err: Base.BusinessError) => {
if (err) {
console.info("addSlot failed " + JSON.stringify(err));
} else {
console.info("addSlot success");
}
}
// NotificationSlot object
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
Notification.addSlot(notificationSlot, addSlotCallBack);
Notification.addSlot
addSlot(slot: NotificationSlot): Promise<void>
Adds a notification slot. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slot | NotificationSlot | Yes | Notification slot to add. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// NotificationSlot object
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
Notification.addSlot(notificationSlot).then(() => {
console.info("addSlot success");
}).catch((err: Base.BusinessError) => {
console.error(`addSlot failed, code is ${err}`);
});
Notification.addSlot
addSlot(type: SlotType, callback: AsyncCallback<void>): void
Adds a notification slot of a specified type. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | SlotType | Yes | Type of the notification slot to add. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// addSlot callback
let addSlotCallBack = (err: Base.BusinessError) => {
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>
Adds a notification slot of a specified type. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | SlotType | Yes | Type of the notification slot to add. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then(() => {
console.info("addSlot success");
}).catch((err: Base.BusinessError) => {
console.error(`addSlot failed, code is ${err}`);
});
Notification.addSlots
addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>): void
Adds an array of notification slots. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slots | Array<NotificationSlot> | Yes | Notification slots to add. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// addSlots callback
let addSlotsCallBack = (err: Base.BusinessError) => {
if (err) {
console.info("addSlots failed " + JSON.stringify(err));
} else {
console.info("addSlots success");
}
}
// NotificationSlot object
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray: NotificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray, addSlotsCallBack);
Notification.addSlots
addSlots(slots: Array<NotificationSlot>): Promise<void>
Adds an array of notification slots. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slots | Array<NotificationSlot> | Yes | Notification slots to add. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import NotificationManager from '@ohos.notificationManager';
import Base from '@ohos.base';
// NotificationSlot object
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray: NotificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;
Notification.addSlots(notificationSlotArray).then(() => {
console.info("addSlots success");
}).catch((err: Base.BusinessError) => {
console.error(`addSlot failed, code is ${err}`);
});
Notification.getSlot
getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void
Obtains a notification slot of a specified type. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slotType | SlotType | Yes | Type of the notification slot, which can be used for social communication, service information, content consultation, and other purposes. |
callback | AsyncCallback<NotificationSlot> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// getSlot callback
let getSlotCallback = (err: Base.BusinessError) => {
if (err) {
console.info("getSlot failed " + JSON.stringify(err));
} else {
console.info("getSlot success");
}
}
let slotType: Notification.SlotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType, getSlotCallback);
Notification.getSlot
getSlot(slotType: SlotType): Promise<NotificationSlot>
Obtains a notification slot of a specified type. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slotType | SlotType | Yes | Type of the notification slot, which can be used for social communication, service information, content consultation, and other purposes. |
Return value
Type | Description |
---|---|
Promise<NotificationSlot> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let slotType: Notification.SlotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType).then((data) => {
console.info("getSlot success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getSlot failed, code is ${err}`);
});
Notification.getSlots
getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void
Obtains all notification slots. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<NotificationSlot>> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// getSlots callback
function getSlotsCallback(err: Base.BusinessError) {
if (err) {
console.info("getSlots failed " + JSON.stringify(err));
} else {
console.info("getSlots success");
}
}
Notification.getSlots(getSlotsCallback);
Notification.getSlots
getSlots(): Promise<Array<NotificationSlot>>
Obtains all notification slots of this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<Array<NotificationSlot>> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.getSlots().then((data) => {
console.info("getSlots success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getSlots failed, code is ${err}`);
});
Notification.removeSlot
removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void
Removes a notification slot of a specified type. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slotType | SlotType | Yes | Type of the notification slot, which can be used for social communication, service information, content consultation, and other purposes. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
// removeSlot callback
let removeSlotCallback = (err: Base.BusinessError) => {
if (err) {
console.info("removeSlot failed " + JSON.stringify(err));
} else {
console.info("removeSlot success");
}
}
let slotType: Notification.SlotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType, removeSlotCallback);
Notification.removeSlot
removeSlot(slotType: SlotType): Promise<void>
Removes a notification slot of a specified type. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
slotType | SlotType | Yes | Type of the notification slot, which can be used for social communication, service information, content consultation, and other purposes. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let slotType: Notification.SlotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then(() => {
console.info("removeSlot success");
}).catch((err: Base.BusinessError) => {
console.error(`removeSlot failed, code is ${err}`);
});
Notification.removeAllSlots
removeAllSlots(callback: AsyncCallback<void>): void
Removes all notification slots. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let removeAllCallBack = (err: Base.BusinessError) => {
if (err) {
console.info("removeAllSlots failed " + JSON.stringify(err));
} else {
console.info("removeAllSlots success");
}
}
Notification.removeAllSlots(removeAllCallBack);
Notification.removeAllSlots
removeAllSlots(): Promise<void>
Removes all notification slots. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
Notification.removeAllSlots().then(() => {
console.info("removeAllSlots success");
}).catch((err: Base.BusinessError) => {
console.error(`removeAllSlots failed, code is ${err}`);
});
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>): void
Subscribes to a notification with the subscription information specified. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
subscriber | NotificationSubscriber | Yes | Notification subscriber. |
info | NotificationSubscribeInfo | Yes | Notification subscription information. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationSubscribe from '@ohos.notificationSubscribe';
// subscribe callback
let subscribeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribe success");
}
}
let onConsumeCallback = (data: NotificationSubscribe.SubscribeCallbackData) => {
console.info("Consume callback: " + JSON.stringify(data));
}
let subscriber: NotificationSubscribe.NotificationSubscriber = {
onConsume: onConsumeCallback
};
let info: NotificationSubscribe.NotificationSubscribeInfo = {
bundleNames: ["bundleName1", "bundleName2"]
};
Notification.subscribe(subscriber, info, subscribeCallback);
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void
Subscribes to notifications of all applications under this user. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
subscriber | NotificationSubscriber | Yes | Notification subscriber. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationSubscribe from '@ohos.notificationSubscribe';
let subscribeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
console.info("subscribe success");
}
}
function onConsumeCallback(data: NotificationSubscribe.SubscribeCallbackData) {
console.info("Consume callback: " + JSON.stringify(data));
}
let subscriber: NotificationSubscribe.NotificationSubscriber = {
onConsume: onConsumeCallback
};
Notification.subscribe(subscriber, subscribeCallback);
Notification.subscribe
subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise<void>
Subscribes to a notification with the subscription information specified. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
subscriber | NotificationSubscriber | Yes | Notification subscriber. |
info | NotificationSubscribeInfo | No | Notification subscription information. This parameter is left empty by default. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
import NotificationSubscribe from '@ohos.notificationSubscribe';
function onConsumeCallback(data: NotificationSubscribe.SubscribeCallbackData) {
console.info("Consume callback: " + JSON.stringify(data));
}
let subscriber: NotificationSubscribe.NotificationSubscriber = {
onConsume: onConsumeCallback
};
Notification.subscribe(subscriber).then(() => {
console.info("subscribe success");
}).catch((err: Base.BusinessError) => {
console.error(`subscribe failed, code is ${err}`);
});
Notification.unsubscribe
unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void
Unsubscribes from a notification. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
subscriber | NotificationSubscriber | Yes | Notification subscriber. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationSubscribe from '@ohos.notificationSubscribe';
let unsubscribeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("unsubscribe failed " + JSON.stringify(err));
} else {
console.info("unsubscribe success");
}
}
let onDisconnectCallback = () => {
console.info("subscribe disconnect");
}
let subscriber: NotificationSubscribe.NotificationSubscriber = {
onDisconnect: onDisconnectCallback
};
Notification.unsubscribe(subscriber, unsubscribeCallback);
Notification.unsubscribe
unsubscribe(subscriber: NotificationSubscriber): Promise<void>
Unsubscribes from a notification. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
subscriber | NotificationSubscriber | Yes | Notification subscriber. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
import NotificationSubscribe from '@ohos.notificationSubscribe';
function onDisconnectCallback() {
console.info("subscribe disconnect");
}
let subscriber: NotificationSubscribe.NotificationSubscriber = {
onDisconnect: onDisconnectCallback
};
Notification.unsubscribe(subscriber).then(() => {
console.info("unsubscribe success");
}).catch((err: Base.BusinessError) => {
console.error(`unsubscribe failed, code is ${err}`);
});
Notification.enableNotification
enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
Sets whether to enable notification for a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
enable | boolean | Yes | Whether to enable notification. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let enableNotificationCallback = (err: Base.BusinessError) => {
if (err) {
console.info("enableNotification failed " + JSON.stringify(err));
} else {
console.info("enableNotification success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.enableNotification(bundle, false, enableNotificationCallback);
Notification.enableNotification
enableNotification(bundle: BundleOption, enable: boolean): Promise<void>
Sets whether to enable notification for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
enable | boolean | Yes | Whether to enable notification. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.enableNotification(bundle, false).then(() => {
console.info("enableNotification success");
}).catch((err: Base.BusinessError) => {
console.error(`enableNotification failed, code is ${err}`);
});
Notification.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void
Checks whether notification is enabled for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("isNotificationEnabled failed " + JSON.stringify(err));
} else {
console.info("isNotificationEnabled success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
Notification.isNotificationEnabled
isNotificationEnabled(bundle: BundleOption): Promise<boolean>
Checks whether notification is enabled for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isNotificationEnabled(bundle).then((data) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isNotificationEnabled failed, code is ${err}`);
});
Notification.isNotificationEnabled
isNotificationEnabled(callback: AsyncCallback<boolean>): void
Checks whether notification is enabled for this application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("isNotificationEnabled failed " + JSON.stringify(err));
} else {
console.info("isNotificationEnabled success");
}
}
Notification.isNotificationEnabled(isNotificationEnabledCallback);
Notification.isNotificationEnabled
isNotificationEnabled(): Promise<boolean>
Checks whether notification is enabled for this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.isNotificationEnabled().then((data: boolean) => {
console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isNotificationEnabled failed, code is ${err}`);
});
Notification.displayBadge
displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
Sets whether to enable the notification badge for a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
enable | boolean | Yes | Whether to enable notification. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let displayBadgeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("displayBadge failed " + JSON.stringify(err));
} else {
console.info("displayBadge success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.displayBadge(bundle, false, displayBadgeCallback);
Notification.displayBadge
displayBadge(bundle: BundleOption, enable: boolean): Promise<void>
Sets whether to enable the notification badge for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
enable | boolean | Yes | Whether to enable notification. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.displayBadge(bundle, false).then(() => {
console.info("displayBadge success");
}).catch((err: Base.BusinessError) => {
console.error(`displayBadge failed, code is ${err}`);
});
Notification.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>): void
Checks whether the notification badge is enabled for a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let isBadgeDisplayedCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("isBadgeDisplayed failed " + JSON.stringify(err));
} else {
console.info("isBadgeDisplayed success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
Notification.isBadgeDisplayed
isBadgeDisplayed(bundle: BundleOption): Promise<boolean>
Checks whether the notification badge is enabled for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isBadgeDisplayed(bundle).then((data) => {
console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isBadgeDisplayed failed, code is ${err}`);
});
Notification.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>): void
Sets the notification slot for a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
slot | NotificationSlot | Yes | Notification slot. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let setSlotByBundleCallback = (err: Base.BusinessError) => {
if (err) {
console.info("setSlotByBundle failed " + JSON.stringify(err));
} else {
console.info("setSlotByBundle success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
Notification.setSlotByBundle
setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise<void>
Sets the notification slot for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
slot | NotificationSlot | Yes | Notification slot. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
let notificationSlot: NotificationManager.NotificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
};
Notification.setSlotByBundle(bundle, notificationSlot).then(() => {
console.info("setSlotByBundle success");
}).catch((err: Base.BusinessError) => {
console.error(`setSlotByBundle failed, code is ${err}`);
});
Notification.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>): void
Obtains the notification slots of a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
callback | AsyncCallback<Array<NotificationSlot>> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let getSlotsByBundleCallback = (err: Base.BusinessError, data: NotificationManager.NotificationSlot[]) => {
if (err) {
console.info("getSlotsByBundle failed " + JSON.stringify(err));
} else {
console.info("getSlotsByBundle success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
Notification.getSlotsByBundle
getSlotsByBundle(bundle: BundleOption): Promise<Array<NotificationSlot>>
Obtains the notification slots of a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
Return value
Type | Description |
---|---|
Promise<Array<NotificationSlot>> | Promise used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.getSlotsByBundle(bundle).then((data: NotificationManager.NotificationSlot[]) => {
console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getSlotsByBundle failed, code is ${err}`);
});
Notification.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>): void
Obtains the number of notification slots of a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let getSlotNumByBundleCallback = (err: Base.BusinessError, data: number) => {
if (err) {
console.info("getSlotNumByBundle failed " + JSON.stringify(err));
} else {
console.info("getSlotNumByBundle success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
Notification.getSlotNumByBundle
getSlotNumByBundle(bundle: BundleOption): Promise<number>
Obtains the number of notification slots of a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
Return value
Type | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.getSlotNumByBundle(bundle).then((data: number) => {
console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getSlotNumByBundle failed, code is ${err}`);
});
Notification.remove
remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason, callback: AsyncCallback<void>): void
Removes a notification for a specified bundle. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
notificationKey | NotificationKey | Yes | Notification key. |
reason | RemoveReason | Yes | Reason for deleting a notification. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let removeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("remove failed " + JSON.stringify(err));
} else {
console.info("remove success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
let notificationKey: Notification.NotificationKey = {
id: 0,
label: "label",
};
let reason: Notification.RemoveReason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Notification.remove(bundle, notificationKey, reason, removeCallback);
Notification.remove
remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise<void>
Removes a notification for a specified bundle. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
notificationKey | NotificationKey | Yes | Notification key. |
reason | RemoveReason | Yes | Reason for deleting the notification. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
let notificationKey: Notification.NotificationKey = {
id: 0,
label: "label",
};
let reason: Notification.RemoveReason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Notification.remove(bundle, notificationKey, reason).then(() => {
console.info("remove success");
}).catch((err: Base.BusinessError) => {
console.error(`remove failed, code is ${err}`);
});
Notification.remove
remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback<void>): void
Removes a notification for a specified bundle. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
hashCode | string | Yes | Unique notification ID. It is the hashCode in the NotificationRequest object of SubscribeCallbackData of the onConsume callback. |
reason | RemoveReason | Yes | Reason for deleting a notification. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let hashCode: string = 'hashCode';
let removeCallback = (err: Base.BusinessError) => {
if (err) {
console.info("remove failed " + JSON.stringify(err));
} else {
console.info("remove success");
}
}
let reason: Notification.RemoveReason = Notification.RemoveReason.CANCEL_REASON_REMOVE;
Notification.remove(hashCode, reason, removeCallback);
Notification.remove
remove(hashCode: string, reason: RemoveReason): Promise<void>
Removes a notification for a specified bundle. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
hashCode | string | Yes | Unique notification ID. |
reason | RemoveReason | Yes | Reason for deleting the notification. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let hashCode: string = 'hashCode';
let reason: Notification.RemoveReason = Notification.RemoveReason.CLICK_REASON_REMOVE;
Notification.remove(hashCode, reason).then(() => {
console.info("remove success");
}).catch((err: Base.BusinessError) => {
console.error(`remove failed, code is ${err}`);
});
Notification.removeAll
removeAll(bundle: BundleOption, callback: AsyncCallback<void>): void
Removes all notifications for a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let removeAllCallback = (err: Base.BusinessError) => {
if (err) {
console.info("removeAll failed " + JSON.stringify(err));
} else {
console.info("removeAll success");
}
}
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.removeAll(bundle, removeAllCallback);
Notification.removeAll
removeAll(callback: AsyncCallback<void>): void
Removes all notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let removeAllCallback = (err: Base.BusinessError) => {
if (err) {
console.info("removeAll failed " + JSON.stringify(err));
} else {
console.info("removeAll success");
}
}
Notification.removeAll(removeAllCallback);
Notification.removeAll
removeAll(bundle?: BundleOption): Promise<void>
Removes all notifications for a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | No | Bundle information of the application. By default, this parameter is left empty, indicating that all notifications will be removed. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
// If no application is specified, notifications of all applications are deleted.
Notification.removeAll().then(() => {
console.info("removeAll success");
}).catch((err: Base.BusinessError) => {
ar
});
Notification.removeAll8+
removeAll(userId: number, callback: AsyncCallback<void>): void
Removes all notifications for a specified user. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
userId | number | Yes | User ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
function removeAllCallback(err: Base.BusinessError) {
if (err) {
console.info("removeAll failed " + JSON.stringify(err));
} else {
console.info("removeAll success");
}
}
let userId: number = 1;
Notification.removeAll(userId, removeAllCallback);
Notification.removeAll8+
removeAll(userId: number): Promise<void>
Removes all notifications for a specified user. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
userId | number | Yes | User ID. |
Example
import Base from '@ohos.base';
let userId: number = 1;
Notification.removeAll(userId).then(() => {
console.info("removeAll success");
}).catch((err: Base.BusinessError) => {
ar
});
Notification.getAllActiveNotifications
getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void
Obtains all active notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<NotificationRequest>> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
function getAllActiveNotificationsCallback(err: Base.BusinessError, data: NotificationManager.NotificationRequest[]) {
if (err) {
console.info("getAllActiveNotifications failed " + JSON.stringify(err));
} else {
console.info("getAllActiveNotifications success");
}
}
Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
Notification.getAllActiveNotifications
getAllActiveNotifications(): Promise<Array<NotificationRequest>>
Obtains all active notifications. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Return value
Type | Description |
---|---|
Promise<Array<NotificationRequest>> | Promise used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
Notification.getAllActiveNotifications().then((data: NotificationManager.NotificationRequest[]) => {
console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getAllActiveNotifications failed, code is ${err}`);
});
Notification.getActiveNotificationCount
getActiveNotificationCount(callback: AsyncCallback<number>): void
Obtains the number of active notifications of this application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<number> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let getActiveNotificationCountCallback = (err: Base.BusinessError, data: number) => {
if (err) {
console.info("getActiveNotificationCount failed " + JSON.stringify(err));
} else {
console.info("getActiveNotificationCount success");
}
}
Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
Notification.getActiveNotificationCount
getActiveNotificationCount(): Promise<number>
Obtains the number of active notifications of this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<number> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.getActiveNotificationCount().then((data: number) => {
console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getAllActiveNotifications failed, code is ${err}`);
});
Notification.getActiveNotifications
getActiveNotifications(callback: AsyncCallback
Obtains active notifications of this application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback |
Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
let getActiveNotificationsCallback = (err: Base.BusinessError, data: NotificationManager.NotificationRequest[]) => {
if (err) {
console.info("getActiveNotifications failed " + JSON.stringify(err));
} else {
console.info("getActiveNotifications success");
}
}
Notification.getActiveNotifications(getActiveNotificationsCallback);
Notification.getActiveNotifications
getActiveNotifications(): Promise<Array<NotificationRequest>>
Obtains active notifications of this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<Array<NotificationRequest>> | Promise used to return the result. |
Example
import Base from '@ohos.base';
import NotificationManager from '@ohos.notificationManager';
Notification.getActiveNotifications().then((data: NotificationManager.NotificationRequest[]) => {
console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`removeGroupByBundle failed, code is ${err}`);
});
Notification.cancelGroup8+
cancelGroup(groupName: string, callback: AsyncCallback<void>): void
Cancels notifications under a notification group of this application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
groupName | string | Yes | Name of the notification group, which is specified through NotificationRequest when the notification is published. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let cancelGroupCallback = (err: Base.BusinessError) => {
if (err) {
console.info("cancelGroup failed " + JSON.stringify(err));
} else {
console.info("cancelGroup success");
}
}
let groupName: string = "GroupName";
Notification.cancelGroup(groupName, cancelGroupCallback);
Notification.cancelGroup8+
cancelGroup(groupName: string): Promise<void>
Cancels notifications under a notification group of this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
groupName | string | Yes | Name of the notification group. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let groupName: string = "GroupName";
Notification.cancelGroup(groupName).then(() => {
console.info("cancelGroup success");
}).catch((err: Base.BusinessError) => {
console.error(`cancelGroup failed, code is ${err}`);
});
Notification.removeGroupByBundle8+
removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback<void>): void
Removes notifications under a notification group of a specified application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
groupName | string | Yes | Name of the notification group. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let removeGroupByBundleCallback = (err: Base.BusinessError) => {
if (err) {
console.info("removeGroupByBundle failed " + JSON.stringify(err));
} else {
console.info("removeGroupByBundle success");
}
}
let bundleOption: Notification.BundleOption = {bundle: "Bundle"};
let groupName: string = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
Notification.removeGroupByBundle8+
removeGroupByBundle(bundle: BundleOption, groupName: string): Promise<void>
Removes notifications under a notification group of a specified application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
groupName | string | Yes | Name of the notification group. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let bundleOption: Notification.BundleOption = {bundle: "Bundle"};
let groupName: string = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("removeGroupByBundle success");
}).catch((err: Base.BusinessError) => {
console.error(`removeGroupByBundle failed, code is ${err}`);
});
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback<void>): void
Sets the DND time. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | DoNotDisturbDate | Yes | DND time to set. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let setDoNotDisturbDateCallback = (err: Base.BusinessError) => {
if (err) {
console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
} else {
console.info("setDoNotDisturbDate success");
}
}
let doNotDisturbDate: Notification.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<void>
Sets the DND time. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | DoNotDisturbDate | Yes | DND time to set. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let doNotDisturbDate: Notification.DoNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("setDoNotDisturbDate success");
}).catch((err: Base.BusinessError) => {
console.error(`setDoNotDisturbDate failed, code is ${err}`);
});
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback<void>): void
Sets the DND time for a specified user. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | DoNotDisturbDate | Yes | DND time to set. |
userId | number | Yes | ID of the user for whom you want to set the DND time. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let setDoNotDisturbDateCallback = (err: Base.BusinessError) => {
if (err) {
console.info("setDoNotDisturbDate failed " + JSON.stringify(err));
} else {
console.info("setDoNotDisturbDate success");
}
}
let doNotDisturbDate: Notification.DoNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId: number = 1;
Notification.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);
Notification.setDoNotDisturbDate8+
setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise<void>
Sets the DND time for a specified user. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | DoNotDisturbDate | Yes | DND time to set. |
userId | number | Yes | ID of the user for whom you want to set the DND time. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
let doNotDisturbDate: Notification.DoNotDisturbDate = {
type: Notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
};
let userId: number = 1;
Notification.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
console.info("setDoNotDisturbDate success");
}).catch((err: Base.BusinessError) => {
console.error(`setDoNotDisturbDate failed, code is ${err}`);
});
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(callback: AsyncCallback<DoNotDisturbDate>): void
Obtains the DND time. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<DoNotDisturbDate> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: Notification.DoNotDisturbDate) => {
if (err) {
console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
} else {
console.info("getDoNotDisturbDate success");
}
}
Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(): Promise<DoNotDisturbDate>
Obtains the DND time. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Return value
Type | Description |
---|---|
Promise<DoNotDisturbDate> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.getDoNotDisturbDate().then((data: Notification.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getDoNotDisturbDate failed, code is ${err}`);
});
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(userId: number, callback: AsyncCallback<DoNotDisturbDate>): void
Obtains the DND time of a specified user. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<DoNotDisturbDate> | Yes | Callback used to return the result. |
userId | number | Yes | User ID. |
Example
import Base from '@ohos.base';
let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: Notification.DoNotDisturbDate) => {
if (err) {
console.info("getDoNotDisturbDate failed " + JSON.stringify(err));
} else {
console.info("getDoNotDisturbDate success");
}
}
let userId: number = 1;
Notification.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);
Notification.getDoNotDisturbDate8+
getDoNotDisturbDate(userId: number): Promise<DoNotDisturbDate>
Obtains the DND time of a specified user. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
userId | number | Yes | User ID. |
Return value
Type | Description |
---|---|
Promise<DoNotDisturbDate> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let userId: number = 1;
Notification.getDoNotDisturbDate(userId).then((data: Notification.DoNotDisturbDate) => {
console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getDoNotDisturbDate failed, code is ${err}`);
});
Notification.supportDoNotDisturbMode8+
supportDoNotDisturbMode(callback: AsyncCallback<boolean>): void
Checks whether DND mode is supported. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let supportDoNotDisturbModeCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("supportDoNotDisturbMode failed " + JSON.stringify(err));
} else {
console.info("supportDoNotDisturbMode success");
}
}
Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
Notification.supportDoNotDisturbMode8+
supportDoNotDisturbMode(): Promise<boolean>
Checks whether DND mode is supported. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.supportDoNotDisturbMode().then((data: boolean) => {
console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`supportDoNotDisturbMode failed, code is ${err}`);
});
Notification.isSupportTemplate8+
isSupportTemplate(templateName: string, callback: AsyncCallback<boolean>): void
Checks whether a specified template exists. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
templateName | string | Yes | Template name. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let templateName: string = 'process';
function isSupportTemplateCallback(err: Base.BusinessError, data: boolean) {
if (err) {
console.info("isSupportTemplate failed " + JSON.stringify(err));
} else {
console.info("isSupportTemplate success");
}
}
Notification.isSupportTemplate(templateName, isSupportTemplateCallback);
Notification.isSupportTemplate8+
isSupportTemplate(templateName: string): Promise<boolean>
Checks whether a specified template exists. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
templateName | string | Yes | Template name. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let templateName: string = 'process';
Notification.isSupportTemplate(templateName).then((data: boolean) => {
console.info("isSupportTemplate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isSupportTemplate failed, code is ${err}`);
});
Notification.requestEnableNotification8+
requestEnableNotification(callback: AsyncCallback<void>): void
Requests notification to be enabled for this application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let requestEnableNotificationCallback = (err: Base.BusinessError) => {
if (err) {
console.info("requestEnableNotification failed " + JSON.stringify(err));
} else {
console.info("requestEnableNotification success");
}
};
Notification.requestEnableNotification(requestEnableNotificationCallback);
Notification.requestEnableNotification8+
requestEnableNotification(): Promise<void>
Requests notification to be enabled for this application. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import Base from '@ohos.base';
Notification.requestEnableNotification().then(() => {
console.info("requestEnableNotification success");
}).catch((err: Base.BusinessError) => {
console.error(`requestEnableNotification failed, code is ${err}`);
});
Notification.enableDistributed8+
enableDistributed(enable: boolean, callback: AsyncCallback<void>): void
Sets whether this device supports distributed notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
enable | boolean | Yes | Whether the device supports distributed notifications. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let enabledNotificationCallback = (err: Base.BusinessError) => {
if (err) {
console.info("enableDistributed failed " + JSON.stringify(err));
} else {
console.info("enableDistributed success");
}
};
let enable: boolean = true;
Notification.enableDistributed(enable, enabledNotificationCallback);
Notification.enableDistributed8+
enableDistributed(enable: boolean): Promise<void>
Sets whether this device supports distributed notifications. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
enable | boolean | Yes | Whether the device supports distributed notifications. |
Example
import Base from '@ohos.base';
let enable: boolean = true;
Notification.enableDistributed(enable).then(() => {
console.info("enableDistributed success");
}).catch((err: Base.BusinessError) => {
console.error(`enableDistributed failed, code is ${err}`);
});
Notification.isDistributedEnabled8+
isDistributedEnabled(callback: AsyncCallback<boolean>): void
Checks whether this device supports distributed notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let isDistributedEnabledCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("isDistributedEnabled failed " + JSON.stringify(err));
} else {
console.info("isDistributedEnabled success " + JSON.stringify(data));
}
};
Notification.isDistributedEnabled(isDistributedEnabledCallback);
Notification.isDistributedEnabled8+
isDistributedEnabled(): Promise<boolean>
Checks whether this device supports distributed notifications. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.isDistributedEnabled().then((data: boolean) => {
console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isDistributedEnabled failed, code is ${err}`);
});
Notification.enableDistributedByBundle8+
enableDistributedByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>): void
Sets whether a specified application supports distributed notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Bundle information of the application. |
enable | boolean | Yes | Whether the device supports distributed notifications. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let enableDistributedByBundleCallback = (err: Base.BusinessError) => {
if (err) {
console.info("enableDistributedByBundle failed " + JSON.stringify(err));
} else {
console.info("enableDistributedByBundle success");
}
};
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
let enable: boolean = true;
Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundleCallback);
Notification.enableDistributedByBundle8+
enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise<void>
Sets whether a specified application supports distributed notifications. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Application bundle. |
enable | boolean | Yes | Whether the device supports distributed notifications. |
Example
import Base from '@ohos.base';
let enable: boolean = true;
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.enableDistributedByBundle(bundle, enable).then(() => {
console.info("enableDistributedByBundle success");
}).catch((err: Base.BusinessError) => {
console.error(`enableDistributedByBundle failed, code is ${err}`);
});
Notification.isDistributedEnabledByBundle8+
isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback<boolean>): void
Obtains whether an application supports distributed notifications based on the bundle. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Application bundle. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let isDistributedEnabledByBundleCallback = (err: Base.BusinessError, data: boolean) => {
if (err) {
console.info("isDistributedEnabledByBundle failed " + JSON.stringify(err));
} else {
console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
}
};
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);
Notification.isDistributedEnabledByBundle8+
isDistributedEnabledByBundle(bundle: BundleOption): Promise<boolean>
Checks whether a specified application supports distributed notifications. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | BundleOption | Yes | Application bundle. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. |
Example
import Base from '@ohos.base';
let bundle: Notification.BundleOption = {
bundle: "bundleName1",
};
Notification.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`isDistributedEnabledByBundle failed, code is ${err}`);
});
Notification.getDeviceRemindType8+
getDeviceRemindType(callback: AsyncCallback<DeviceRemindType>): void
Obtains the notification reminder type. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<DeviceRemindType> | Yes | Callback used to return the result. |
Example
import Base from '@ohos.base';
let getDeviceRemindTypeCallback = (err: Base.BusinessError, data: Notification.DeviceRemindType) => {
if (err) {
console.info("getDeviceRemindType failed " + JSON.stringify(err));
} else {
console.info("getDeviceRemindType success");
}
};
Notification.getDeviceRemindType(getDeviceRemindTypeCallback);
Notification.getDeviceRemindType8+
getDeviceRemindType(): Promise<DeviceRemindType>
Obtains the notification reminder type. This API uses a promise to return the result.
System capability: SystemCapability.Notification.Notification
Required permissions: ohos.permission.NOTIFICATION_CONTROLLER
System API: This is a system API and cannot be called by third-party applications.
Return value
Type | Description |
---|---|
Promise<DeviceRemindType> | Promise used to return the result. |
Example
import Base from '@ohos.base';
Notification.getDeviceRemindType().then((data: Notification.DeviceRemindType) => {
console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
console.error(`getDeviceRemindType failed, code is ${err}`);
});
SubscribeCallbackData
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
request | NotificationRequest | Yes | No | Notification content. |
sortingMap | NotificationSortingMap | Yes | No | Notification sorting information. |
reason | number | Yes | No | Reason for deletion. |
sound | string | Yes | No | Sound used for notification. |
vibrationValues | Array<number> | Yes | No | Vibration used for notification. |
EnabledNotificationCallbackData8+
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
bundle | string | Yes | No | Bundle name of the application. |
uid | number | Yes | No | UID of the application. |
enable | boolean | Yes | No | Notification enabled status of the application. |
DoNotDisturbDate8+ deprecated
System capability: SystemCapability.Notification.Notification
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use notificationManager.DoNotDisturbDate instead.
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
type | DoNotDisturbType | Yes | Yes | DND time type. |
begin | Date | Yes | Yes | DND start time. |
end | Date | Yes | Yes | DND end time. |
DoNotDisturbType8+ deprecated
System capability: SystemCapability.Notification.Notification
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use notificationManager.DoNotDisturbType instead.
System API: This is a system API and cannot be called by third-party applications.
Name | Value | Description |
---|---|---|
TYPE_NONE | 0 | Non-DND. |
TYPE_ONCE | 1 | One-shot DND at the specified time segment (only considering the hour and minute). |
TYPE_DAILY | 2 | Daily DND at the specified time segment (only considering the hour and minute). |
TYPE_CLEARLY | 3 | DND at the specified time segment (considering the year, month, day, hour, and minute). |
ContentType
System capability: SystemCapability.Notification.Notification
Name | Value | Description |
---|---|---|
NOTIFICATION_CONTENT_BASIC_TEXT | NOTIFICATION_CONTENT_BASIC_TEXT | Normal text notification. |
NOTIFICATION_CONTENT_LONG_TEXT | NOTIFICATION_CONTENT_LONG_TEXT | Long text notification. |
NOTIFICATION_CONTENT_PICTURE | NOTIFICATION_CONTENT_PICTURE | Picture-attached notification. |
NOTIFICATION_CONTENT_CONVERSATION | NOTIFICATION_CONTENT_CONVERSATION | Conversation notification. |
NOTIFICATION_CONTENT_MULTILINE | NOTIFICATION_CONTENT_MULTILINE | Multi-line text notification. |
SlotLevel
System capability: SystemCapability.Notification.Notification
Name | Value | Description |
---|---|---|
LEVEL_NONE | 0 | The notification function is disabled. |
LEVEL_MIN | 1 | The notification function is enabled, but the notification icon is not displayed in the status bar, with no banner or alert tone. |
LEVEL_LOW | 2 | The notification function is enabled, and the notification icon is displayed in the status bar, with no banner or alert tone. |
LEVEL_DEFAULT | 3 | The notification feature is enabled, and the notification icon is displayed in the status bar, with an alert tone but no banner. |
LEVEL_HIGH | 4 | The notification feature is enabled, and the notification icon is displayed in the status bar, with an alert tone and banner. |
BundleOptiondeprecated
System capability: SystemCapability.Notification.Notification
NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use notificationManager.BundleOption instead.
Name | Type | Mandatory | Description |
---|---|---|---|
bundle | string | Yes | Bundle information of the application. |
uid | number | No | User ID. The default value is 0. |
NotificationKeydeprecated
System capability: SystemCapability.Notification.Notification
NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use notificationManager.NotificationKey instead.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
id | number | Yes | Yes | Notification ID. |
label | string | Yes | Yes | Notification label. |
SlotType
System capability: SystemCapability.Notification.Notification
Name | Value | Description |
---|---|---|
UNKNOWN_TYPE | 0 | Unknown type. |
SOCIAL_COMMUNICATION | 1 | Notification slot for social communication. |
SERVICE_INFORMATION | 2 | Notification slot for service information. |
CONTENT_INFORMATION | 3 | Notification slot for content consultation. |
OTHER_TYPES | 0xFFFF | Notification slot for other purposes. |
NotificationActionButton
Describes the button displayed in the notification.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
title | string | Yes | Yes | Button title. |
wantAgent | WantAgent | Yes | Yes | WantAgent of the button. |
extras | { [key: string]: any } | Yes | Yes | Extra information of the button. |
userInput8+ | NotificationUserInput | Yes | Yes | User input object. |
NotificationBasicContent
Describes the normal text notification.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
title | string | Yes | Yes | Notification title. |
text | string | Yes | Yes | Notification content. |
additionalText | string | Yes | Yes | Additional information of the notification. |
NotificationLongTextContent
Describes the long text notification.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
title | string | Yes | Yes | Notification title. |
text | string | Yes | Yes | Notification content. |
additionalText | string | Yes | Yes | Additional information of the notification. |
longText | string | Yes | Yes | Long text of the notification. |
briefText | string | Yes | Yes | Brief text of the notification. |
expandedTitle | string | Yes | Yes | Title of the notification in the expanded state. |
NotificationMultiLineContent
Describes the multi-line text notification.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
title | string | Yes | Yes | Notification title. |
text | string | Yes | Yes | Notification content. |
additionalText | string | Yes | Yes | Additional information of the notification. |
briefText | string | Yes | Yes | Brief text of the notification. |
longTitle | string | Yes | Yes | Title of the notification in the expanded state. |
lines | Array<string> | Yes | Yes | Multi-line text of the notification. |
NotificationPictureContent
Describes the picture-attached notification.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
title | string | Yes | Yes | Notification title. |
text | string | Yes | Yes | Notification content. |
additionalText | string | Yes | Yes | Additional information of the notification. |
briefText | string | Yes | Yes | Brief text of the notification. |
expandedTitle | string | Yes | Yes | Title of the notification in the expanded state. |
picture | image.PixelMap | Yes | Yes | Picture attached to the notification. |
NotificationContent
Describes the notification content.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
contentType | ContentType | Yes | Yes | Notification content type. |
normal | NotificationBasicContent | Yes | Yes | Normal text. |
longText | NotificationLongTextContent | Yes | Yes | Long text. |
multiLine | NotificationMultiLineContent | Yes | Yes | Multi-line text. |
picture | NotificationPictureContent | Yes | Yes | Picture-attached. |
NotificationFlagStatus8+
Describes the notification flag status.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Value | Description |
---|---|---|
TYPE_NONE | 0 | The default flag is used. |
TYPE_OPEN | 1 | The notification flag is enabled. |
TYPE_CLOSE | 2 | The notification flag is disabled. |
NotificationFlags8+
Enumerates notification flags.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
soundEnabled | NotificationFlagStatus | Yes | No | Whether to enable the sound alert for the notification. |
vibrationEnabled | NotificationFlagStatus | Yes | No | Whether to enable vibration for the notification. |
NotificationRequest
Describes the notification request.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
content | NotificationContent | Yes | Yes | Notification content. |
id | number | Yes | Yes | Notification ID. |
slotType | SlotType | Yes | Yes | Slot type. |
isOngoing | boolean | Yes | Yes | Whether the notification is an ongoing notification. |
isUnremovable | boolean | Yes | Yes | Whether the notification can be removed. |
deliveryTime | number | Yes | Yes | Time when the notification is sent. |
tapDismissed | boolean | Yes | Yes | Whether the notification is automatically cleared. |
autoDeletedTime | number | Yes | Yes | Time when the notification is automatically cleared. |
wantAgent | WantAgent | Yes | Yes | WantAgent instance to which the notification will be redirected after being clicked. |
extraInfo | {[key: string]: any} | Yes | Yes | Extended parameters. |
color | number | Yes | Yes | Background color of the notification. Not supported currently. |
colorEnabled | boolean | Yes | Yes | Whether the notification background color is enabled. Not supported currently. |
isAlertOnce | boolean | Yes | Yes | Whether the notification triggers an alert only once. |
isStopwatch | boolean | Yes | Yes | Whether to display the stopwatch. |
isCountDown | boolean | Yes | Yes | Whether to display the countdown time. |
isFloatingIcon | boolean | Yes | Yes | Whether the notification is displayed as a floating icon in the status bar. |
label | string | Yes | Yes | Notification label. |
badgeIconStyle | number | Yes | Yes | Notification badge type. |
showDeliveryTime | boolean | Yes | Yes | Whether to display the time when the notification is delivered. |
actionButtons | Array<NotificationActionButton> | Yes | Yes | Buttons in the notification. Up to two buttons are allowed. |
smallIcon | image.PixelMap | Yes | Yes | Small notification icon. This field is optional, and the icon size cannot exceed 30 KB. |
largeIcon | image.PixelMap | Yes | Yes | Large notification icon. This field is optional, and the icon size cannot exceed 30 KB. |
creatorBundleName | string | Yes | No | Name of the bundle that creates the notification. |
creatorUid | number | Yes | No | UID used for creating the notification. |
creatorPid | number | Yes | No | PID used for creating the notification. |
creatorUserId8+ | number | Yes | No | ID of the user who creates the notification. |
hashCode | string | Yes | No | Unique ID of the notification. |
classification | string | Yes | Yes | Notification category. System API: This is a system API and cannot be called by third-party applications. |
groupName8+ | string | Yes | Yes | Notification group name. |
template8+ | NotificationTemplate | Yes | Yes | Notification template. |
isRemoveAllowed8+ | boolean | Yes | No | Whether the notification can be removed. System API: This is a system API and cannot be called by third-party applications. |
source8+ | number | Yes | No | Notification source. System API: This is a system API and cannot be called by third-party applications. |
distributedOption8+ | DistributedOptions | Yes | Yes | Distributed notification options. |
deviceId8+ | string | Yes | No | Device ID of the notification source. System API: This is a system API and cannot be called by third-party applications. |
notificationFlags8+ | NotificationFlags | Yes | No | Notification flags. |
removalWantAgent9+ | WantAgent | Yes | Yes | WantAgent instance to which the notification will be redirected when it is removed. |
badgeNumber9+ | number | Yes | Yes | Number of notifications displayed on the application icon. |
DistributedOptions8+
Describes distributed notifications options.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
isDistributed | boolean | Yes | Yes | Whether the notification is a distributed notification. |
supportDisplayDevices | Array<string> | Yes | Yes | List of the devices to which the notification can be synchronized. |
supportOperateDevices | Array<string> | Yes | Yes | List of the devices on which the notification can be opened. |
remindType | number | Yes | No | Notification reminder type. System API: This is a system API and cannot be called by third-party applications. |
NotificationSlot
Describes the notification slot.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
type | SlotType | Yes | Yes | Slot type. |
level | number | Yes | Yes | Notification level. If this parameter is not set, the default value is used based on the notification slot type. |
desc | string | Yes | Yes | Notification slot description. |
badgeFlag | boolean | Yes | Yes | Whether to display the badge. |
bypassDnd | boolean | Yes | Yes | Whether to bypass DND mode in the system. |
lockscreenVisibility | number | Yes | Yes | Mode for displaying the notification on the lock screen. |
vibrationEnabled | boolean | Yes | Yes | Whether vibration is enabled for the notification. |
sound | string | Yes | Yes | Notification alert tone. |
lightEnabled | boolean | Yes | Yes | Whether the indicator blinks for the notification. |
lightColor | number | Yes | Yes | Indicator color of the notification. |
vibrationValues | Array<number> | Yes | Yes | Vibration mode of the notification. |
enabled9+ | boolean | Yes | No | Whether the notification slot is enabled. |
NotificationSorting
Provides sorting information of active notifications.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
slot | NotificationSlot | Yes | No | Notification slot content. |
hashCode | string | Yes | No | Unique ID of the notification. |
ranking | number | Yes | No | Notification sequence number. |
NotificationSortingMap
Provides sorting information of active notifications in all subscribed notifications.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
sortings | {[key: string]: NotificationSorting} | Yes | No | Array of notification sorting information. |
sortedHashCode | Array<string> | Yes | No | Array of unique notification IDs. |
NotificationSubscribeInfo
Provides the information about the publisher for notification subscription.
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
bundleNames | Array<string> | Yes | Yes | Bundle names of the applications whose notifications are to be subscribed to. |
userId | number | Yes | Yes | User whose notifications are to be subscribed to. You can obtain the user ID through getCurrentOsAccount. |
NotificationTemplate8+
Describes the notification template.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
name | string | Yes | Yes | Template name. |
data | {[key:string]: Object} | Yes | Yes | Template data. |
NotificationUserInput8+
Provides the notification user input.
System capability: SystemCapability.Notification.Notification
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
inputKey | string | Yes | Yes | Key to identify the user input. |
DeviceRemindType8+ deprecated
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use notificationManager.DeviceRemindType instead.
Name | Value | Description |
---|---|---|
IDLE_DONOT_REMIND | 0 | The device is not in use. No notification is required. |
IDLE_REMIND | 1 | The device is not in use. |
ACTIVE_DONOT_REMIND | 2 | The device is in use. No notification is required. |
ACTIVE_REMIND | 3 | The device is in use. |
SourceType8+ deprecated
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use notificationManager.SourceType instead.
Name | Value | Description |
---|---|---|
TYPE_NORMAL | 0 | Normal notification. |
TYPE_CONTINUOUS | 1 | Continuous notification. |
TYPE_TIMER | 2 | Timed notification. |
RemoveReason deprecated
System capability: SystemCapability.Notification.Notification
System API: This is a system API and cannot be called by third-party applications.
NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use notificationManager.RemoveReason instead.
Name | Value | Description |
---|---|---|
CLICK_REASON_REMOVE | 1 | The notification is removed after a click on it. |
CANCEL_REASON_REMOVE | 2 | The notification is removed by the user. |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙System Common Events (To Be Deprecated Soon)
harmony 鸿蒙System Common Events
harmony 鸿蒙API Reference Document Description
harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)
harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)
harmony 鸿蒙@ohos.bundle (Bundle)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦