@ohos.notificationManager (NotificationManager)

The notificationManager module provides notification management capabilities, covering notifications, notification slots, notification enabled status, and notification badge status.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import notificationManager from '@ohos.notificationManager';

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

// publish callback
let publishCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("publish success");
    }
}
// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};
notificationManager.publish(notificationRequest, publishCallback);

notificationManager.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.|

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};
notificationManager.publish(notificationRequest).then(() => {
	console.info("publish success");
}).catch((err: Base.BusinessError) => {
    console.error(`publish fail: ${JSON.stringify(err)}`);
});

notificationManager.publish

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600008	The user is not exist.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

// publish callback
let publishCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("publish success");
    }
}
// User ID
let userId: number = 1;
// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};
notificationManager.publish(notificationRequest, userId, publishCallback);

notificationManager.publish

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600008	The user is not exist.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

let notificationRequest: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};

let userId: number = 1;

notificationManager.publish(notificationRequest, userId).then(() => {
	console.info("publish success");
}).catch((err: Base.BusinessError) => {
    console.error(`publish fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600007	The notification is not exist.

Example

import Base from '@ohos.base';

// cancel callback
let cancelCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("cancel success");
    }
}
notificationManager.cancel(0, "label", cancelCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600007	The notification is not exist.

Example

import Base from '@ohos.base';

notificationManager.cancel(0).then(() => {
	console.info("cancel success");
}).catch((err: Base.BusinessError) => {
    console.error(`cancel fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600007	The notification is not exist.

Example

import Base from '@ohos.base';

// cancel callback
let cancelCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`cancel failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("cancel success");
    }
}
notificationManager.cancel(0, cancelCallback);

notificationManager.cancelAll

cancelAll(callback: AsyncCallback<void>): void

Cancels all notifications. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

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): void => {
    if (err) {
        console.error(`cancelAll failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("cancelAll success");
    }
}
notificationManager.cancelAll(cancelAllCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.cancelAll().then(() => {
	console.info("cancelAll success");
}).catch((err: Base.BusinessError) => {
    console.error(`cancelAll fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

// addSlot callback
let addSlotCallBack = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("addSlot success");
    }
}
// NotificationSlot object
let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot, addSlotCallBack);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

// NotificationSlot object
let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.addSlot(notificationSlot).then(() => {
	console.info("addSlot success");
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

// addSlot callback
let addSlotCallBack = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`addSlot failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("addSlot success");
    }
}
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
	console.info("addSlot success");
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

// addSlots callback
let addSlotsCallBack = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`addSlots failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("addSlots success");
    }
}
// NotificationSlot object
let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;

notificationManager.addSlots(notificationSlotArray, addSlotsCallBack);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

// NotificationSlot object
let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
// NotificationSlotArray object
let notificationSlotArray: notificationManager.NotificationSlot[] = new Array();
notificationSlotArray[0] = notificationSlot;

notificationManager.addSlots(notificationSlotArray).then(() => {
	console.info("addSlots success");
}).catch((err: Base.BusinessError) => {
    console.error(`addSlot fail: ${JSON.stringify(err)}`);
});

notificationManager.getSlot

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

Obtains 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<NotificationSlot>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

// getSlot callback
let getSlotCallback = (err: Base.BusinessError, data: notificationManager.NotificationSlot): void => {
    if (err) {
        console.error(`getSlot failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getSlot success, data is ${JSON.stringify(data)}`);
    }
}
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;

notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
    console.info("getSlot success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getSlot fail: ${JSON.stringify(err)}`);
});

notificationManager.getSlots

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

Obtains all notification slots of this application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Parameters

For details about the error codes, see Notification Error Codes.

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<NotificationSlot>>	Yes	Callback used to return all notification slots of the current application.

Error codes

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

