@ohos.notificationSubscribe (NotificationSubscribe) (System API)

The notificationSubscribe module provides APIs for notification subscription, notification unsubscription, subscription removal, and more. In general cases, only system applications can call these APIs.

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.

The APIs provided by this module are system APIs.

Modules to Import

import { notificationSubscribe } from '@kit.NotificationKit';

notificationSubscribe.subscribe^(deprecated)

subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>): void

Subscribes to a notification with the subscription information specified. This API uses an asynchronous callback to return the result.

Since: 9

Deprecated since: 26.0.0

Substitutes: subscribeNotification

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.
info	NotificationSubscribeInfo	Yes	Notification subscription information.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600012	No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// subscribe callback
let subscribeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("subscribe success");
  }
}
let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback: ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
// Bundle names are not verified. You need to determine the target bundle names.
let info: notificationSubscribe.NotificationSubscribeInfo = {
  bundleNames: ["bundleName1","bundleName2"]
};
notificationSubscribe.subscribe(subscriber, info, subscribeCallback);

notificationSubscribe.subscribe^(deprecated)

subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void

Subscribes to notifications of all applications under this user. This API uses an asynchronous callback to return the result.

Since: 9

Deprecated since: 26.0.0

Substitutes: subscribeNotification

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600012	No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let subscribeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("subscribe success");
  }
}
let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback: ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);

notificationSubscribe.subscribe^(deprecated)

subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise<void>

Subscribes to a notification with the subscription information specified. This API uses a promise to return the result.

Since: 9

Deprecated since: 26.0.0

Substitutes: subscribeNotification

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.
info	NotificationSubscribeInfo	No	Notification subscription information. By default, this parameter is left empty, which means to subscribe to notifications of all applications under this user.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600012	No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback: ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
notificationSubscribe.subscribe(subscriber).then(() => {
  console.info("subscribe success");
}).catch((err: BusinessError) => {
  console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
});

notificationSubscribe.subscribeNotification

subscribeNotification(subscriber: NotificationSubscriber): Promise<void>

Subscribes to notifications. After the subscription, the new message is received through the callback in the subscriber. This API uses a promise to return the result.

Since: 26.0.0

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

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_SYSTEM_SUBSCRIBER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error. Possible cause: 1.IPC communication failed. 2.Memory operation error. 3.The user does not exist.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback: ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
notificationSubscribe.subscribeNotification(subscriber).then(() => {
  console.info("subscribeNotification success");
}).catch((err: BusinessError) => {
  console.error(`subscribeNotification failed, code is ${err.code}, message is ${err.message}`);
});

notificationSubscribe.subscribeNotification

subscribeNotification(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo): Promise<void>

Subscribes to notifications. After the subscription, the new message is received through the callback in the subscriber. This API uses a promise to return the result.

Since: 26.0.0

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

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_SYSTEM_SUBSCRIBER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.
info	NotificationSubscribeInfo	Yes	Notification subscription information.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error. Possible cause: 1.IPC communication failed. 2.Memory operation error. 3.The user does not exist.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback: ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
let subscribeInfo: notificationSubscribe.NotificationSubscribeInfo = {
  bundleNames: ["bundleName1", "bundleName2"],
}
notificationSubscribe.subscribeNotification(subscriber, subscribeInfo).then(() => {
  console.info("subscribeNotification success");
}).catch((err: BusinessError) => {
  console.error(`subscribeNotification failed, code is ${err.code}, message is ${err.message}`);
});

notificationSubscribe.subscribeSelf¹¹⁺

subscribeSelf(subscriber: NotificationSubscriber): Promise<void>

Subscribes to notifications of the application and specifies subscription information. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.

Return value

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

Error codes

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

ID	Error Message
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600012	No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let onConsumeCallback = (data: notificationSubscribe.SubscribeCallbackData) => {
  console.info(`Consume callback:  ${JSON.stringify(data)}`);
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onConsume: onConsumeCallback
};
notificationSubscribe.subscribeSelf(subscriber).then(() => {
  console.info("subscribeSelf success");
}).catch((err: BusinessError) => {
  console.error(`subscribeSelf failed, code is ${err.code}, message is ${err.message}`);
});

notificationSubscribe.unsubscribe

unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void

Unsubscribes from a notification. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let unsubscribeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("unsubscribe success");
  }
}
let onDisconnectCallback = () => {
  console.info("subscribe disconnect");
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onDisconnect: onDisconnectCallback
};
notificationSubscribe.unsubscribe(subscriber, unsubscribeCallback);

notificationSubscribe.unsubscribe

unsubscribe(subscriber: NotificationSubscriber): Promise<void>

Unsubscribes from a notification. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
subscriber	NotificationSubscriber	Yes	Notification subscriber.

Return value

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

Error codes

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

