@ohos.notificationExtensionSubscription (notificationExtensionSubscription模块)(系统接口)

本模块提供管理通知扩展的能力，具体包括：打开通知扩展订阅设置界面、订阅和取消订阅通知扩展、获取和设置通知授权状态。

说明：

本模块首批接口从API version 22开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本页面仅包含本模块的系统接口，其他公开接口参见notificationExtensionSubscription。

导入模块

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

notificationExtensionSubscription.getAllSubscriptionBundles

getAllSubscriptionBundles(): Promise<BundleOption[]>

获取所有具有ohos.permission.SUBSCRIBE_NOTIFICATION权限并且实现了NotificationSubscriberExtensionAbility的应用列表。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.NOTIFICATION_CONTROLLER

系统接口：此接口为系统接口。

返回值：

类型	说明
Promise<BundleOption[]>	Promise对象，返回所有具有ohos.permission.SUBSCRIBE_NOTIFICATION权限并且实现了NotificationSubscriberExtensionAbility的应用列表。

错误码：

以下错误码的详细介绍请参见通用错误码和通知错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error.
1600003	Failed to connect to the service.

示例：

notificationExtensionSubscription.getAllSubscriptionBundles().then((data: notificationExtensionSubscription.BundleOption[]) => {
  console.info(`getAllSubscriptionBundles successfully. Data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getAllSubscriptionBundles fail: ${JSON.stringify(err)}`);
});

notificationExtensionSubscription.getUserGrantedState

getUserGrantedState(targetBundle: BundleOption): Promise<boolean>

查询指定应用的“允许获取本机通知”的开关状态。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.NOTIFICATION_CONTROLLER

系统接口：此接口为系统接口。

参数：

参数名	类型	必填	说明
targetBundle	BundleOption	是	需要查询的目标应用信息。应用需要具有ohos.permission.SUBSCRIBE_NOTIFICATION权限，并且实现NotificationSubscriberExtensionAbility,否则返回1600022错误码。

返回值：

类型	说明
Promise<boolean>	Promise对象，返回true表示目标应用的“允许获取本机通知”状态已启用；返回false表示目标应用的“允许获取本机通知”状态未启用。

错误码：

以下错误码的详细介绍请参见通用错误码和通知错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error.
1600003	Failed to connect to the service.
1600022	The specified bundle is invalid.

示例：

let targetBundle: notificationExtensionSubscription.BundleOption =
{
  // 应改为开发者需要查询的目标应用信息
  bundle: 'com.example.testnotification',
};
notificationExtensionSubscription.getUserGrantedState(targetBundle).then((isOpen: boolean) => {
  if (isOpen) {
    console.info('GrantedState true');
  } else {
    console.info('GrantedState false');
  }
}).catch((err: BusinessError) => {
  console.error(`getUserGrantedState fail: ${JSON.stringify(err)}`);
});

notificationExtensionSubscription.setUserGrantedState

setUserGrantedState(targetBundle: BundleOption, enabled: boolean): Promise<void>

设置指定应用的“允许获取本机通知”的开关状态。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.NOTIFICATION_CONTROLLER

系统接口：此接口为系统接口。

参数：

参数名	类型	必填	说明
targetBundle	BundleOption	是	需要设置的目标应用信息。应用需要具有ohos.permission.SUBSCRIBE_NOTIFICATION权限，并且实现NotificationSubscriberExtensionAbility，否则返回1600022错误码
enable	boolean	是	表示应用的“允许获取本机通知”的开关状态，true表示启用，false表示未启用。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码和通知错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error.
1600003	Failed to connect to the service.
1600022	The specified bundle is invalid.

示例：

let targetBundle: notificationExtensionSubscription.BundleOption =
{
  // 应改为开发者需要查询的目标应用信息
  bundle: 'com.example.testnotification',
};
notificationExtensionSubscription.setUserGrantedState(targetBundle, true).then(() => {
  console.info(`setUserGrantedState successfully.`);
}).catch((err: BusinessError) => {
  console.error(`setUserGrantedState fail: ${JSON.stringify(err)}`);
});

notificationExtensionSubscription.getUserGrantedEnabledBundles

getUserGrantedEnabledBundles(targetBundle: BundleOption): Promise<BundleOption[]>

获取指定应用中“已获取的本机通知”通知开关开启的应用列表。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.NOTIFICATION_CONTROLLER

系统接口：此接口为系统接口。

参数：

参数名	类型	必填	说明
targetBundle	BundleOption	是	需要查询的目标应用信息。应用需要具有ohos.permission.SUBSCRIBE_NOTIFICATION权限，并且实现NotificationSubscriberExtensionAbility，否则返回1600022错误码。

返回值：

类型	说明
Promise<BundleOption[]>	Promise对象，返回指定应用中“已获取的本机通知”通知开关开启的应用列表。

错误码：

以下错误码的详细介绍请参见通用错误码和通知错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error.
1600003	Failed to connect to the service.
1600022	The specified bundle is invalid.

示例：

let targetBundle: notificationExtensionSubscription.BundleOption =
{
  // 应改为开发者需要查询的目标应用信息
  bundle: 'com.example.testnotification',
};
notificationExtensionSubscription.getUserGrantedEnabledBundles(targetBundle).then((data: notificationExtensionSubscription.BundleOption[]) => {
  console.info(`getUserGrantedEnabledBundles successfully. Data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getUserGrantedEnabledBundles fail: ${JSON.stringify(err)}`);
});

notificationExtensionSubscription.setUserGrantedBundleState

setUserGrantedBundleState(targetBundle: BundleOption, enabledBundles: BundleOption[], enabled:boolean): Promise<void>

设置指定应用中“已获取的本机通知”的应用通知开关状态。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.NOTIFICATION_CONTROLLER

系统接口：此接口为系统接口。

参数：

参数名	类型	必填	说明
targetBundle	BundleOption	是	需要设置的目标应用信息。应用需要具有ohos.permission.SUBSCRIBE_NOTIFICATION权限，并且实现NotificationSubscriberExtensionAbility，否则返回1600022错误码。
enabledBundles	BundleOption[]	是	被授权的应用信息列表。
enabled	boolean	是	表示“已获取的本机通知”的应用授权状态是否启用，true表示已启用，false表示未启用。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码和通知错误码。

错误码ID	错误信息
201	Permission denied.
202	Not system application to call the interface.
1600001	Internal error.
1600003	Failed to connect to the service.
1600022	The specified bundle is invalid.

示例：

let targetBundle: notificationExtensionSubscription.BundleOption =
  {
    // 应改为开发者需要设置的目标应用信息
    bundle: 'com.example.testnotification',
  };
let enabledBundles: notificationExtensionSubscription.BundleOption[] = [
  // 应改为开发者需要授权的实际应用
  { bundle: 'com.example.xxx', uid: 11111111 },
  { bundle: 'com.example.xxxx', uid: 11111111 },
  { bundle: 'com.example.xxxxx' },
];
notificationExtensionSubscription.setUserGrantedBundleState(targetBundle, enabledBundles, true).then(() => {
  console.info(`setUserGrantedBundleState successfully.`);
}).catch((err: BusinessError) => {
  console.error(`setUserGrantedBundleState fail: ${JSON.stringify(err)}`);
});