// getSlots callback
let getSlotsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>): void => {
  if (err) {
    console.error(`getSlots failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`getSlots success, data is ${JSON.stringify(data)}`);
  }
}
notificationManager.getSlots(getSlotsCallback);

notificationManager.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 all notification slots of the current application.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
	console.info("getSlots success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getSlots fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

// removeSlot callback
let removeSlotCallback = (err: Base.BusinessError): void => {
  if (err) {
    console.error(`removeSlot failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("removeSlot success");
  }
}
let slotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType, removeSlotCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
	console.info("removeSlot success");
}).catch((err: Base.BusinessError) => {
    console.error(`removeSlot fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let removeAllCallBack = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`removeAllSlots failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("removeAllSlots success");
    }
}
notificationManager.removeAllSlots(removeAllCallBack);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.removeAllSlots().then(() => {
	console.info("removeAllSlots success");
}).catch((err: Base.BusinessError) => {
    console.error(`removeAllSlots fail: ${JSON.stringify(err)}`);
});

notificationManager.setNotificationEnable

setNotificationEnable(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 of the application.
enable	boolean	Yes	Whether to enable notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let setNotificationEnableCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setNotificationEnableCallback failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setNotificationEnableCallback success");
    }
}
let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false, setNotificationEnableCallback);

notificationManager.setNotificationEnable

setNotificationEnable(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 of the application.
enable	boolean	Yes	Whether to enable notification.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.setNotificationEnable(bundle, false).then(() => {
	console.info("setNotificationEnable success");
}).catch((err: Base.BusinessError) => {
    console.error(`setNotificationEnable fail: ${JSON.stringify(err)}`);
});

notificationManager.isNotificationEnabled

isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>): void

Checks whether notification is enabled 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 of the application.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
    }
}

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

notificationManager.isNotificationEnabled(bundle, isNotificationEnabledCallback);

notificationManager.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 of the application.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.isNotificationEnabled(bundle).then((data: boolean) => {
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
});

notificationManager.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<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
    }
}

notificationManager.isNotificationEnabled(isNotificationEnabledCallback);

notificationManager.isNotificationEnabled

isNotificationEnabled(): Promise<boolean>

Checks whether notification is enabled for the current 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.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.isNotificationEnabled().then((data: boolean) => {
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
});

notificationManager.isNotificationEnabled

isNotificationEnabled(userId: number, callback: AsyncCallback<boolean>): void

Checks whether notification is enabled 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<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

let isNotificationEnabledCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
    }
}

let userId: number = 1;

notificationManager.isNotificationEnabled(userId, isNotificationEnabledCallback);

notificationManager.isNotificationEnabled

isNotificationEnabled(userId: number): Promise<boolean>

Checks whether notification is enabled 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.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist..

Example

import Base from '@ohos.base';

let userId: number = 1;

notificationManager.isNotificationEnabled(userId).then((data: boolean) => {
	console.info("isNotificationEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationEnabled fail: ${JSON.stringify(err)}`);
});

notificationManager.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 of the application.
enable	boolean	Yes	Whether to enable notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let displayBadgeCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`displayBadge failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("displayBadge success");
    }
}
let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false, displayBadgeCallback);

notificationManager.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 of the application.
enable	boolean	Yes	Whether to enable notification.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.displayBadge(bundle, false).then(() => {
	console.info("displayBadge success");
}).catch((err: Base.BusinessError) => {
    console.error(`displayBadge fail: ${JSON.stringify(err)}`);
});

notificationManager.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 of the application.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let isBadgeDisplayedCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isBadgeDisplayed failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`isBadgeDisplayed success, data is ${JSON.stringify(data)}`);
    }
}
let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);

notificationManager.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 of the application.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
};

notificationManager.isBadgeDisplayed(bundle).then((data: boolean) => {
	console.info("isBadgeDisplayed success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isBadgeDisplayed fail: ${JSON.stringify(err)}`);
});

notificationManager.setBadgeNumber¹⁰⁺

setBadgeNumber(badgeNumber: number): Promise<void>

Sets the notification badge number. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
badgeNumber	number	Yes	Notification badge number to set.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

let badgeNumber: number = 10;

notificationManager.setBadgeNumber(badgeNumber).then(() => {
	console.info("displayBadge success");
}).catch((err: Base.BusinessError) => {
    console.error(`displayBadge fail: ${JSON.stringify(err)}`);
});