ID	Error Message
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let onDisconnectCallback = () => {
  console.info("subscribe disconnect");
}
let subscriber: notificationSubscribe.NotificationSubscriber = {
  onDisconnect: onDisconnectCallback
};
notificationSubscribe.unsubscribe(subscriber).then(() => {
  console.info("unsubscribe success");
}).catch((err: BusinessError) => {
  console.error(`unsubscribe fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.remove

remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason, callback: AsyncCallback<void>): void

Removes a notification based on the bundle information and notification key. 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.

Parameters

Name	Type	Mandatory	Description
bundle	BundleOption	Yes	Bundle information of the application.
notificationKey	NotificationKey	Yes	Notification key.
reason	RemoveReason	Yes	Reason for removing the notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600007	The notification does not exist.
17700001	The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { notificationManager } from '@kit.NotificationKit';

let removeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`remove failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("remove success");
  }
}
let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
};
let notificationKey: notificationSubscribe.NotificationKey = {
  id: 0,
  label: "label",
};
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CLICK_REASON_REMOVE;
notificationSubscribe.remove(bundle, notificationKey, reason, removeCallback);

notificationSubscribe.remove

remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise<void>

Removes a notification based on the bundle information and notification key. 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.

Parameters

Name	Type	Mandatory	Description
bundle	BundleOption	Yes	Bundle information of the application.
notificationKey	NotificationKey	Yes	Notification key.
reason	RemoveReason	Yes	Reason for removing the notification.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600007	The notification does not exist.
17700001	The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { notificationManager } from '@kit.NotificationKit';

