版本：v8

@capacitor/local-notifications

Local Notifications API 提供了一种在本地安排设备通知的方法（即无需服务器发送推送通知）。

安装

npm install @capacitor/local-notifications
npx cap sync

Android

Android 13 需要权限检查才能发送通知。你需要相应地调用 checkPermissions() 和 requestPermissions()。

在 Android 12 及更早版本上，不会显示提示，将直接返回已授权。

从 Android 12 开始，除非将此权限添加到 AndroidManifest.xml，否则计划的通知不会是精确的：

<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />

请注意，即使存在此权限，用户仍然可以从应用设置中禁用精确通知。使用 checkExactNotificationSetting() 来检查组件的值。如果用户禁用了此设置，应用将重新启动，并且任何使用精确闹钟安排的通知都将被删除。如果你的应用依赖于精确闹钟，请确保在应用启动时检查此设置（例如，在 App.appStateChange 中），以提供回退或替代行为。

在 Android 14 上，有一个名为 USE_EXACT_ALARM 的新权限。使用此权限无需向用户请求权限即可使用精确闹钟。仅当精确闹钟的使用对你的应用功能至关重要时，才应使用此权限。在此处阅读有关使用此权限的更多信息这里。

从 Android 15 开始，用户可以在私人空间中安装应用。用户可以随时锁定其私人空间，这意味着推送通知在用户解锁之前不会显示。

无法检测应用是否安装在私人空间中。因此，如果你的应用显示任何关键通知，请告知用户避免在私人空间中安装应用。

有关应用在私人空间方面行为变化的更多信息，请参考 Android 文档。

配置

本地通知可以通过以下选项进行配置：

属性	类型	描述	Since
`smallIcon`	`string`	设置通知的默认状态栏图标。图标应放在应用的 `res/drawable` 文件夹中。此选项的值应为 drawable 资源 ID，即不带扩展名的文件名。仅适用于 Android。	1.0.0
`iconColor`	`string`	设置通知状态栏图标的默认颜色。仅适用于 Android。	1.0.0
`sound`	`string`	设置通知的默认通知声音。在 Android 8+ 上，设置默认渠道声音，除非应用被卸载，否则无法更改。如果未找到音频文件，Android 7.x 上将播放默认系统声音，Android 8+ 上则没有声音。仅适用于 Android。	1.0.0
`presentationOptions`	`LocalNotificationPresentationOption[]`	这是一个可以组合的字符串数组。数组中可能的值有：- `badge`：更新应用图标上的角标计数（默认值）- `sound`：收到通知时设备会响铃/振动 - `banner`：通知显示为横幅 - `list`：通知显示在通知中心中如果不需要任何选项，可以提供空数组。仅适用于 iOS。	8.2.0

示例

在 capacitor.config.json 中：

{
  "plugins": {
    "LocalNotifications": {
      "smallIcon": "ic_stat_icon_config_sample",
      "iconColor": "#488AFF",
      "sound": "beep.wav",
      "presentationOptions": ["badge", "sound", "banner", "list"]
    }
  }
}

在 capacitor.config.ts 中：

/// <reference types="@capacitor/local-notifications" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    LocalNotifications: {
      smallIcon: "ic_stat_icon_config_sample",
      iconColor: "#488AFF",
      sound: "beep.wav",
      presentationOptions: ["badge", "sound", "banner", "list"],
    },
  },
};

export default config;

Doze（低电耗模式）

如果设备已进入 Doze 模式，你的应用可能具有受限的功能。如果你需要在 Doze 模式下也能触发通知，请使用 allowWhileIdle: true 安排通知。谨慎使用 allowWhileIdle，因为这些通知每个应用每 9 分钟只能触发一次。

API

schedule(...)
getPending()
registerActionTypes(...)
cancel(...)
areEnabled()
getDeliveredNotifications()
removeDeliveredNotifications(...)
removeAllDeliveredNotifications()
createChannel(...)
deleteChannel(...)
listChannels()
checkPermissions()
requestPermissions()
changeExactNotificationSetting()
checkExactNotificationSetting()
addListener('localNotificationReceived', ...)
addListener('localNotificationActionPerformed', ...)
removeAllListeners()
Interfaces
Type Aliases
Enums

schedule(...)

schedule(options: ScheduleOptions) => Promise<ScheduleResult>

安排一个或多个本地通知。

