@ohos.notificationExtensionSubscription (notificationExtensionSubscription模块)

导入模块

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

notificationExtensionSubscription.openSubscriptionSettings

openSubscriptionSettings(context: UIAbilityContext): Promise<void>

打开应用的通知扩展订阅授权页面，以半模态弹窗形式显示。用户可在该页面授权“允许获取本机通知”开关与“已获取的本机通知”应用开关。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

参数：

返回值：

错误码：

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

示例：

import { common } from '@kit.AbilityKit';

try {
  // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext。
  let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
  notificationExtensionSubscription.openSubscriptionSettings(context).then(() => {
    console.info(`openSubscriptionSettings success`);
  }).catch((e: Error) => {
    let error = e as BusinessError
    console.error(`failed to call openSubscriptionSettings, code is ${error.code}, message is ${error.message}`)
  });
} catch (error) {
  console.error(`failed to call openSubscriptionSettings, code is ${error.code}, message is ${error.message}`)
}

notificationExtensionSubscription.openSubscriptionSettingsWithResult

openSubscriptionSettingsWithResult(context: UIAbilityContext): Promise<UserGrantSetting>

打开应用的通知扩展订阅授权页面，以半模态弹窗形式显示。用户可在该页面授权“允许获取本机通知”开关与“已获取的本机通知”应用开关。使用Promise异步回调，当半模态窗口关闭时返回用户设置的授权的结果。

起始版本：26.0.0

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

参数：

返回值：

错误码：

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

示例：

import { common } from '@kit.AbilityKit';

try {
  // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext。
  let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
  notificationExtensionSubscription.openSubscriptionSettingsWithResult(context).then((data) => {
    console.info(`openSubscriptionSettingsWithResult success, data: ${JSON.stringify(data)}`);
  }).catch((e: Error) => {
    let error = e as BusinessError
    console.error(`failed to call openSubscriptionSettingsWithResult, code is ${error.code}, message is ${error.message}`)
  });
} catch (error) {
  console.error(`failed to call openSubscriptionSettingsWithResult, code is ${error.code}, message is ${error.message}`)
}

notificationExtensionSubscription.subscribe

subscribe(info: NotificationExtensionSubscriptionInfo[]): Promise<void>

订阅通知扩展。使用蓝牙模块相关接口获取蓝牙设备的唯一地址后方可订阅。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

参数：

返回值：

错误码：

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

示例：

let infos: notificationExtensionSubscription.NotificationExtensionSubscriptionInfo[] = [
  {
    addr: '01:23:45:67:89:AB', // 使用动态获取的蓝牙地址
    type: notificationExtensionSubscription.SubscribeType.BLUETOOTH
  }
];
notificationExtensionSubscription.subscribe(infos).then(() => {
  console.info(`subscribe success`);
}).catch((err: BusinessError) => {
  console.error(`subscribe fail, code is ${err.code}, message is ${err.message}`);
});

notificationExtensionSubscription.unsubscribe

unsubscribe(): Promise<void>

取消通知扩展的订阅。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

返回值：

错误码：

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

示例：

notificationExtensionSubscription.unsubscribe().then(() => {
  console.info(`unsubscribe success`);
}).catch((err: BusinessError) => {
  console.error(`unsubscribe fail, code is ${err.code}, message is ${err.message}`);
});

notificationExtensionSubscription.getSubscribeInfo

getSubscribeInfo(): Promise<NotificationExtensionSubscriptionInfo[]>

获取当前应用的通知扩展订阅信息。使用Promise异步回调。

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

返回值：

错误码：

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

示例：

notificationExtensionSubscription.getSubscribeInfo().then((data: notificationExtensionSubscription.NotificationExtensionSubscriptionInfo[]) => {
  console.info(`getSubscribeInfo successfully. Data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getSubscribeInfo fail, code is ${err.code}, message is ${err.message}`);
});

notificationExtensionSubscription.isUserGranted

isUserGranted(): Promise<boolean>

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

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

返回值：

错误码：

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

示例：

notificationExtensionSubscription.isUserGranted().then((isOpen: boolean) => {
  if (isOpen) {
    console.info('isUserGranted true');
  } else {
    console.info('isUserGranted false');
  }
}).catch((err: BusinessError) => {
  console.error(`isUserGranted fail, code is ${err.code}, message is ${err.message}`);
});

notificationExtensionSubscription.getUserGrantedEnabledBundles

getUserGrantedEnabledBundles(): Promise<GrantedBundleInfo[]>

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

系统能力：SystemCapability.Notification.Notification

需要权限：ohos.permission.SUBSCRIBE_NOTIFICATION

返回值：

错误码：

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

示例：

notificationExtensionSubscription.getUserGrantedEnabledBundles().then((data: notificationExtensionSubscription.GrantedBundleInfo[]) => {
  console.info(`getUserGrantedEnabledBundles successfully. Data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getUserGrantedEnabledBundles fail, code is ${err.code}, message is ${err.message}`);
});

NotificationExtensionSubscriptionInfo

type NotificationExtensionSubscriptionInfo = _NotificationExtensionSubscriptionInfo

用于描述通知扩展订阅的信息。

系统能力：SystemCapability.Notification.Notification

NotificationInfo

type NotificationInfo = _NotificationInfo

通知订阅扩展能力中onReceiveMessage回调的通知信息。

系统能力：SystemCapability.Notification.Notification

SubscribeType

表示通知扩展订阅的类型。

系统能力：SystemCapability.Notification.Notification

BundleOption

type BundleOption = _BundleOption

指定应用的包信息。

系统能力：SystemCapability.Notification.Notification

GrantedBundleInfo

type GrantedBundleInfo = _GrantedBundleInfo

授权应用的包信息。

系统能力：SystemCapability.Notification.Notification

UserGrantSetting

type UserGrantSetting = _UserGrantSetting

用户授权的设置信息。

起始版本：26.0.0

模型约束：此接口仅可在Stage模型下使用。

系统能力：SystemCapability.Notification.Notification