let bundle: notificationManager.BundleOption = {
  bundle: "bundleName1",
};
let notificationKey: notificationSubscribe.NotificationKey = {
  id: 0,
  label: "label",
};
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CLICK_REASON_REMOVE;
notificationSubscribe.remove(bundle, notificationKey, reason).then(() => {
  console.info("remove success");
}).catch((err: BusinessError) => {
  console.error(`remove fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.remove

remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback<void>): void

Removes a notification based on the specified unique notification ID. 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.

Parameters

Name	Type	Mandatory	Description
hashCode	string	Yes	Unique notification ID. It is the value of hashCode in the NotificationRequest object of SubscribeCallbackData used in the onConsume callback.
reason	RemoveReason	Yes	Reason for removing the notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600007	The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let hashCode: string = 'hashCode';
let removeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`remove failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("remove success");
  }
}
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CANCEL_REASON_REMOVE;
notificationSubscribe.remove(hashCode, reason, removeCallback);

notificationSubscribe.remove

remove(hashCode: string, reason: RemoveReason): Promise<void>

Removes a notification based on the specified unique notification ID. 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.

Parameters

Name	Type	Mandatory	Description
hashCode	string	Yes	Unique notification ID. It is the value of hashCode in the NotificationRequest object of SubscribeCallbackData used in the onConsume callback.
reason	RemoveReason	Yes	Reason for removing the notification.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600007	The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let hashCode: string = 'hashCode';
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CLICK_REASON_REMOVE;
notificationSubscribe.remove(hashCode, reason).then(() => {
  console.info("remove success");
}).catch((err: BusinessError) => {
  console.error(`remove fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.remove¹⁰⁺

remove(hashCodes: Array<String>, reason: RemoveReason, callback: AsyncCallback<void>): void

Removes specified 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.

Parameters

Name	Type	Mandatory	Description
hashCodes	Array<String>	Yes	Array of unique notification IDs. It is the value of hashCode in the NotificationRequest object of SubscribeCallbackData used in the onConsume callback.
reason	RemoveReason	Yes	Reason for removing the notification.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let hashCodes: string[] = ['hashCode1', 'hashCode2'];
let removeCallback = (err: BusinessError) => {
  if (err) {
    console.error(`remove failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("remove success");
  }
}
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CANCEL_REASON_REMOVE;
notificationSubscribe.remove(hashCodes, reason, removeCallback);

notificationSubscribe.remove¹⁰⁺

remove(hashCodes: Array<String>, reason: RemoveReason): Promise<void>

Removes specified 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.

Parameters

Name	Type	Mandatory	Description
hashCodes	Array<String>	Yes	Array of unique notification IDs.
reason	RemoveReason	Yes	Reason for removing the notification.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let hashCodes: string[] = ['hashCode1','hashCode2'];
let reason: notificationSubscribe.RemoveReason = notificationSubscribe.RemoveReason.CLICK_REASON_REMOVE;
notificationSubscribe.remove(hashCodes, reason).then(() => {
  console.info("remove success");
}).catch((err: BusinessError) => {
  console.error(`remove fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.removeAll

removeAll(bundle: BundleOption, callback: AsyncCallback<void>): void

Removes all notifications for a specified application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
bundle	BundleOption	Yes	Bundle information of the application.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
17700001	The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let removeAllCallback = (err: BusinessError) => {
  if (err) {
    console.error(`removeAll failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("removeAll success");
  }
}
let bundle: notificationSubscribe.BundleOption = {
  bundle: "bundleName1",
};
notificationSubscribe.removeAll(bundle, removeAllCallback);

notificationSubscribe.removeAll

removeAll(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let removeAllCallback = (err: BusinessError) => {
    if (err) {
        console.error(`removeAll failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("removeAll success");
    }
}
notificationSubscribe.removeAll(removeAllCallback);

notificationSubscribe.removeAll

removeAll(bundle?: BundleOption): Promise<void>

Removes all notifications for a specified application. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
bundle	BundleOption	No	Bundle information of the application. By default, this parameter is left empty, indicating that all notifications will be removed.

Return value

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

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
17700001	The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// If no application is specified, notifications of all applications are deleted.
notificationSubscribe.removeAll().then(() => {
  console.info("removeAll success");
}).catch((err: BusinessError) => {
  console.error(`removeAll fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.removeAll

removeAll(userId: number, callback: AsyncCallback<void>): void

Removes all notifications for a specified user. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600008	The user does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let removeAllCallback = (err: BusinessError) => {
  if (err) {
    console.error(`removeAll failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("removeAll success");
  }
}
// Use the actual user ID when calling the API.
let userId: number = 1;
notificationSubscribe.removeAll(userId, removeAllCallback);

notificationSubscribe.removeAll

removeAll(userId: number): Promise<void>

Removes all notifications for a specified user. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Required permissions: ohos.permission.NOTIFICATION_CONTROLLER

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
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 Universal Error Codes and Notification Error Codes.

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600001	Internal error.
1600002	Marshalling or unmarshalling error.
1600003	Failed to connect to the service.
1600008	The user does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let userId: number = 1;
notificationSubscribe.removeAll(userId).then(() => {
  console.info("removeAll success");
}).catch((err: BusinessError) => {
  console.error(`removeAll fail: ${JSON.stringify(err)}`);
});

notificationSubscribe.distributeOperation¹⁸⁺

distributeOperation(hashcode: string, operationInfo?: OperationInfo): Promise<void>

Triggers a notification for cross-device operations, such as tap-to-redirect and quick reply. 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.

Parameters

Name	Type	Mandatory	Description
hashcode	string	Yes	Unique notification ID.
operationInfo	OperationInfo	No	Cross-device operation information. 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 Universal Error Codes and Notification Error Codes.

ID	Error Message
201	Permission denied.
202	Not system application to call the interface.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.
1600010	Distributed operation failed.
1600021	Distributed operation timed out.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let hashcode: string = 'hashcode';
let operationInfo: notificationSubscribe.OperationInfo = {
  actionName: "actionName",
  userInput: "userInput",
  operationType: 1,
  buttonIndex: 1,
};
notificationSubscribe.distributeOperation(hashcode, operationInfo).then(() => {
  console.info("distributeOperation success");
}).catch((err: BusinessError) => {
  console.error(`distributeOperation fail: ${JSON.stringify(err)}`);
});

NotificationKey

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Name	Type	Read-Only	Optional	Description
id	number	No	No	Notification ID.
label	string	No	Yes	Notification label. This parameter is left empty by default.

RemoveReason

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Name	Value	Description
CLICK_REASON_REMOVE	1	The notification is removed after a click on it.
CANCEL_REASON_REMOVE	2	The notification is removed by the user.

OperationInfo¹⁸⁺

System capability: SystemCapability.Notification.Notification

System API: This is a system API.

Name	Type	Read-Only	Optional	Description
actionName	string	No	Yes	Operation button displayed in the notification. The value must be the same as that of title in NotificationActionButton.
userInput	string	No	Yes	User input, used to apply quick reply across devices. The value must be the same as that of inputKey in NotificationUserInput.
operationType²⁰⁺	number	No	Yes	Operation type. - 0: The user taps the non-live view. - 1: The user taps the non-live view button. - 32: The user taps the live view. - 33: The user taps the live view auxiliary area.
buttonIndex²⁰⁺	number	No	Yes	Index of the non-live view button or live view auxiliary area that the user taps.

@ohos.notificationSubscribe (NotificationSubscribe) (System API)

Modules to Import

notificationSubscribe.subscribe(deprecated)

notificationSubscribe.subscribe(deprecated)

notificationSubscribe.subscribe(deprecated)

notificationSubscribe.subscribeNotification

notificationSubscribe.subscribeNotification

notificationSubscribe.subscribeSelf11+

notificationSubscribe.unsubscribe

notificationSubscribe.unsubscribe

notificationSubscribe.remove

notificationSubscribe.remove

notificationSubscribe.remove

notificationSubscribe.remove

notificationSubscribe.remove10+

notificationSubscribe.remove10+

notificationSubscribe.removeAll

notificationSubscribe.removeAll

notificationSubscribe.removeAll

notificationSubscribe.removeAll

notificationSubscribe.removeAll

notificationSubscribe.distributeOperation18+

NotificationKey

RemoveReason

OperationInfo18+

notificationSubscribe.subscribe^(deprecated)

notificationSubscribe.subscribe^(deprecated)

notificationSubscribe.subscribe^(deprecated)

notificationSubscribe.subscribeSelf¹¹⁺

notificationSubscribe.remove¹⁰⁺

notificationSubscribe.remove¹⁰⁺

notificationSubscribe.distributeOperation¹⁸⁺

OperationInfo¹⁸⁺