参数	类型
`options`	`ScheduleOptions`

返回：

Promise<ScheduleResult>

Since: 1.0.0

getPending()

getPending() => Promise<PendingResult>

获取待处理通知的列表。

返回：

Promise<PendingResult>

Since: 1.0.0

registerActionTypes(...)

registerActionTypes(options: RegisterActionTypesOptions) => Promise<void>

注册在显示通知时要执行的操作。

仅适用于 iOS 和 Android。

参数	类型
`options`	`RegisterActionTypesOptions`

Since: 1.0.0

cancel(...)

cancel(options: CancelOptions) => Promise<void>

取消待处理的通知。

参数	类型
`options`	`CancelOptions`

Since: 1.0.0

areEnabled()

areEnabled() => Promise<EnabledResult>

检查通知是否已启用。

返回：

Promise<EnabledResult>

Since: 1.0.0

getDeliveredNotifications()

getDeliveredNotifications() => Promise<DeliveredNotifications>

获取通知屏幕上可见的通知列表。

返回：

Promise<DeliveredNotifications>

Since: 4.0.0

removeDeliveredNotifications(...)

removeDeliveredNotifications(delivered: DeliveredNotifications) => Promise<void>

从通知屏幕中移除指定的通知。

参数	类型
`delivered`	`DeliveredNotifications`

Since: 4.0.0

removeAllDeliveredNotifications()

removeAllDeliveredNotifications() => Promise<void>

从通知屏幕中移除所有通知。

Since: 4.0.0

createChannel(...)

createChannel(channel: Channel) => Promise<void>

创建通知渠道。

仅适用于 Android。

参数	类型
`channel`	`Channel`

Since: 1.0.0

deleteChannel(...)

deleteChannel(args: { id: string; }) => Promise<void>

删除通知渠道。

仅适用于 Android。

参数	类型
`args`	`{ id: string; }`

Since: 1.0.0

listChannels()

listChannels() => Promise<ListChannelsResult>

获取通知渠道列表。

仅适用于 Android。

返回：

Promise<ListChannelsResult>

Since: 1.0.0

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

检查显示本地通知的权限。

返回：

Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

请求显示本地通知的权限。

返回：

Promise<PermissionStatus>

Since: 1.0.0

changeExactNotificationSetting()

changeExactNotificationSetting() => Promise<SettingsPermissionStatus>

引导用户进入应用设置屏幕以配置精确闹钟。

如果用户将设置从已授权更改为拒绝，应用将重新启动，任何使用精确闹钟安排的通知将被删除。

在 Android < 12 上，用户不会被引导到应用设置屏幕，此函数将返回 granted。

仅适用于 Android。

返回：

Promise<SettingsPermissionStatus>

Since: 6.0.0

checkExactNotificationSetting()

checkExactNotificationSetting() => Promise<SettingsPermissionStatus>

检查使用精确闹钟的应用设置。

仅适用于 Android。

返回：

Promise<SettingsPermissionStatus>

Since: 6.0.0

addListener('localNotificationReceived', ...)

addListener(eventName: 'localNotificationReceived', listenerFunc: (notification: LocalNotificationSchema) => void) => Promise<PluginListenerHandle>

监听通知显示时的事件。

参数	类型
`eventName`	`'localNotificationReceived'`
`listenerFunc`	`(notification: LocalNotificationSchema) => void`

返回：

Promise<PluginListenerHandle>

Since: 1.0.0

addListener('localNotificationActionPerformed', ...)

addListener(eventName: 'localNotificationActionPerformed', listenerFunc: (notificationAction: ActionPerformed) => void) => Promise<PluginListenerHandle>

监听在通知上执行操作时的事件。

参数	类型
`eventName`	`'localNotificationActionPerformed'`
`listenerFunc`	`(notificationAction: ActionPerformed) => void`

返回：

Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

移除此插件的所有监听器。

Since: 1.0.0

接口

ScheduleResult

属性	类型	描述	Since
`notifications`	`LocalNotificationDescriptor[]`	已安排的通知列表。	1.0.0

LocalNotificationDescriptor

描述本地通知的对象。

属性	类型	描述	Since
`id`	`number`	通知标识符。	1.0.0

ScheduleOptions

属性	类型	描述	Since
`notifications`	`LocalNotificationSchema[]`	要安排的通知列表。	1.0.0

LocalNotificationSchema