notificationManager.setBadgeNumber¹⁰⁺

setBadgeNumber(badgeNumber: number, callback: AsyncCallback<void>): void

Sets the notification badge number. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
badgeNumber	number	Yes	Notification badge number to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

let setBadgeNumberCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.info(`displayBadge failed code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("displayBadge success");
    }
}

let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);

notificationManager.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 of the application.
slot	NotificationSlot	Yes	Notification slot.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let setSlotByBundleCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setSlotByBundle success");
    }
}
let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};
notificationManager.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);

notificationManager.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 of the application.
slot	NotificationSlot	Yes	Notification slot.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

let notificationSlot: notificationManager.NotificationSlot = {
    type: notificationManager.SlotType.SOCIAL_COMMUNICATION
};

notificationManager.setSlotByBundle(bundle, notificationSlot).then(() => {
	console.info("setSlotByBundle success");
}).catch((err: Base.BusinessError) => {
    console.error(`setSlotByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.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 of the application.
callback	AsyncCallback<Array<NotificationSlot>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let getSlotsByBundleCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationSlot>): void => {
    if (err) {
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getSlotsByBundle success, data is ${JSON.stringify(data)}`);
    }
}
let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};
notificationManager.getSlotsByBundle(bundle, getSlotsByBundleCallback);

notificationManager.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 of the application.

Return value

Type	Description
Promise<Array<NotificationSlot>>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

notificationManager.getSlotsByBundle(bundle).then((data: Array<notificationManager.NotificationSlot>) => {
	console.info("getSlotsByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getSlotsByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.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 of the application.
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let getSlotNumByBundleCallback = (err: Base.BusinessError, data: number): void => {
    if (err) {
        console.error(`getSlotByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getSlotNumByBundle success data is ${JSON.stringify(data)}`);
    }
}

let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
};

notificationManager.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);

notificationManager.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 of the application.

Return value

Type	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
};

notificationManager.getSlotNumByBundle(bundle).then((data: number) => {
	console.info("getSlotNumByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getSlotsByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let getAllActiveNotificationsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>): void => {
    if (err) {
        console.error(`getAllActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getAllActiveNotifications success, data is ${JSON.stringify(data)}`);
    }
}

notificationManager.getAllActiveNotifications(getAllActiveNotificationsCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.getAllActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
	console.info("getAllActiveNotifications success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getAllActiveNotifications fail: ${JSON.stringify(err)}`);
});

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let getActiveNotificationCountCallback = (err: Base.BusinessError, data: number): void => {
    if (err) {
        console.error(`getActiveNotificationCount failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getActiveNotificationCount success, data is ${JSON.stringify(data)}`);
    }
}

notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.getActiveNotificationCount().then((data: number) => {
	console.info("getActiveNotificationCount success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getActiveNotificationCount fail: ${JSON.stringify(err)}`);
});

notificationManager.getActiveNotifications

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

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<Array<NotificationRequest>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let getActiveNotificationsCallback = (err: Base.BusinessError, data: Array<notificationManager.NotificationRequest>): void => {
    if (err) {
        console.error(`getActiveNotifications failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("getActiveNotifications success");
    }
}

notificationManager.getActiveNotifications(getActiveNotificationsCallback);

notificationManager.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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
	console.info("removeGroupByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getActiveNotificationCount fail: ${JSON.stringify(err)}`);
});

notificationManager.cancelGroup

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let cancelGroupCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`cancelGroup failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("cancelGroup success");
    }
}

let groupName: string = "GroupName";

notificationManager.cancelGroup(groupName, cancelGroupCallback);

notificationManager.cancelGroup

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let groupName: string = "GroupName";
notificationManager.cancelGroup(groupName).then(() => {
	console.info("cancelGroup success");
}).catch((err: Base.BusinessError) => {
    console.error(`cancelGroup fail: ${JSON.stringify(err)}`);
});

notificationManager.removeGroupByBundle

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let removeGroupByBundleCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`removeGroupByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("removeGroupByBundle success");
    }
}

let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";

notificationManager.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);