属性	类型	描述	Since
`title`	`string`	通知的标题。	1.0.0
`body`	`string`	通知的正文，显示在标题下方。	1.0.0
`largeBody`	`string`	设置在大文本通知样式中显示的多行文本块。	1.0.0
`summaryText`	`string`	用于设置收件箱和大文本通知样式中的摘要文本详情。仅适用于 Android。	1.0.0
`id`	`number`	通知标识符。在 Android 上是一个 32 位整数。因此该值应在 -2147483648 到 2147483647 之间（含边界值）。	1.0.0
`schedule`	`Schedule`	安排此通知在稍后时间触发。	1.0.0
`sound`	`string`	显示此通知时播放的音频文件名。在文件名中包含文件扩展名。在 iOS 上，文件应在应用 bundle 中。在 Android 上，文件应在 res/raw 文件夹中。推荐格式为 `.wav`，因为它同时受 iOS 和 Android 支持。仅适用于 iOS 和 Android 7.x。对于 Android 8+，请使用配置了所需声音的渠道的 channelId。如果未找到声音文件（即空字符串或错误名称），将使用默认系统通知声音。如果未提供，Android 上将播放默认声音，iOS 上则无声音。	1.0.0
`smallIcon`	`string`	设置自定义状态栏图标。如果设置，将覆盖 Capacitor 配置中的 `smallIcon` 选项。图标应放在应用的 `res/drawable` 文件夹中。此选项的值应为 drawable 资源 ID，即不带扩展名的文件名。仅适用于 Android。	1.0.0
`largeIcon`	`string`	设置通知的大图标。图标应放在应用的 `res/drawable` 文件夹中。此选项的值应为 drawable 资源 ID，即不带扩展名的文件名。仅适用于 Android。	1.0.0
`iconColor`	`string`	设置通知图标的颜色。仅适用于 Android。	1.0.0
`attachments`	`Attachment[]`	设置此通知的附件。	1.0.0
`actionTypeId`	`string`	为此通知关联一个操作类型。	1.0.0
`extra`	`any`	设置存储在此通知中的附加数据。	1.0.0
`threadIdentifier`	`string`	用于分组多个通知。在 `UNMutableNotificationContent` 上设置 `threadIdentifier`。仅适用于 iOS。	1.0.0
`summaryArgument`	`string`	此通知添加到分类摘要格式字符串中的字符串。在 `UNMutableNotificationContent` 上设置 `summaryArgument`。仅适用于 iOS。	1.0.0
`relevanceScore`	`number`	系统用于在分组应用通知时确定哪个通知是特色通知的分数。值必须在 0 和 1 之间，其中 0 表示最不相关，1 表示最相关。默认值为 0。在 `UNMutableNotificationContent` 上设置 `relevanceScore`。仅适用于 iOS。	8.1.0
`interruptionLevel`	`InterruptionLevel`	指示通知优先级和投递时机的打扰级别。在 `UNMutableNotificationContent` 上设置 `interruptionLevel`。仅适用于 iOS。	8.1.0
`group`	`string`	用于分组多个通知。在 `NotificationCompat.Builder` 上使用提供的值调用 `setGroup()`。仅适用于 Android。	1.0.0
`groupSummary`	`boolean`	如果为 true，此通知成为一组通知的摘要。在 `NotificationCompat.Builder` 上使用提供的值调用 `setGroupSummary()`。仅适用于 Android 且使用 `group` 时。	1.0.0
`channelId`	`string`	指定通知应投递到的渠道。如果具有给定名称的渠道不存在，则通知不会触发。如果未提供，将使用默认渠道。在 `NotificationCompat.Builder` 上使用提供的值调用 `setChannelId()`。仅适用于 Android 8+。	1.0.0
`ongoing`	`boolean`	如果为 true，通知不能滑动删除。在 `NotificationCompat.Builder` 上使用提供的值调用 `setOngoing()`。仅适用于 Android。	1.0.0
`autoCancel`	`boolean`	如果为 true，用户点击通知时自动取消。在 `NotificationCompat.Builder` 上使用提供的值调用 `setAutoCancel()`。仅适用于 Android。	1.0.0
`inboxList`	`string[]`	设置在收件箱样式中显示的字符串列表。最多允许 5 个字符串。仅适用于 Android。	1.0.0
`silent`	`boolean`	如果为 true，应用在前台时通知不会显示。仅适用于 iOS。	5.0.0

Schedule

表示通知的安排计划。

使用 at、on 或 every 来安排通知。

属性	类型	描述	Since
`at`	`Date`	在特定的日期和时间安排通知。	1.0.0
`repeats`	`boolean`	在 `at` 指定的日期和时间重复投递此通知。仅适用于 iOS 和 Android。	1.0.0
`allowWhileIdle`	`boolean`	允许此通知在 Doze 模式下触发。请注意这些通知每个应用每 9 分钟只能触发一次。	1.0.0
`on`	`ScheduleOn`	在特定时间间隔安排通知。这类似于安排 cron 作业。仅适用于 iOS 和 Android。	1.0.0
`every`	`ScheduleEvery`	按特定时间间隔安排通知。	1.0.0
`count`	`number`	限制由 `every` 指定的时间间隔投递通知的次数。	1.0.0

Date

支持日期和时间的基本存储和检索。

Method	Signature	描述
toString	() => string	返回日期的字符串表示形式。格式取决于区域设置。
toDateString	() => string	以字符串值形式返回日期。
toTimeString	() => string	以字符串值形式返回时间。
toLocaleString	() => string	以适合主机环境当前区域设置的值形式返回值。
toLocaleDateString	() => string	以适合主机环境当前区域设置的字符串值形式返回日期。
toLocaleTimeString	() => string	以适合主机环境当前区域设置的字符串值形式返回时间。
valueOf	() => number	返回以毫秒为单位的存储时间值，从 1970 年 1 月 1 日 UTC 午夜开始。
getTime	() => number	获取以毫秒为单位的时间值。
getFullYear	() => number	使用本地时间获取年份。
getUTCFullYear	() => number	使用协调世界时（UTC）获取年份。
getMonth	() => number	使用本地时间获取月份。
getUTCMonth	() => number	使用协调世界时（UTC）获取 Date 对象的月份。
getDate	() => number	使用本地时间获取月份中的日期。
getUTCDate	() => number	使用协调世界时（UTC）获取月份中的日期。
getDay	() => number	使用本地时间获取星期几。
getUTCDay	() => number	使用协调世界时（UTC）获取星期几。
getHours	() => number	使用本地时间获取日期中的小时。
getUTCHours	() => number	使用协调世界时（UTC）获取 Date 对象中的小时值。
getMinutes	() => number	使用本地时间获取 Date 对象的分钟。
getUTCMinutes	() => number	使用协调世界时（UTC）获取 Date 对象的分钟。
getSeconds	() => number	使用本地时间获取 Date 对象的秒数。
getUTCSeconds	() => number	使用协调世界时（UTC）获取 Date 对象的秒数。
getMilliseconds	() => number	使用本地时间获取 Date 的毫秒数。
getUTCMilliseconds	() => number	使用协调世界时（UTC）获取 Date 对象的毫秒数。
getTimezoneOffset	() => number	获取本地计算机时间和协调世界时（UTC）之间的时差（以分钟为单位）。
setTime	(time: number) => number	设置 Date 对象中的日期和时间值。
setMilliseconds	(ms: number) => number	使用本地时间设置 Date 对象中的毫秒值。
setUTCMilliseconds	(ms: number) => number	使用协调世界时（UTC）设置 Date 对象中的毫秒值。
setSeconds	(sec: number, ms?: number \| undefined) => number	使用本地时间设置 Date 对象中的秒值。
setUTCSeconds	(sec: number, ms?: number \| undefined) => number	使用协调世界时（UTC）设置 Date 对象中的秒值。
setMinutes	(min: number, sec?: number \| undefined, ms?: number \| undefined) => number	使用本地时间设置 Date 对象中的分钟值。
setUTCMinutes	(min: number, sec?: number \| undefined, ms?: number \| undefined) => number	使用协调世界时（UTC）设置 Date 对象中的分钟值。
setHours	(hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number	使用本地时间设置 Date 对象中的小时值。
setUTCHours	(hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number	使用协调世界时（UTC）设置 Date 对象中的小时值。
setDate	(date: number) => number	使用本地时间设置 Date 对象的月份中的日期数值。
setUTCDate	(date: number) => number	使用协调世界时（UTC）设置 Date 对象中的月份日期数值。
setMonth	(month: number, date?: number \| undefined) => number	使用本地时间设置 Date 对象中的月份值。
setUTCMonth	(month: number, date?: number \| undefined) => number	使用协调世界时（UTC）设置 Date 对象中的月份值。
setFullYear	(year: number, month?: number \| undefined, date?: number \| undefined) => number	使用本地时间设置 Date 对象的年份。
setUTCFullYear	(year: number, month?: number \| undefined, date?: number \| undefined) => number	使用协调世界时（UTC）设置 Date 对象中的年份值。
toUTCString	() => string	返回使用协调世界时（UTC）转换为字符串的日期。
toISOString	() => string	以 ISO 格式的字符串值形式返回日期。
toJSON	(key?: any) => string	由 JSON.stringify 方法使用，以实现对象数据到 JavaScript Object Notation (JSON) 序列化的转换。

ScheduleOn

属性	类型
`year`	`number`
`month`	`number`
`day`	`number`
`weekday`	`Weekday`
`hour`	`number`
`minute`	`number`
`second`	`number`

Attachment

表示通知附件。

属性	类型	描述	Since
`id`	`string`	附件标识符。	1.0.0
`url`	`string`	附件的 URL。使用 `res` 方案来引用 Web 资源，例如 `res:///assets/img/icon.png`。也接受 `file` URL。	1.0.0
`options`	`AttachmentOptions`	附件选项。	1.0.0

AttachmentOptions

属性	类型	描述	Since
`iosUNNotificationAttachmentOptionsTypeHintKey`	`string`	在 `UNNotificationAttachment` 的可哈希选项中设置 `UNNotificationAttachmentOptionsTypeHintKey` 键。仅适用于 iOS。	1.0.0
`iosUNNotificationAttachmentOptionsThumbnailHiddenKey`	`string`	在 `UNNotificationAttachment` 的可哈希选项中设置 `UNNotificationAttachmentOptionsThumbnailHiddenKey` 键。仅适用于 iOS。	1.0.0
`iosUNNotificationAttachmentOptionsThumbnailClippingRectKey`	`string`	在 `UNNotificationAttachment` 的可哈希选项中设置 `UNNotificationAttachmentOptionsThumbnailClippingRectKey` 键。仅适用于 iOS。	1.0.0
`iosUNNotificationAttachmentOptionsThumbnailTimeKey`	`string`	在 `UNNotificationAttachment` 的可哈希选项中设置 `UNNotificationAttachmentOptionsThumbnailTimeKey` 键。仅适用于 iOS。	1.0.0

PendingResult

属性	类型	描述	Since
`notifications`	`PendingLocalNotificationSchema[]`	待处理的通知列表。	1.0.0

PendingLocalNotificationSchema

属性	类型	描述	Since
`title`	`string`	通知的标题。	1.0.0
`body`	`string`	通知的正文，显示在标题下方。	1.0.0
`id`	`number`	通知标识符。	1.0.0
`schedule`	`Schedule`	安排此通知在稍后时间触发。	1.0.0
`extra`	`any`	设置存储在此通知中的附加数据。	1.0.0

RegisterActionTypesOptions

属性	类型	描述	Since
`types`	`ActionType[]`	要注册的操作类型列表。	1.0.0

ActionType

操作的集合。

属性	类型	描述	Since
`id`	`string`	操作类型的 ID。在通知中通过 `actionTypeId` 键引用。	1.0.0
`actions`	`Action[]`	与此操作类型关联的操作列表。	1.0.0
`iosHiddenPreviewsBodyPlaceholder`	`string`	设置 `UNNotificationCategory` 的 `hiddenPreviewsBodyPlaceholder`。仅适用于 iOS。	1.0.0
`iosCustomDismissAction`	`boolean`	在 `UNNotificationCategory` 的选项中设置 `customDismissAction`。仅适用于 iOS。	1.0.0
`iosAllowInCarPlay`	`boolean`	在 `UNNotificationCategory` 的选项中设置 `allowInCarPlay`。仅适用于 iOS。	1.0.0
`iosHiddenPreviewsShowTitle`	`boolean`	在 `UNNotificationCategory` 的选项中设置 `hiddenPreviewsShowTitle`。仅适用于 iOS。	1.0.0
`iosHiddenPreviewsShowSubtitle`	`boolean`	在 `UNNotificationCategory` 的选项中设置 `hiddenPreviewsShowSubtitle`。仅适用于 iOS。	1.0.0

Action

显示通知时可以执行的操作。

属性	类型	描述	Since
`id`	`string`	操作标识符。在 `'actionPerformed'` 事件中作为 `actionId` 引用。	1.0.0
`title`	`string`	为此操作显示的标题文本。	1.0.0
`requiresAuthentication`	`boolean`	在 `UNNotificationAction` 的选项中设置 `authenticationRequired`。仅适用于 iOS。	1.0.0
`foreground`	`boolean`	在 `UNNotificationAction` 的选项中设置 `foreground`。仅适用于 iOS。	1.0.0
`destructive`	`boolean`	在 `UNNotificationAction` 的选项中设置 `destructive`。仅适用于 iOS。	1.0.0
`input`	`boolean`	使用 `UNTextInputNotificationAction` 而不是 `UNNotificationAction`。仅适用于 iOS。	1.0.0
`inputButtonTitle`	`string`	在 `UNTextInputNotificationAction` 上设置 `textInputButtonTitle`。仅适用于 iOS 且 `input` 为 `true` 时。	1.0.0
`inputPlaceholder`	`string`	在 `UNTextInputNotificationAction` 上设置 `textInputPlaceholder`。仅适用于 iOS 且 `input` 为 `true` 时。	1.0.0

CancelOptions

属性	类型	描述	Since
`notifications`	`LocalNotificationDescriptor[]`	要取消的通知列表。	1.0.0

EnabledResult

属性	类型	描述	Since
`value`	`boolean`	设备是否已启用本地通知。	1.0.0

DeliveredNotifications

属性	类型	描述	Since
`notifications`	`DeliveredNotificationSchema[]`	通知屏幕上可见的通知列表。	1.0.0

DeliveredNotificationSchema

属性	类型	描述	Since
`id`	`number`	通知标识符。	4.0.0
`tag`	`string`	通知标签。仅适用于 Android。	4.0.0
`title`	`string`	通知的标题。	4.0.0
`body`	`string`	通知的正文，显示在标题下方。	4.0.0
`group`	`string`	通知的已配置分组。仅适用于 Android。	4.0.0
`groupSummary`	`boolean`	此通知是否为一组通知的摘要。仅适用于 Android。	4.0.0
`data`	`any`	通知负载中包含的任何附加数据。仅适用于 Android。	4.0.0
`extra`	`any`	存储在此通知中的附加数据。仅适用于 iOS。	4.0.0
`attachments`	`Attachment[]`	此通知的附件。仅适用于 iOS。	1.0.0
`actionTypeId`	`string`	与此通知关联的操作类型。仅适用于 iOS。	4.0.0
`schedule`	`Schedule`	用于触发此通知的安排计划。仅适用于 iOS。	4.0.0
`sound`	`string`	显示通知时使用的声音。仅适用于 iOS。	4.0.0

Channel

属性	类型	描述	默认值	Since
`id`	`string`	渠道标识符。		1.0.0
`name`	`string`	此渠道的人类可读名称（向用户显示）。		1.0.0
`description`	`string`	此渠道的描述（向用户显示）。		1.0.0
`sound`	`string`	投递到此渠道的通知应播放的声音。重要性至少为 `3` 的通知渠道应有声音。声音文件的文件名应相对于 android 应用 `res/raw` 目录指定。如果未提供声音或找不到声音文件，则不使用声音。		1.0.0
`importance`	`Importance`	投递到此渠道的通知的打扰级别。	`3`	1.0.0
`visibility`	`Visibility`	投递到此渠道的通知的可见性。此设置用于控制投递到此渠道的通知是否显示在锁屏上，如果显示，是否以编辑形式显示。		1.0.0
`lights`	`boolean`	投递到此渠道的通知是否应在支持的设备上显示通知灯。		1.0.0
`lightColor`	`string`	投递到此渠道的通知的灯光颜色。仅在此渠道上启用了灯光且设备支持时有效。支持的颜色格式为 `#RRGGBB` 和 `#RRGGBBAA`。		1.0.0
`vibration`	`boolean`	投递到此渠道的通知是否应振动。		1.0.0

ListChannelsResult

属性	类型	描述	Since
`channels`	`Channel[]`	通知渠道列表。	1.0.0

PermissionStatus

属性	类型	描述	Since
`display`	`PermissionState`	显示通知的权限状态。	1.0.0

SettingsPermissionStatus

属性	类型	描述	Since
`exact_alarm`	`PermissionState`	使用精确闹钟的权限状态。	6.0.0

PluginListenerHandle

属性	类型
`remove`	`() => Promise<void>`

ActionPerformed

属性	类型	描述	Since
`actionId`	`string`	已执行操作的标识符。	1.0.0
`inputValue`	`string`	用户在通知上输入的值。仅适用于 iOS 上 `input` 设置为 `true` 的通知。	1.0.0
`notification`	`LocalNotificationSchema`	原始通知模式。	1.0.0

类型别名

ScheduleEvery

InterruptionLevel

指示通知优先级和投递时机的打扰级别。

active：系统立即呈现通知，点亮屏幕，并可播放声音。
critical：系统立即呈现通知，点亮屏幕，并绕过静音开关播放声音。需要 Critical Alerts 授权。
passive：系统将通知添加到通知列表，不点亮屏幕也不播放声音。
timeSensitive：系统立即呈现通知，点亮屏幕，可播放声音，并突破系统通知控制。需要 Time Sensitive Notifications 功能。没有此功能，通知可能无法突破更严格的专注模式（如勿扰模式）。即使拥有此功能，用户也可以在设置中按专注模式禁用 Time Sensitive 通知。更多详情请参见 Time Sensitive 通知。

'active' | 'critical' | 'passive' | 'timeSensitive'

Importance

重要性级别。更多详情请参见 Android 开发者文档。

0 | 1 | 2 | 3 | 4 | 5

Visibility

通知可见性。更多详情请参见 Android 开发者文档。

-1 | 0 | 1

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

枚举

Weekday

Members	Value
`Sunday`	`1`
`Monday`	`2`
`Tuesday`	`3`
`Wednesday`	`4`
`Thursday`	`5`
`Friday`	`6`
`Saturday`	`7`

安装​

Android​

配置​

示例​

Doze（低电耗模式）​

API​

schedule(...)​

getPending()​

registerActionTypes(...)​

cancel(...)​

areEnabled()​

getDeliveredNotifications()​

removeDeliveredNotifications(...)​

removeAllDeliveredNotifications()​

createChannel(...)​

deleteChannel(...)​

listChannels()​

checkPermissions()​

requestPermissions()​

changeExactNotificationSetting()​

checkExactNotificationSetting()​

addListener('localNotificationReceived', ...)​

addListener('localNotificationActionPerformed', ...)​

removeAllListeners()​

接口​

ScheduleResult​

LocalNotificationDescriptor​

ScheduleOptions​

LocalNotificationSchema​

Schedule​

Date​

ScheduleOn​

Attachment​

AttachmentOptions​

PendingResult​

PendingLocalNotificationSchema​

RegisterActionTypesOptions​

ActionType​

Action​

CancelOptions​

EnabledResult​

DeliveredNotifications​

DeliveredNotificationSchema​

Channel​

ListChannelsResult​

PermissionStatus​

SettingsPermissionStatus​

PluginListenerHandle​

ActionPerformed​

类型别名​

ScheduleEvery​

InterruptionLevel​

Importance​

Visibility​

PermissionState​

枚举​

Weekday​

Contents

安装

Android

配置

示例

Doze（低电耗模式）

API

schedule(...)

getPending()

registerActionTypes(...)

cancel(...)

areEnabled()

getDeliveredNotifications()

removeDeliveredNotifications(...)

removeAllDeliveredNotifications()

createChannel(...)

deleteChannel(...)

listChannels()

checkPermissions()

requestPermissions()

changeExactNotificationSetting()

checkExactNotificationSetting()

addListener('localNotificationReceived', ...)

addListener('localNotificationActionPerformed', ...)

removeAllListeners()

接口

ScheduleResult

LocalNotificationDescriptor

ScheduleOptions

LocalNotificationSchema

Schedule

Date

ScheduleOn

Attachment

AttachmentOptions

PendingResult

PendingLocalNotificationSchema

RegisterActionTypesOptions

ActionType

Action

CancelOptions

EnabledResult

DeliveredNotifications

DeliveredNotificationSchema

Channel

ListChannelsResult

PermissionStatus

SettingsPermissionStatus

PluginListenerHandle

ActionPerformed

类型别名

ScheduleEvery

InterruptionLevel

Importance

Visibility

PermissionState

枚举

Weekday