notificationManager.removeGroupByBundle

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundleOption: notificationManager.BundleOption = { bundle: "Bundle" };
let groupName: string = "GroupName";

notificationManager.removeGroupByBundle(bundleOption, groupName).then(() => {
	console.info("removeGroupByBundle success");
}).catch((err: Base.BusinessError) => {
    console.error(`removeGroupByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.setDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

let setDoNotDisturbDateCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
};

notificationManager.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);

notificationManager.setDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
};
notificationManager.setDoNotDisturbDate(doNotDisturbDate).then(() => {
	console.info("setDoNotDisturbDate success");
}).catch((err: Base.BusinessError) => {
    console.error(`setDoNotDisturbDate fail: ${JSON.stringify(err)}`);
});

notificationManager.setDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.
1600012	No memory space.

Example

import Base from '@ohos.base';

let setDoNotDisturbDateCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setDoNotDisturbDate success");
    }
}

let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
};

let userId: number = 1;

notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId, setDoNotDisturbDateCallback);

notificationManager.setDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.
1600012	No memory space.

Example

import Base from '@ohos.base';

let doNotDisturbDate: notificationManager.DoNotDisturbDate = {
    type: notificationManager.DoNotDisturbType.TYPE_ONCE,
    begin: new Date(),
    end: new Date(2021, 11, 15, 18, 0)
};

let userId: number = 1;

notificationManager.setDoNotDisturbDate(doNotDisturbDate, userId).then(() => {
	console.info("setDoNotDisturbDate success");
}).catch((err: Base.BusinessError) => {
    console.error(`setDoNotDisturbDate fail: ${JSON.stringify(err)}`);
});

notificationManager.getDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: notificationManager.DoNotDisturbDate): void => {
    if (err) {
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
    }
}

notificationManager.getDoNotDisturbDate(getDoNotDisturbDateCallback);

notificationManager.getDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600012	No memory space.

Example

import Base from '@ohos.base';

notificationManager.getDoNotDisturbDate().then((data: notificationManager.DoNotDisturbDate) => {
  console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getDoNotDisturbDate fail: ${JSON.stringify(err)}`);
});

notificationManager.getDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.
1600012	No memory space.

Example

import Base from '@ohos.base';

let getDoNotDisturbDateCallback = (err: Base.BusinessError, data: notificationManager.DoNotDisturbDate): void => {
    if (err) {
        console.error(`getDoNotDisturbDate failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getDoNotDisturbDate success, data is ${JSON.stringify(data)}`);
    }
}

let userId: number = 1;

notificationManager.getDoNotDisturbDate(userId, getDoNotDisturbDateCallback);

notificationManager.getDoNotDisturbDate

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.
1600012	No memory space.

Example

import Base from '@ohos.base';

let userId: number = 1;

notificationManager.getDoNotDisturbDate(userId).then((data: notificationManager.DoNotDisturbDate) => {
	console.info("getDoNotDisturbDate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getDoNotDisturbDate fail: ${JSON.stringify(err)}`);
});

notificationManager.isSupportDoNotDisturbMode

isSupportDoNotDisturbMode(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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let isSupportDoNotDisturbModeCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isSupportDoNotDisturbMode failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isSupportDoNotDisturbMode success");
    }
}

notificationManager.isSupportDoNotDisturbMode(isSupportDoNotDisturbModeCallback);

notificationManager.isSupportDoNotDisturbMode

isSupportDoNotDisturbMode(): 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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.isSupportDoNotDisturbMode().then((data: boolean) => {
	console.info("supportDoNotDisturbMode success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`supportDoNotDisturbMode fail: ${JSON.stringify(err)}`);
});

notificationManager.isSupportTemplate

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

Checks whether a specified template is supported. 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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let templateName: string = 'process';
let isSupportTemplateCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isSupportTemplate success");
    }
}

notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);

notificationManager.isSupportTemplate

isSupportTemplate(templateName: string): Promise<boolean>

Checks whether a specified template is supported. 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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let templateName: string = 'process';

notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
    console.info("isSupportTemplate success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isSupportTemplate fail: ${JSON.stringify(err)}`);
});

notificationManager.requestEnableNotification

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let requestEnableNotificationCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("requestEnableNotification success");
    }
};

notificationManager.requestEnableNotification(requestEnableNotificationCallback);

notificationManager.requestEnableNotification

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.requestEnableNotification().then(() => {
    console.info("requestEnableNotification success");
}).catch((err: Base.BusinessError) => {
    console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
});

notificationManager.requestEnableNotification¹⁰⁺

requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback<void>): void

Requests notification to be enabled for this application in a modal. This API uses an asynchronous callback to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
context	UIAbilityContext	Yes	Ability context bound to the notification dialog box.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';
import UIAbility from '@ohos.app.ability.UIAbility';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
import Want from '@ohos.app.ability.Want';

class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    let requestEnableNotificationCallback = (err: Base.BusinessError): void => {
      if (err) {
        console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
      } else {
        console.info("requestEnableNotification success");
      }
    };

    notificationManager.requestEnableNotification(this.context, requestEnableNotificationCallback);
  }
}

notificationManager.requestEnableNotification¹⁰⁺

requestEnableNotification(context: UIAbilityContext): Promise<void>

Requests notification to be enabled for this application in a modal. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
context	UIAbilityContext	Yes	Ability context bound to the notification dialog box.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';
import UIAbility from '@ohos.app.ability.UIAbility';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
import Want from '@ohos.app.ability.Want';

class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    notificationManager.requestEnableNotification(this.context).then(() => {
      console.info("requestEnableNotification success");
    }).catch((err: Base.BusinessError) => {
      console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
    });
  }
}

notificationManager.setDistributedEnable

setDistributedEnable(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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.

Example

import Base from '@ohos.base';

let setDistributedEnableCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setDistributedEnable failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setDistributedEnable success");
    }
};

let enable: boolean = true;

notificationManager.setDistributedEnable(enable, setDistributedEnableCallback);

notificationManager.setDistributedEnable

setDistributedEnable(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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.

Example

import Base from '@ohos.base';

let enable: boolean = true;

notificationManager.setDistributedEnable(enable).then(() => {
    console.info("setDistributedEnable success");
}).catch((err: Base.BusinessError) => {
    console.error(`requestEnableNotification fail: ${JSON.stringify(err)}`);
});

notificationManager.isDistributedEnabled

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.

Example

import Base from '@ohos.base';

let isDistributedEnabledCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isDistributedEnabled success " + JSON.stringify(data));
    }
};

notificationManager.isDistributedEnabled(isDistributedEnabledCallback);

notificationManager.isDistributedEnabled

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.

Example

import Base from '@ohos.base';

notificationManager.isDistributedEnabled()
.then((data: boolean) => {
    console.info("isDistributedEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isDistributedEnabled fail: ${JSON.stringify(err)}`);
});

notificationManager.setDistributedEnableByBundle

setDistributedEnableByBundle(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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let setDistributedEnableByBundleCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setDistributedEnableByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("enableDistributedByBundle success");
    }
};

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

let enable: boolean = true;

notificationManager.setDistributedEnableByBundle(bundle, enable, setDistributedEnableByBundleCallback);

notificationManager.setDistributedEnableByBundle

setDistributedEnableByBundle(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	Bundle information of the application.
enable	boolean	Yes	Whether the device supports distributed notifications.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

let enable: boolean = true;

notificationManager.setDistributedEnableByBundle(bundle, enable).then(() => {
    console.info("setDistributedEnableByBundle success");
}).catch((err: Base.BusinessError) => {
    console.error(`setDistributedEnableByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.isDistributedEnabledByBundle

isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback<boolean>): void

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	Bundle information of the application.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let isDistributedEnabledByBundleCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isDistributedEnabledByBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isDistributedEnabledByBundle success" + JSON.stringify(data));
    }
};

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

notificationManager.isDistributedEnabledByBundle(bundle, isDistributedEnabledByBundleCallback);

notificationManager.isDistributedEnabledByBundle

isDistributedEnabledByBundle(bundle: BundleOption): Promise<boolean>

Checks 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	Bundle information of the application.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600010	Distributed operation failed.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

let bundle: notificationManager.BundleOption = {
    bundle: "bundleName1",
};

notificationManager.isDistributedEnabledByBundle(bundle).then((data: boolean) => {
    console.info("isDistributedEnabledByBundle success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isDistributedEnabledByBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.getDeviceRemindType

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

let getDeviceRemindTypeCallback = (err: Base.BusinessError, data: notificationManager.DeviceRemindType): void => {
    if (err) {
        console.error(`getDeviceRemindType failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`getDeviceRemindType success, data is ${JSON.stringify(data)}`);
    }
};

notificationManager.getDeviceRemindType(getDeviceRemindTypeCallback);

notificationManager.getDeviceRemindType

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.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.

Example

import Base from '@ohos.base';

notificationManager.getDeviceRemindType().then((data: notificationManager.DeviceRemindType) => {
    console.info("getDeviceRemindType success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`getDeviceRemindType fail: ${JSON.stringify(err)}`);
});

notificationManager.publishAsBundle

publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void

Publishes a notification through the reminder agent. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_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.
representativeBundle	string	Yes	Bundle name of the application whose notification function is taken over by the reminder agent.
userId	number	Yes	User ID.
callback	AsyncCallback	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600008	The user is not exist.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

// publishAsBundle callback
let callback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`publishAsBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("publishAsBundle success");
    }
}
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle: string = "com.example.demo";
// User ID
let userId: number = 100;
// NotificationRequest object
let request: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};

notificationManager.publishAsBundle(request, representativeBundle, userId, callback);

notificationManager.publishAsBundle

publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise<void>

Publishes a notification through the reminder agent. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_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.
representativeBundle	string	Yes	Bundle name of the application whose notification function is taken over by the reminder agent.
userId	number	Yes	User ID.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600004	Notification is not enabled.
1600005	Notification slot is not enabled.
1600008	The user is not exist.
1600009	Over max number notifications per second.
1600012	No memory space.

Example

import Base from '@ohos.base';

// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle: string = "com.example.demo";
// User ID
let userId: number = 100;
// NotificationRequest object
let request: notificationManager.NotificationRequest = {
    id: 1,
    content: {
        contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: {
            title: "test_title",
            text: "test_text",
            additionalText: "test_additionalText"
        }
    }
};

notificationManager.publishAsBundle(request, representativeBundle, userId).then(() => {
	console.info("publishAsBundle success");
}).catch((err: Base.BusinessError) => {
    console.error(`publishAsBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.cancelAsBundle

cancelAsBundle(id: number, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void

Cancels a notification published by the reminder agent. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
id	number	Yes	Notification ID.
representativeBundle	string	Yes	Bundle name of the application whose notification function is taken over by the reminder agent.
userId	number	Yes	User ID.
callback	AsyncCallback	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600007	The notification is not exist.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

// cancelAsBundle
let cancelAsBundleCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`cancelAsBundle failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("cancelAsBundle success");
    }
}
// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle: string = "com.example.demo";
// User ID
let userId: number = 100;

notificationManager.cancelAsBundle(0, representativeBundle, userId, cancelAsBundleCallback);

notificationManager.cancelAsBundle

cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise<void>

Cancels a notification published by the reminder agent. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
id	number	Yes	Notification ID.
representativeBundle	string	Yes	Bundle name of the application whose notification function is taken over by the reminder agent.
userId	number	Yes	User ID.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600007	The notification is not exist.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

// Bundle name of the application whose notification function is taken over by the reminder agent
let representativeBundle: string = "com.example.demo";
// User ID
let userId: number = 100;

notificationManager.cancelAsBundle(0, representativeBundle, userId).then(() => {
	console.info("cancelAsBundle success");
}).catch((err: Base.BusinessError) => {
    console.error(`cancelAsBundle fail: ${JSON.stringify(err)}`);
});

notificationManager.setNotificationEnableSlot

setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback<void>): void

Sets whether to enable a specified notification slot type 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.
type	SlotType	Yes	Notification slot type.
enable	boolean	Yes	Whether to enable notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

// setNotificationEnableSlot
let setNotificationEnableSlotCallback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setNotificationEnableSlot failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setNotificationEnableSlot success");
    }
};

notificationManager.setNotificationEnableSlot(
    { bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
    true,
    setNotificationEnableSlotCallback);

notificationManager.setNotificationEnableSlot

setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise<void>

Sets whether to enable a specified notification slot type 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.
type	SlotType	Yes	Notification slot type.
enable	boolean	Yes	Whether to enable notification.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

// setNotificationEnableSlot
notificationManager.setNotificationEnableSlot(
    { bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
    true).then(() => {
        console.info("setNotificationEnableSlot success");
    }).catch((err: Base.BusinessError) => {
        console.error(`setNotificationEnableSlot fail: ${JSON.stringify(err)}`);
    });

notificationManager.isNotificationSlotEnabled

isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback<boolean>): void

Checks whether a specified notification slot type is enabled 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.
type	SlotType	Yes	Notification slot type.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

// isNotificationSlotEnabled
let getEnableSlotCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.error(`isNotificationSlotEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info(`isNotificationSlotEnabled success, data is ${JSON.stringify(data)}`);
    }
};

notificationManager.isNotificationSlotEnabled(
    { bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION,
    getEnableSlotCallback);

notificationManager.isNotificationSlotEnabled

isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise<boolean>

Checks whether a specified notification slot type 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.
type	SlotType	Yes	Notification slot type.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
17700001	The specified bundle name was not found.

Example

import Base from '@ohos.base';

// isNotificationSlotEnabled
notificationManager.isNotificationSlotEnabled({ bundle: "ohos.samples.notification", },
    notificationManager.SlotType.SOCIAL_COMMUNICATION).then((data: boolean) => {
    console.info("isNotificationSlotEnabled success, data: " + JSON.stringify(data));
}).catch((err: Base.BusinessError) => {
    console.error(`isNotificationSlotEnabled fail: ${JSON.stringify(err)}`);
});

notificationManager.setSyncNotificationEnabledWithoutApp

setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback<void>): void

Sets whether to enable the notification sync feature for devices where the application is not installed. 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
userId	number	Yes	User ID.
enable	boolean	Yes	Whether the feature is enabled.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

let userId: number = 100;
let enable: boolean = true;

let callback = (err: Base.BusinessError): void => {
    if (err) {
        console.error(`setSyncNotificationEnabledWithoutApp failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setSyncNotificationEnabledWithoutApp success");
    }
}

notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable, callback);

notificationManager.setSyncNotificationEnabledWithoutApp

setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise<void>

Sets whether to enable the notification sync feature for devices where the application is not installed. 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
userId	number	Yes	User ID.
enable	boolean	Yes	Whether the feature is enabled.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

let userId: number = 100;
let enable: boolean = true;

notificationManager.setSyncNotificationEnabledWithoutApp(userId, enable).then(() => {
    console.info('setSyncNotificationEnabledWithoutApp success');
}).catch((err: Base.BusinessError) => {
    console.error(`setSyncNotificationEnabledWithoutApp fail: ${JSON.stringify(err)}`);
});

notificationManager.getSyncNotificationEnabledWithoutApp

getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback<boolean>): void

Obtains whether the notification sync feature is enabled for devices where the application is not installed. 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
userId	number	Yes	User ID.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

let userId: number = 100;

let getSyncNotificationEnabledWithoutAppCallback = (err: Base.BusinessError, data: boolean): void => {
    if (err) {
        console.info('getSyncNotificationEnabledWithoutAppCallback, err:' + err);
    } else {
        console.info('getSyncNotificationEnabledWithoutAppCallback, data:' + data);
    }
}

notificationManager.getSyncNotificationEnabledWithoutApp(userId, getSyncNotificationEnabledWithoutAppCallback);

notificationManager.getSyncNotificationEnabledWithoutApp

getSyncNotificationEnabledWithoutApp(userId: number): Promise<boolean>

Obtains whether the notification sync feature is enabled for devices where the application is not installed. 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
userId	number	Yes	User ID.

Return value

Type	Description
Promise<boolean>	Promise used to return the result.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect service.
1600008	The user is not exist.

Example

import Base from '@ohos.base';

let userId: number = 100;

notificationManager.getSyncNotificationEnabledWithoutApp(userId).then((data: boolean) => {
  console.info('getSyncNotificationEnabledWithoutApp, data:' + data);
}).catch((err: Base.BusinessError) => {
    console.error(`getSyncNotificationEnabledWithoutApp fail: ${JSON.stringify(err)}`);
});

notificationManager.on¹⁰⁺

on(type: ‘checkNotification’, callback: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void;

Subscribes to notification events. The notification service sends the notification information in the callback to the verification program. The verification program returns the verification result to determine whether to publish the notification, for example, controlling the publish frequency of marketing notifications.

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, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed to ‘checkNotification’.
callback	(checkInfo: NotificationCheckInfo) => NotificationCheckResult	Yes	Pointer to the notification verification function.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.

Example

import Base from '@ohos.base';

let OnCheckNotification = (info : notificationManager.NotificationCheckInfo): notificationManager.NotificationCheckResult => {
    console.info(`====>OnCheckNotification info: ${JSON.stringify(info)}`);
    if(info.notificationId == 1){
        let result: notificationManager.NotificationCheckResult =  { code: 1, message: "testMsg1"};
        return result;
    } else {
        let result: notificationManager.NotificationCheckResult =   { code: 0, message: "testMsg0"};
        return result;
    }
}
try{
    notificationManager.on("checkNotification", OnCheckNotification);
} catch (error){
    console.info(`notificationManager.on error: ${JSON.stringify(error as Base.BusinessError)}`);
}

notificationManager.off¹⁰⁺

off(type: ‘checkNotification’, callback?: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void;

Unsubscribes from notification events.

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, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value is fixed to ‘checkNotification’.
callback	(checkInfo: NotificationCheckInfo) => NotificationCheckResult	No	Callback used to return the result. This parameter is left empty by default.

Error codes

For details about the error codes, see Notification Error Codes.

ID	Error Message
1600001	Internal error.

Example

import Base from '@ohos.base';

try{
    notificationManager.off("checkNotification");
} catch (error){
    console.info(`notificationManager.off error: ${JSON.stringify(error as Base.BusinessError)}`);
}

DoNotDisturbDate

System capability: SystemCapability.Notification.Notification

System API: This is a system API and cannot be called by third-party applications.

Name	Type	Mandatory	Description
type	DoNotDisturbType	Yes	DND time type.
begin	Date	Yes	DND start time.
end	Date	Yes	DND end time.

DoNotDisturbType

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	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 (not supported currently).
NOTIFICATION_CONTENT_MULTILINE	NOTIFICATION_CONTENT_MULTILINE	Multi-line text notification.

SlotLevel

System capability: SystemCapability.Notification.Notification

Name	Value	Description
LEVEL_NONE	0	Notification is disabled.
LEVEL_MIN	1	Notification is enabled, but the notification icon is not displayed in the status bar, with no banner or alert tone.
LEVEL_LOW	2	Notification is enabled, and the notification icon is displayed in the status bar, with no banner or alert tone.
LEVEL_DEFAULT	3	Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone but no banner.
LEVEL_HIGH	4	Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone and banner.

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.

DeviceRemindType

System capability: SystemCapability.Notification.Notification

System API: This is a system API and cannot be called by third-party applications.

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.

SourceType

System capability: SystemCapability.Notification.Notification

System API: This is a system API and cannot be called by third-party applications.

Name	Value	Description
TYPE_NORMAL	0	Normal notification.
TYPE_CONTINUOUS	1	Continuous notification.
TYPE_TIMER	2	Timed notification.

NotificationCheckInfo¹⁰⁺

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, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name.
notificationId	number	Yes	Notification ID.
contentType	ContentType	Yes	Notification type.

NotificationCheckResult¹⁰⁺

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, ohos.permission.NOTIFICATION_AGENT_CONTROLLER

Name	Type	Mandatory	Description
code	number	Yes	Result code. 0: display. 1: no display.
message	string	Yes	Result.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

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)