@capacitor/local-notifications 8.3.0 → 8.3.1

package/CapacitorLocalNotifications.podspec

@@ -9,8 +9,8 @@ Pod::Spec.new do |s|
   s.license = package['license']
   s.homepage = 'https://capacitorjs.com'
   s.author = package['author']
-  s.source = { :git => 'https://github.com/ionic-team/capacitor-local-notifications.git', :tag => package['name'] + '@' + package['version'] }
-  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}', 'local-notifications/ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.source = { :git => 'https://github.com/ionic-team/capacitor-local-notifications.git', :tag => 'v' + package['version'] }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'

package/README.md

@@ -89,6 +89,31 @@ export default config;
 
 If the device has entered [Doze](https://developer.android.com/training/monitoring-device-state/doze-standby) mode, your application may have restricted capabilities. If you need your notification to fire even during Doze, schedule your notification by using `allowWhileIdle: true`. Make use of `allowWhileIdle` judiciously, as these notifications [can only fire once per 9 minutes, per app.](https://developer.android.com/training/monitoring-device-state/doze-standby#assessing_your_app)
 
+## Errors
+
+Starting on version 8.3.0, the plugin returns structured errors on Android and iOS. Each error has a `code` (e.g. `OS-PLUG-LNOT-0001`) and a `message` with a human-readable description. Codes 0001, 0002, 0005, 0006, 0011 and 0012 mean the same thing on both platforms; every other code is platform-specific.
+
+| Error code | Platform(s) | Description |
+|---|---|---|
+| OS-PLUG-LNOT-0001 | Android, iOS | Must provide a notifications array as the notifications option. |
+| OS-PLUG-LNOT-0002 | Android, iOS | Notification is missing an identifier. |
+| OS-PLUG-LNOT-0003 | iOS | Unable to build the notification content. |
+| OS-PLUG-LNOT-0004 | iOS | Unable to create the notification, trigger construction failed. |
+| OS-PLUG-LNOT-0005 | Android, iOS | Notifications are not enabled on this device. |
+| OS-PLUG-LNOT-0006 | Android, iOS | Invalid color provided. Must be a hex string (e.g. #ff0000). |
+| OS-PLUG-LNOT-0007 | Android | Provided notification format is invalid. |
+| OS-PLUG-LNOT-0008 | Android | Invalid date format sent to the plugin. |
+| OS-PLUG-LNOT-0009 | Android | The identifier must be a 32-bit integer. |
+| OS-PLUG-LNOT-0010 | iOS | Unable to schedule the notification. |
+| OS-PLUG-LNOT-0011 | Android, iOS | Expected notifications to be a list of notification objects. |
+| OS-PLUG-LNOT-0012 | Android, iOS | Must provide an ids array. |
+| OS-PLUG-LNOT-0013 | iOS | Unable to request notification permission. |
+| OS-PLUG-LNOT-0014 | Android | Invalid JSON object sent to the plugin. |
+| OS-PLUG-LNOT-0015 | Android | Channel is missing an identifier. |
+| OS-PLUG-LNOT-0016 | Android | Channel is missing a name. |
+| OS-PLUG-LNOT-0017 | Android | Unable to schedule an exact alarm due to lack of permissions. Scheduled as an inexact alarm instead. |
+| OS-PLUG-LNOT-0018 | Android | Unable to schedule an exact alarm due to lack of permissions. |
+
 ## API
 
 <docgen-index>
@@ -133,7 +158,7 @@ schedule(options: ScheduleOptions) => Promise<ScheduleResult>
 
 <a href="#schedule">Schedule</a> one or more local notifications.
 
-On both platforms this now requests the notification permission it needs
+Starting on version 8.3.0 this requests the notification permission it needs
 before scheduling if it has not been granted yet (Android 13+
 `POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps
 that already call `requestPermissions()` beforehand are unaffected.

package/android/build.gradle

@@ -30,8 +30,8 @@ if (project.extensions.findByName('kotlin') == null) {
 }
 if (System.getenv("CAP_PLUGIN_PUBLISH") == "true") {
     apply plugin: 'io.github.gradle-nexus.publish-plugin'
-    apply from: file('../../scripts/android/publish-root.gradle')
-    apply from: file('../../scripts/android/publish-module.gradle')
+    apply from: file('../scripts/android/publish-root.gradle')
+    apply from: file('../scripts/android/publish-module.gradle')
 }
 
 android {

package/dist/docs.json

@@ -22,7 +22,7 @@
             "text": "1.0.0"
           }
         ],
-        "docs": "Schedule one or more local notifications.\n\nOn both platforms this now requests the notification permission it needs\nbefore scheduling if it has not been granted yet (Android 13+\n`POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps\nthat already call `requestPermissions()` beforehand are unaffected.",
+        "docs": "Schedule one or more local notifications.\n\nStarting on version 8.3.0 this requests the notification permission it needs\nbefore scheduling if it has not been granted yet (Android 13+\n`POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps\nthat already call `requestPermissions()` beforehand are unaffected.",
         "complexTypes": [
           "ScheduleResult",
           "ScheduleOptions"

package/dist/esm/definitions.d.ts

@@ -65,7 +65,7 @@ export interface LocalNotificationsPlugin {
     /**
      * Schedule one or more local notifications.
      *
-     * On both platforms this now requests the notification permission it needs
+     * Starting on version 8.3.0 this requests the notification permission it needs
      * before scheduling if it has not been granted yet (Android 13+
      * `POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps
      * that already call `requestPermissions()` beforehand are unaffected.

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC;AAw1CxC;;GAEG;AACH,MAAM,CAAN,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,yCAAU,CAAA;IACV,yCAAU,CAAA;IACV,2CAAW,CAAA;IACX,+CAAa,CAAA;IACb,6CAAY,CAAA;IACZ,yCAAU,CAAA;IACV,6CAAY,CAAA;AACd,CAAC,EARW,OAAO,KAAP,OAAO,QAQlB","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type LocalNotificationPresentationOption = 'badge' | 'sound' | 'banner' | 'list';\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * The Local Notifications can be configured with the following options:\n     */\n    LocalNotifications?: {\n      /**\n       * Set the default status bar icon for notifications.\n       *\n       * Icons should be placed in your app's `res/drawable` folder. The value for\n       * this option should be the drawable resource ID, which is the filename\n       * without an extension.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"ic_stat_icon_config_sample\"\n       */\n      smallIcon?: string;\n\n      /**\n       * Set the default color of status bar icons for notifications.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"#488AFF\"\n       */\n      iconColor?: string;\n\n      /**\n       * Set the default notification sound for notifications.\n       *\n       * On Android 8+ it sets the default channel sound and can't be\n       * changed unless the app is uninstalled.\n       *\n       * If the audio file is not found, it will result in the default system\n       * sound being played on Android 7.x and no sound on Android 8+.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"beep.wav\"\n       */\n      sound?: string;\n\n      /**\n       * This is an array of strings you can combine. Possible values in the array are:\n       *   - `badge`: badge count on the app icon is updated (default value)\n       *   - `sound`: the device will ring/vibrate when the notification is received\n       *   - `banner`: the notification is displayed as a banner\n       *   - `list`: the notification is displayed in the notification center\n       *\n       * An empty array can be provided if none of the options are desired.\n       *\n       * Only available for iOS.\n       *\n       * @since 8.2.0\n       * @example [\"badge\", \"sound\", \"banner\", \"list\"]\n       */\n      presentationOptions?: LocalNotificationPresentationOption[];\n    };\n  }\n}\n\nexport interface LocalNotificationsPlugin {\n  /**\n   * Schedule one or more local notifications.\n   *\n   * On both platforms this now requests the notification permission it needs\n   * before scheduling if it has not been granted yet (Android 13+\n   * `POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps\n   * that already call `requestPermissions()` beforehand are unaffected.\n   *\n   * @since 1.0.0\n   */\n  schedule(options: ScheduleOptions): Promise<ScheduleResult>;\n\n  /**\n   * Update one or more previously scheduled local notifications, matched by `id`.\n   *\n   * Notifications whose `id` is not currently scheduled are ignored. Like\n   * `schedule`, this requests the notification permission if needed.\n   *\n   * @since 8.3.0\n   */\n  update(options: ScheduleOptions): Promise<ScheduleResult>;\n\n  /**\n   * Get a list of pending notifications.\n   *\n   * @since 1.0.0\n   */\n  getPending(): Promise<PendingResult>;\n\n  /**\n   * Register actions to take when notifications are displayed.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  registerActionTypes(options: RegisterActionTypesOptions): Promise<void>;\n\n  /**\n   * Cancel pending notifications.\n   *\n   * @since 1.0.0\n   */\n  cancel(options: CancelOptions): Promise<void>;\n\n  /**\n   * Cancel all pending (scheduled) notifications.\n   *\n   * @since 8.3.0\n   */\n  cancelAll(): Promise<void>;\n\n  /**\n   * Check if notifications are enabled or not.\n   *\n   * @deprecated Use `checkPermissions()` to check if the user has allowed\n   * notifications to be displayed.\n   * @since 1.0.0\n   */\n  areEnabled(): Promise<EnabledResult>;\n\n  /**\n   * Get a list of notifications that are visible on the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  getDeliveredNotifications(): Promise<DeliveredNotifications>;\n\n  /**\n   * Remove the specified notifications from the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  removeDeliveredNotifications(delivered: DeliveredNotifications): Promise<void>;\n\n  /**\n   * Remove the specified delivered notifications from the notifications screen,\n   * matched by `id`.\n   *\n   * Id-based counterpart of `removeDeliveredNotifications`, so callers that only\n   * have identifiers (e.g. the OutSystems `ClearNotifications` action) can map to\n   * a single method call.\n   *\n   * @since 8.3.0\n   */\n  removeDeliveredNotificationsById(options: RemoveByIdsOptions): Promise<void>;\n\n  /**\n   * Remove all the notifications from the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  removeAllDeliveredNotifications(): Promise<void>;\n\n  /**\n   * Get the notifications matching the supplied identifiers, whether they are\n   * still scheduled (pending) or already delivered.\n   *\n   * @since 8.3.0\n   */\n  getByIds(options: GetByIdsOptions): Promise<GetNotificationsResult>;\n\n  /**\n   * Get all notifications known to the plugin, optionally filtered by state.\n   *\n   * When `state` is omitted both scheduled and delivered notifications are\n   * returned. `SCHEDULED` returns pending notifications; `TRIGGERED` returns\n   * delivered notifications.\n   *\n   * @since 8.3.0\n   */\n  getAll(options?: GetAllOptions): Promise<GetNotificationsResult>;\n\n  /**\n   * Create a notification channel.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  createChannel(channel: Channel): Promise<void>;\n\n  /**\n   * Delete a notification channel.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  deleteChannel(args: { id: string }): Promise<void>;\n\n  /**\n   * Get a list of notification channels.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  listChannels(): Promise<ListChannelsResult>;\n\n  /**\n   * Check permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Direct user to the application settings screen to configure exact alarms.\n   *\n   * In the event that a user changes the settings from granted to denied, the application\n   * will restart and any notification scheduled with an exact alarm will be deleted.\n   *\n   * On Android < 12, the user will NOT be directed to the application settings screen, instead this function will\n   * return `granted`.\n   *\n   * Only available on Android.\n   *\n   * @since 6.0.0\n   */\n  changeExactNotificationSetting(): Promise<SettingsPermissionStatus>;\n\n  /**\n   * Check application setting for using exact alarms.\n   *\n   * Only available on Android.\n   *\n   * @since 6.0.0\n   */\n  checkExactNotificationSetting(): Promise<SettingsPermissionStatus>;\n\n  /**\n   * Listen for when notifications are displayed.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'localNotificationReceived',\n    listenerFunc: (notification: LocalNotificationSchema) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for when an action is performed on a notification.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'localNotificationActionPerformed',\n    listenerFunc: (notificationAction: ActionPerformed) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * The object that describes a local notification.\n *\n * @since 1.0.0\n */\nexport interface LocalNotificationDescriptor {\n  /**\n   * The notification identifier.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n}\n\nexport interface ScheduleOptions {\n  /**\n   * The list of notifications to schedule.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationSchema[];\n}\n\nexport interface ScheduleResult {\n  /**\n   * The list of scheduled notifications.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationDescriptor[];\n\n  /**\n   * Set when at least one notification in this call had `isExactNotification`\n   * `true` (the default) but the exact-alarm permission was not granted: it\n   * was scheduled as an inexact alarm instead. Absent on `update()` calls and\n   * whenever every applicable notification got its requested exactness.\n   *\n   * @since 8.3.0\n   */\n  warning?: ScheduleWarning;\n}\n\n/**\n * A non-fatal warning returned alongside a successful result.\n *\n * @since 8.3.0\n */\nexport interface ScheduleWarning {\n  /**\n   * The `OS-PLUG-LNOT-NNNN` warning code.\n   *\n   * @since 8.3.0\n   */\n  code: string;\n\n  /**\n   * A human-readable description of the warning.\n   *\n   * @since 8.3.0\n   */\n  message: string;\n}\n\nexport interface PendingResult {\n  /**\n   * The list of pending notifications.\n   *\n   * @since 1.0.0\n   */\n  notifications: PendingLocalNotificationSchema[];\n}\n\nexport interface RegisterActionTypesOptions {\n  /**\n   * The list of action types to register.\n   *\n   * @since 1.0.0\n   */\n  types: ActionType[];\n}\n\nexport interface CancelOptions {\n  /**\n   * The list of notifications to cancel.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationDescriptor[];\n}\n\n/**\n * The notification state used to filter `getAll`.\n *\n * - `SCHEDULED`: notifications that are pending delivery.\n * - `TRIGGERED`: notifications that have already been delivered.\n *\n * @since 8.3.0\n */\nexport type NotificationState = 'SCHEDULED' | 'TRIGGERED';\n\nexport interface RemoveByIdsOptions {\n  /**\n   * The identifiers of the delivered notifications to remove.\n   *\n   * @since 8.3.0\n   */\n  ids: number[];\n}\n\nexport interface GetByIdsOptions {\n  /**\n   * The identifiers of the notifications to retrieve.\n   *\n   * @since 8.3.0\n   */\n  ids: number[];\n}\n\nexport interface GetAllOptions {\n  /**\n   * Filter the returned notifications by state. When omitted, both scheduled\n   * and delivered notifications are returned.\n   *\n   * @since 8.3.0\n   */\n  state?: NotificationState;\n}\n\nexport interface GetNotificationsResult {\n  /**\n   * The list of notifications matching the query.\n   *\n   * @since 8.3.0\n   */\n  notifications: LocalNotificationSchema[];\n}\n\n/**\n * A collection of actions.\n *\n * @since 1.0.0\n */\nexport interface ActionType {\n  /**\n   * The ID of the action type.\n   *\n   * Referenced in notifications by the `actionTypeId` key.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The list of actions associated with this action type.\n   *\n   * @since 1.0.0\n   */\n  actions?: Action[];\n\n  /**\n   * Sets `hiddenPreviewsBodyPlaceholder` of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsBodyPlaceholder?: string;\n\n  /**\n   * Sets `customDismissAction` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosCustomDismissAction?: boolean;\n\n  /**\n   * Sets `allowInCarPlay` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosAllowInCarPlay?: boolean;\n\n  /**\n   * Sets `hiddenPreviewsShowTitle` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsShowTitle?: boolean;\n\n  /**\n   * Sets `hiddenPreviewsShowSubtitle` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsShowSubtitle?: boolean;\n}\n\n/**\n * An action that can be taken when a notification is displayed.\n *\n * @since 1.0.0\n */\nexport interface Action {\n  /**\n   * The action identifier.\n   *\n   * Referenced in the `'actionPerformed'` event as `actionId`.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The title text to display for this action.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * Sets `authenticationRequired` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  requiresAuthentication?: boolean;\n\n  /**\n   * Sets `foreground` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  foreground?: boolean;\n\n  /**\n   * Sets `destructive` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  destructive?: boolean;\n\n  /**\n   * Use a `UNTextInputNotificationAction` instead of a `UNNotificationAction`.\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  input?: boolean;\n\n  /**\n   * Sets `textInputButtonTitle` on the\n   * [`UNTextInputNotificationAction`](https://developer.apple.com/documentation/usernotifications/untextinputnotificationaction).\n   *\n   * Only available for iOS when `input` is `true`.\n   *\n   * @since 1.0.0\n   */\n  inputButtonTitle?: string;\n\n  /**\n   * Sets `textInputPlaceholder` on the\n   * [`UNTextInputNotificationAction`](https://developer.apple.com/documentation/usernotifications/untextinputnotificationaction).\n   *\n   * Only available for iOS when `input` is `true`.\n   *\n   * @since 1.0.0\n   */\n  inputPlaceholder?: string;\n}\n\n/**\n * Represents a notification attachment.\n *\n * @since 1.0.0\n */\nexport interface Attachment {\n  /**\n   * The attachment identifier.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The URL to the attachment.\n   *\n   * Use the `res` scheme to reference web assets, e.g.\n   * `res:///assets/img/icon.png`. Also accepts `file` URLs.\n   *\n   * @since 1.0.0\n   */\n  url: string;\n\n  /**\n   * Attachment options.\n   *\n   * @since 1.0.0\n   */\n  options?: AttachmentOptions;\n}\n\nexport interface AttachmentOptions {\n  /**\n   * Sets the `UNNotificationAttachmentOptionsTypeHintKey` key in the hashable\n   * options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsTypeHintKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailHiddenKey` key in the\n   * hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailHiddenKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailClippingRectKey` key in\n   * the hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailClippingRectKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailTimeKey` key in the\n   * hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailTimeKey?: string;\n}\n\nexport interface PendingLocalNotificationSchema {\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n\n  /**\n   * The notification identifier.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n\n  /**\n   * Schedule this notification for a later time.\n   *\n   * @since 1.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n}\n\nexport interface LocalNotificationSchema {\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n\n  /**\n   * Schedule this notification for a later time.\n   *\n   * @since 1.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android 7.x.\n   * For Android 8+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n\n  /**\n   * Set the color of the notification icon.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  iconColor?: string;\n\n  /**\n   * Set attachments for this notification.\n   *\n   * @since 1.0.0\n   */\n  attachments?: Attachment[];\n\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   * @deprecated Use `relevanceScore` instead. This property is ignored on iOS 15+.\n   */\n  summaryArgument?: string;\n\n  /**\n   * The score the system uses to determine if the notification is the\n   * featured notification when the system groups the app's notifications.\n   *\n   * The value must be between 0 and 1, where 0 is the least relevant and\n   * 1 is the most relevant. The default value is 0.\n   *\n   * Sets `relevanceScore` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 8.1.0\n   */\n  relevanceScore?: number;\n\n  /**\n   * The interruption level that indicates the priority and delivery timing of a notification.\n   *\n   * Sets `interruptionLevel` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 8.1.0\n   */\n  interruptionLevel?: InterruptionLevel;\n\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: boolean;\n\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 8+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n\n  /**\n   * Sets a list of strings for display in an inbox style notification.\n   *\n   * Up to 5 strings are allowed.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  inboxList?: string[];\n\n  /**\n   * If true, notification will not appear while app is in the foreground.\n   *\n   * Only available for iOS.\n   *\n   * @since 5.0.0\n   */\n  silent?: boolean;\n\n  /**\n   * The number to display on the app icon badge when this notification is\n   * delivered.\n   *\n   * On iOS this sets the badge count on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   * On Android this calls `setNumber()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder).\n   *\n   * @since 8.3.0\n   */\n  badge?: number;\n\n  /**\n   * Whether the notification should be presented while the app is in the\n   * foreground.\n   *\n   * On iOS `true` forces the notification to be shown even while the app is\n   * foregrounded, while `false` suppresses it (it is still delivered to the\n   * `localNotificationReceived` listener). This is independent of `silent`;\n   * when both are provided, `foreground` takes precedence.\n   * On Android it raises the notification priority so it can present as a\n   * heads-up notification.\n   *\n   * @since 8.3.0\n   */\n  foreground?: boolean;\n\n  /**\n   * Whether this notification should be scheduled with an exact alarm.\n   *\n   * Only available for Android. Defaults to `true`: on `schedule()` (API 31+),\n   * if the app isn't yet allowed to schedule exact alarms the system \"Alarms &\n   * reminders\" settings screen is opened so the user can grant it — regardless\n   * of `isExactMandatory`. If the user still declines, the notification falls\n   * back to an inexact alarm (unless `isExactMandatory` is also set, in which\n   * case the call is rejected instead); a fallback like this sets\n   * `ScheduleResult.warning`. `update()` never prompts and falls back silently.\n   * Set to `false` to schedule this notification as inexact outright,\n   * regardless of permission state.\n   *\n   * @since 8.3.0\n   * @default true\n   */\n  isExactNotification?: boolean;\n\n  /**\n   * Whether an exact alarm is mandatory for this notification.\n   *\n   * Only available for Android, and only meaningful when\n   * `isExactNotification` is `true` (the default) and on `schedule()` calls.\n   * If the exact-alarm permission is denied and any notification being\n   * scheduled has this set to `true`, the whole `schedule()` call is rejected\n   * instead of falling back to an inexact alarm. Has no effect on `update()`:\n   * it never enforces this, and simply falls back to inexact like a\n   * non-mandatory notification would.\n   *\n   * @since 8.3.0\n   * @default false\n   */\n  isExactMandatory?: boolean;\n}\n\n/**\n * Represents a schedule for a notification.\n *\n * Use either `at`, `on`, or `every` to schedule notifications.\n *\n * @since 1.0.0\n */\nexport interface Schedule {\n  /**\n   * Schedule a notification at a specific date and time.\n   *\n   * @since 1.0.0\n   */\n  at?: Date;\n\n  /**\n   * Repeat delivery of this notification at the date and time specified by\n   * `at`.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  repeats?: boolean;\n\n  /**\n   * Allow this notification to fire while in [Doze](https://developer.android.com/training/monitoring-device-state/doze-standby)\n   *\n   * Note that these notifications can only fire [once per 9 minutes, per app](https://developer.android.com/training/monitoring-device-state/doze-standby#assessing_your_app).\n   *\n   * @since 1.0.0\n   */\n  allowWhileIdle?: boolean;\n\n  /**\n   * Schedule a notification on particular interval(s).\n   *\n   * This is similar to scheduling [cron](https://en.wikipedia.org/wiki/Cron)\n   * jobs.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  on?: ScheduleOn;\n\n  /**\n   * Schedule a notification on a particular interval.\n   *\n   * @since 1.0.0\n   */\n  every?: ScheduleEvery;\n\n  /**\n   * Limit the number times a notification is delivered by the interval\n   * specified by `every`.\n   *\n   * @since 1.0.0\n   */\n  count?: number;\n}\n\nexport interface ScheduleOn {\n  year?: number;\n  month?: number;\n  day?: number;\n  weekday?: Weekday;\n  hour?: number;\n  minute?: number;\n  second?: number;\n}\n\nexport type ScheduleEvery = 'year' | 'month' | 'two-weeks' | 'week' | 'day' | 'hour' | 'minute' | 'second';\n\n/**\n * The interruption level that indicates the priority and delivery timing of a notification.\n *\n * - `active`: The system presents the notification immediately, lights up the screen, and can play a sound.\n * - `critical`: The system presents the notification immediately, lights up the screen, and bypasses the mute switch to play a sound.\n *   Requires the [Critical Alerts entitlement](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.usernotifications.critical-alerts).\n * - `passive`: The system adds the notification to the notification list without lighting up the screen or playing a sound.\n * - `timeSensitive`: The system presents the notification immediately, lights up the screen, can play a sound, and breaks through system notification controls.\n *   Requires the Time Sensitive Notifications capability. Without it, the notification may not break through stricter Focus modes such as Do Not Disturb.\n *   Even with the capability, the user can disable Time Sensitive notifications per Focus mode in Settings.\n *   See [Time Sensitive notifications](https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/timesensitive) for more details.\n *\n * @since 8.1.0\n */\nexport type InterruptionLevel = 'active' | 'critical' | 'passive' | 'timeSensitive';\n\nexport interface ListChannelsResult {\n  /**\n   * The list of notification channels.\n   *\n   * @since 1.0.0\n   */\n  channels: Channel[];\n}\n\nexport interface PermissionStatus {\n  /**\n   * Permission state of displaying notifications.\n   *\n   * @since 1.0.0\n   */\n  display: PermissionState;\n}\n\nexport interface SettingsPermissionStatus {\n  /**\n   * Permission state of using exact alarms.\n   *\n   * @since 6.0.0\n   */\n  exact_alarm: PermissionState;\n}\n\nexport interface ActionPerformed {\n  /**\n   * The identifier of the performed action.\n   *\n   * @since 1.0.0\n   */\n  actionId: string;\n\n  /**\n   * The value entered by the user on the notification.\n   *\n   * Only available on iOS for notifications with `input` set to `true`.\n   *\n   * @since 1.0.0\n   */\n  inputValue?: string;\n\n  /**\n   * The original notification schema.\n   *\n   * @since 1.0.0\n   */\n  notification: LocalNotificationSchema;\n}\n\n/**\n * @deprecated\n */\nexport interface EnabledResult {\n  /**\n   * Whether or not the device has local notifications enabled.\n   *\n   * @since 1.0.0\n   */\n  value: boolean;\n}\n\nexport interface DeliveredNotificationSchema {\n  /**\n   * The notification identifier.\n   *\n   * @since 4.0.0\n   */\n  id: number;\n\n  /**\n   * The notification tag.\n   *\n   * Only available on Android.\n   *\n   * @since 4.0.0\n   */\n  tag?: string;\n  /**\n   * The title of the notification.\n   *\n   * @since 4.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 4.0.0\n   */\n  body: string;\n\n  /**\n   * The configured group of the notification.\n   *\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  group?: string;\n\n  /**\n   * If this notification is the summary for a group of notifications.\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  groupSummary?: boolean;\n\n  /**\n   * Any additional data that was included in the\n   * notification payload.\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  data?: any;\n\n  /**\n   * Extra data to store within this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  extra?: any;\n\n  /**\n   * The attachments for this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  attachments?: Attachment[];\n\n  /**\n   * Action type ssociated with this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  actionTypeId?: string;\n\n  /**\n   * Schedule used to fire this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Sound that was used when the notification was displayed.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  sound?: string;\n}\n\nexport interface DeliveredNotifications {\n  /**\n   * List of notifications that are visible on the\n   * notifications screen.\n   *\n   * @since 1.0.0\n   */\n  notifications: DeliveredNotificationSchema[];\n}\n\nexport interface Channel {\n  /**\n   * The channel identifier.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The human-friendly name of this channel (presented to the user).\n   *\n   * @since 1.0.0\n   */\n  name: string;\n\n  /**\n   * The description of this channel (presented to the user).\n   *\n   * @since 1.0.0\n   */\n  description?: string;\n\n  /**\n   * The sound that should be played for notifications posted to this channel.\n   *\n   * Notification channels with an importance of at least `3` should have a\n   * sound.\n   *\n   * The file name of a sound file should be specified relative to the android\n   * app `res/raw` directory.\n   *\n   * If the sound is not provided, or the sound file is not found no sound will be used.\n   *\n   * @since 1.0.0\n   * @example \"jingle.wav\"\n   */\n  sound?: string;\n\n  /**\n   * The level of interruption for notifications posted to this channel.\n   *\n   * @default `3`\n   * @since 1.0.0\n   */\n  importance?: Importance;\n\n  /**\n   * The visibility of notifications posted to this channel.\n   *\n   * This setting is for whether notifications posted to this channel appear on\n   * the lockscreen or not, and if so, whether they appear in a redacted form.\n   *\n   * @since 1.0.0\n   */\n  visibility?: Visibility;\n\n  /**\n   * Whether notifications posted to this channel should display notification\n   * lights, on devices that support it.\n   *\n   * @since 1.0.0\n   */\n  lights?: boolean;\n\n  /**\n   * The light color for notifications posted to this channel.\n   *\n   * Only supported if lights are enabled on this channel and the device\n   * supports it.\n   *\n   * Supported color formats are `#RRGGBB` and `#RRGGBBAA`.\n   *\n   * @since 1.0.0\n   */\n  lightColor?: string;\n\n  /**\n   * Whether notifications posted to this channel should vibrate.\n   *\n   * @since 1.0.0\n   */\n  vibration?: boolean;\n}\n\n/**\n * Day of the week. Used for scheduling notifications on a particular weekday.\n */\nexport enum Weekday {\n  Sunday = 1,\n  Monday = 2,\n  Tuesday = 3,\n  Wednesday = 4,\n  Thursday = 5,\n  Friday = 6,\n  Saturday = 7,\n}\n\n/**\n * The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)\n * @since 1.0.0\n */\nexport type Importance = 0 | 1 | 2 | 3 | 4 | 5;\n\n/**\n * The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)\n * @since 1.0.0\n */\nexport type Visibility = -1 | 0 | 1;\n\n/**\n * @deprecated Use 'Channel`.\n * @since 1.0.0\n */\nexport type NotificationChannel = Channel;\n\n/**\n * @deprecated Use `LocalNotificationDescriptor`.\n * @since 1.0.0\n */\nexport type LocalNotificationRequest = LocalNotificationDescriptor;\n\n/**\n * @deprecated Use `ScheduleResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationScheduleResult = ScheduleResult;\n\n/**\n * @deprecated Use `PendingResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationPendingList = PendingResult;\n\n/**\n * @deprecated Use `ActionType`.\n * @since 1.0.0\n */\nexport type LocalNotificationActionType = ActionType;\n\n/**\n * @deprecated Use `Action`.\n * @since 1.0.0\n */\nexport type LocalNotificationAction = Action;\n\n/**\n * @deprecated Use `EnabledResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationEnabledResult = EnabledResult;\n\n/**\n * @deprecated Use `ListChannelsResult`.\n * @since 1.0.0\n */\nexport type NotificationChannelList = ListChannelsResult;\n\n/**\n * @deprecated Use `Attachment`.\n * @since 1.0.0\n */\nexport type LocalNotificationAttachment = Attachment;\n\n/**\n * @deprecated Use `AttachmentOptions`.\n * @since 1.0.0\n */\nexport type LocalNotificationAttachmentOptions = AttachmentOptions;\n\n/**\n * @deprecated Use `LocalNotificationSchema`.\n * @since 1.0.0\n */\nexport type LocalNotification = LocalNotificationSchema;\n\n/**\n * @deprecated Use `Schedule`.\n * @since 1.0.0\n */\nexport type LocalNotificationSchedule = Schedule;\n\n/**\n * @deprecated Use `ActionPerformed`.\n * @since 1.0.0\n */\nexport type LocalNotificationActionPerformed = ActionPerformed;\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC;AAw1CxC;;GAEG;AACH,MAAM,CAAN,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,yCAAU,CAAA;IACV,yCAAU,CAAA;IACV,2CAAW,CAAA;IACX,+CAAa,CAAA;IACb,6CAAY,CAAA;IACZ,yCAAU,CAAA;IACV,6CAAY,CAAA;AACd,CAAC,EARW,OAAO,KAAP,OAAO,QAQlB","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type LocalNotificationPresentationOption = 'badge' | 'sound' | 'banner' | 'list';\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * The Local Notifications can be configured with the following options:\n     */\n    LocalNotifications?: {\n      /**\n       * Set the default status bar icon for notifications.\n       *\n       * Icons should be placed in your app's `res/drawable` folder. The value for\n       * this option should be the drawable resource ID, which is the filename\n       * without an extension.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"ic_stat_icon_config_sample\"\n       */\n      smallIcon?: string;\n\n      /**\n       * Set the default color of status bar icons for notifications.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"#488AFF\"\n       */\n      iconColor?: string;\n\n      /**\n       * Set the default notification sound for notifications.\n       *\n       * On Android 8+ it sets the default channel sound and can't be\n       * changed unless the app is uninstalled.\n       *\n       * If the audio file is not found, it will result in the default system\n       * sound being played on Android 7.x and no sound on Android 8+.\n       *\n       * Only available for Android.\n       *\n       * @since 1.0.0\n       * @example \"beep.wav\"\n       */\n      sound?: string;\n\n      /**\n       * This is an array of strings you can combine. Possible values in the array are:\n       *   - `badge`: badge count on the app icon is updated (default value)\n       *   - `sound`: the device will ring/vibrate when the notification is received\n       *   - `banner`: the notification is displayed as a banner\n       *   - `list`: the notification is displayed in the notification center\n       *\n       * An empty array can be provided if none of the options are desired.\n       *\n       * Only available for iOS.\n       *\n       * @since 8.2.0\n       * @example [\"badge\", \"sound\", \"banner\", \"list\"]\n       */\n      presentationOptions?: LocalNotificationPresentationOption[];\n    };\n  }\n}\n\nexport interface LocalNotificationsPlugin {\n  /**\n   * Schedule one or more local notifications.\n   *\n   * Starting on version 8.3.0 this requests the notification permission it needs\n   * before scheduling if it has not been granted yet (Android 13+\n   * `POST_NOTIFICATIONS`, iOS `UNUserNotificationCenter` authorization). Apps\n   * that already call `requestPermissions()` beforehand are unaffected.\n   *\n   * @since 1.0.0\n   */\n  schedule(options: ScheduleOptions): Promise<ScheduleResult>;\n\n  /**\n   * Update one or more previously scheduled local notifications, matched by `id`.\n   *\n   * Notifications whose `id` is not currently scheduled are ignored. Like\n   * `schedule`, this requests the notification permission if needed.\n   *\n   * @since 8.3.0\n   */\n  update(options: ScheduleOptions): Promise<ScheduleResult>;\n\n  /**\n   * Get a list of pending notifications.\n   *\n   * @since 1.0.0\n   */\n  getPending(): Promise<PendingResult>;\n\n  /**\n   * Register actions to take when notifications are displayed.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  registerActionTypes(options: RegisterActionTypesOptions): Promise<void>;\n\n  /**\n   * Cancel pending notifications.\n   *\n   * @since 1.0.0\n   */\n  cancel(options: CancelOptions): Promise<void>;\n\n  /**\n   * Cancel all pending (scheduled) notifications.\n   *\n   * @since 8.3.0\n   */\n  cancelAll(): Promise<void>;\n\n  /**\n   * Check if notifications are enabled or not.\n   *\n   * @deprecated Use `checkPermissions()` to check if the user has allowed\n   * notifications to be displayed.\n   * @since 1.0.0\n   */\n  areEnabled(): Promise<EnabledResult>;\n\n  /**\n   * Get a list of notifications that are visible on the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  getDeliveredNotifications(): Promise<DeliveredNotifications>;\n\n  /**\n   * Remove the specified notifications from the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  removeDeliveredNotifications(delivered: DeliveredNotifications): Promise<void>;\n\n  /**\n   * Remove the specified delivered notifications from the notifications screen,\n   * matched by `id`.\n   *\n   * Id-based counterpart of `removeDeliveredNotifications`, so callers that only\n   * have identifiers (e.g. the OutSystems `ClearNotifications` action) can map to\n   * a single method call.\n   *\n   * @since 8.3.0\n   */\n  removeDeliveredNotificationsById(options: RemoveByIdsOptions): Promise<void>;\n\n  /**\n   * Remove all the notifications from the notifications screen.\n   *\n   * @since 4.0.0\n   */\n  removeAllDeliveredNotifications(): Promise<void>;\n\n  /**\n   * Get the notifications matching the supplied identifiers, whether they are\n   * still scheduled (pending) or already delivered.\n   *\n   * @since 8.3.0\n   */\n  getByIds(options: GetByIdsOptions): Promise<GetNotificationsResult>;\n\n  /**\n   * Get all notifications known to the plugin, optionally filtered by state.\n   *\n   * When `state` is omitted both scheduled and delivered notifications are\n   * returned. `SCHEDULED` returns pending notifications; `TRIGGERED` returns\n   * delivered notifications.\n   *\n   * @since 8.3.0\n   */\n  getAll(options?: GetAllOptions): Promise<GetNotificationsResult>;\n\n  /**\n   * Create a notification channel.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  createChannel(channel: Channel): Promise<void>;\n\n  /**\n   * Delete a notification channel.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  deleteChannel(args: { id: string }): Promise<void>;\n\n  /**\n   * Get a list of notification channels.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  listChannels(): Promise<ListChannelsResult>;\n\n  /**\n   * Check permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Direct user to the application settings screen to configure exact alarms.\n   *\n   * In the event that a user changes the settings from granted to denied, the application\n   * will restart and any notification scheduled with an exact alarm will be deleted.\n   *\n   * On Android < 12, the user will NOT be directed to the application settings screen, instead this function will\n   * return `granted`.\n   *\n   * Only available on Android.\n   *\n   * @since 6.0.0\n   */\n  changeExactNotificationSetting(): Promise<SettingsPermissionStatus>;\n\n  /**\n   * Check application setting for using exact alarms.\n   *\n   * Only available on Android.\n   *\n   * @since 6.0.0\n   */\n  checkExactNotificationSetting(): Promise<SettingsPermissionStatus>;\n\n  /**\n   * Listen for when notifications are displayed.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'localNotificationReceived',\n    listenerFunc: (notification: LocalNotificationSchema) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for when an action is performed on a notification.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'localNotificationActionPerformed',\n    listenerFunc: (notificationAction: ActionPerformed) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * The object that describes a local notification.\n *\n * @since 1.0.0\n */\nexport interface LocalNotificationDescriptor {\n  /**\n   * The notification identifier.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n}\n\nexport interface ScheduleOptions {\n  /**\n   * The list of notifications to schedule.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationSchema[];\n}\n\nexport interface ScheduleResult {\n  /**\n   * The list of scheduled notifications.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationDescriptor[];\n\n  /**\n   * Set when at least one notification in this call had `isExactNotification`\n   * `true` (the default) but the exact-alarm permission was not granted: it\n   * was scheduled as an inexact alarm instead. Absent on `update()` calls and\n   * whenever every applicable notification got its requested exactness.\n   *\n   * @since 8.3.0\n   */\n  warning?: ScheduleWarning;\n}\n\n/**\n * A non-fatal warning returned alongside a successful result.\n *\n * @since 8.3.0\n */\nexport interface ScheduleWarning {\n  /**\n   * The `OS-PLUG-LNOT-NNNN` warning code.\n   *\n   * @since 8.3.0\n   */\n  code: string;\n\n  /**\n   * A human-readable description of the warning.\n   *\n   * @since 8.3.0\n   */\n  message: string;\n}\n\nexport interface PendingResult {\n  /**\n   * The list of pending notifications.\n   *\n   * @since 1.0.0\n   */\n  notifications: PendingLocalNotificationSchema[];\n}\n\nexport interface RegisterActionTypesOptions {\n  /**\n   * The list of action types to register.\n   *\n   * @since 1.0.0\n   */\n  types: ActionType[];\n}\n\nexport interface CancelOptions {\n  /**\n   * The list of notifications to cancel.\n   *\n   * @since 1.0.0\n   */\n  notifications: LocalNotificationDescriptor[];\n}\n\n/**\n * The notification state used to filter `getAll`.\n *\n * - `SCHEDULED`: notifications that are pending delivery.\n * - `TRIGGERED`: notifications that have already been delivered.\n *\n * @since 8.3.0\n */\nexport type NotificationState = 'SCHEDULED' | 'TRIGGERED';\n\nexport interface RemoveByIdsOptions {\n  /**\n   * The identifiers of the delivered notifications to remove.\n   *\n   * @since 8.3.0\n   */\n  ids: number[];\n}\n\nexport interface GetByIdsOptions {\n  /**\n   * The identifiers of the notifications to retrieve.\n   *\n   * @since 8.3.0\n   */\n  ids: number[];\n}\n\nexport interface GetAllOptions {\n  /**\n   * Filter the returned notifications by state. When omitted, both scheduled\n   * and delivered notifications are returned.\n   *\n   * @since 8.3.0\n   */\n  state?: NotificationState;\n}\n\nexport interface GetNotificationsResult {\n  /**\n   * The list of notifications matching the query.\n   *\n   * @since 8.3.0\n   */\n  notifications: LocalNotificationSchema[];\n}\n\n/**\n * A collection of actions.\n *\n * @since 1.0.0\n */\nexport interface ActionType {\n  /**\n   * The ID of the action type.\n   *\n   * Referenced in notifications by the `actionTypeId` key.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The list of actions associated with this action type.\n   *\n   * @since 1.0.0\n   */\n  actions?: Action[];\n\n  /**\n   * Sets `hiddenPreviewsBodyPlaceholder` of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsBodyPlaceholder?: string;\n\n  /**\n   * Sets `customDismissAction` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosCustomDismissAction?: boolean;\n\n  /**\n   * Sets `allowInCarPlay` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosAllowInCarPlay?: boolean;\n\n  /**\n   * Sets `hiddenPreviewsShowTitle` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsShowTitle?: boolean;\n\n  /**\n   * Sets `hiddenPreviewsShowSubtitle` in the options of the\n   * [`UNNotificationCategory`](https://developer.apple.com/documentation/usernotifications/unnotificationcategory).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosHiddenPreviewsShowSubtitle?: boolean;\n}\n\n/**\n * An action that can be taken when a notification is displayed.\n *\n * @since 1.0.0\n */\nexport interface Action {\n  /**\n   * The action identifier.\n   *\n   * Referenced in the `'actionPerformed'` event as `actionId`.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The title text to display for this action.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * Sets `authenticationRequired` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  requiresAuthentication?: boolean;\n\n  /**\n   * Sets `foreground` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  foreground?: boolean;\n\n  /**\n   * Sets `destructive` in the options of the\n   * [`UNNotificationAction`](https://developer.apple.com/documentation/usernotifications/unnotificationaction).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  destructive?: boolean;\n\n  /**\n   * Use a `UNTextInputNotificationAction` instead of a `UNNotificationAction`.\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  input?: boolean;\n\n  /**\n   * Sets `textInputButtonTitle` on the\n   * [`UNTextInputNotificationAction`](https://developer.apple.com/documentation/usernotifications/untextinputnotificationaction).\n   *\n   * Only available for iOS when `input` is `true`.\n   *\n   * @since 1.0.0\n   */\n  inputButtonTitle?: string;\n\n  /**\n   * Sets `textInputPlaceholder` on the\n   * [`UNTextInputNotificationAction`](https://developer.apple.com/documentation/usernotifications/untextinputnotificationaction).\n   *\n   * Only available for iOS when `input` is `true`.\n   *\n   * @since 1.0.0\n   */\n  inputPlaceholder?: string;\n}\n\n/**\n * Represents a notification attachment.\n *\n * @since 1.0.0\n */\nexport interface Attachment {\n  /**\n   * The attachment identifier.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The URL to the attachment.\n   *\n   * Use the `res` scheme to reference web assets, e.g.\n   * `res:///assets/img/icon.png`. Also accepts `file` URLs.\n   *\n   * @since 1.0.0\n   */\n  url: string;\n\n  /**\n   * Attachment options.\n   *\n   * @since 1.0.0\n   */\n  options?: AttachmentOptions;\n}\n\nexport interface AttachmentOptions {\n  /**\n   * Sets the `UNNotificationAttachmentOptionsTypeHintKey` key in the hashable\n   * options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsTypeHintKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailHiddenKey` key in the\n   * hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailHiddenKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailClippingRectKey` key in\n   * the hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailClippingRectKey?: string;\n\n  /**\n   * Sets the `UNNotificationAttachmentOptionsThumbnailTimeKey` key in the\n   * hashable options of\n   * [`UNNotificationAttachment`](https://developer.apple.com/documentation/usernotifications/unnotificationattachment).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  iosUNNotificationAttachmentOptionsThumbnailTimeKey?: string;\n}\n\nexport interface PendingLocalNotificationSchema {\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n\n  /**\n   * The notification identifier.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n\n  /**\n   * Schedule this notification for a later time.\n   *\n   * @since 1.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n}\n\nexport interface LocalNotificationSchema {\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n\n  /**\n   * Schedule this notification for a later time.\n   *\n   * @since 1.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android 7.x.\n   * For Android 8+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n\n  /**\n   * Set the color of the notification icon.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  iconColor?: string;\n\n  /**\n   * Set attachments for this notification.\n   *\n   * @since 1.0.0\n   */\n  attachments?: Attachment[];\n\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   * @deprecated Use `relevanceScore` instead. This property is ignored on iOS 15+.\n   */\n  summaryArgument?: string;\n\n  /**\n   * The score the system uses to determine if the notification is the\n   * featured notification when the system groups the app's notifications.\n   *\n   * The value must be between 0 and 1, where 0 is the least relevant and\n   * 1 is the most relevant. The default value is 0.\n   *\n   * Sets `relevanceScore` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 8.1.0\n   */\n  relevanceScore?: number;\n\n  /**\n   * The interruption level that indicates the priority and delivery timing of a notification.\n   *\n   * Sets `interruptionLevel` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 8.1.0\n   */\n  interruptionLevel?: InterruptionLevel;\n\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: boolean;\n\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 8+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n\n  /**\n   * Sets a list of strings for display in an inbox style notification.\n   *\n   * Up to 5 strings are allowed.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  inboxList?: string[];\n\n  /**\n   * If true, notification will not appear while app is in the foreground.\n   *\n   * Only available for iOS.\n   *\n   * @since 5.0.0\n   */\n  silent?: boolean;\n\n  /**\n   * The number to display on the app icon badge when this notification is\n   * delivered.\n   *\n   * On iOS this sets the badge count on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   * On Android this calls `setNumber()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder).\n   *\n   * @since 8.3.0\n   */\n  badge?: number;\n\n  /**\n   * Whether the notification should be presented while the app is in the\n   * foreground.\n   *\n   * On iOS `true` forces the notification to be shown even while the app is\n   * foregrounded, while `false` suppresses it (it is still delivered to the\n   * `localNotificationReceived` listener). This is independent of `silent`;\n   * when both are provided, `foreground` takes precedence.\n   * On Android it raises the notification priority so it can present as a\n   * heads-up notification.\n   *\n   * @since 8.3.0\n   */\n  foreground?: boolean;\n\n  /**\n   * Whether this notification should be scheduled with an exact alarm.\n   *\n   * Only available for Android. Defaults to `true`: on `schedule()` (API 31+),\n   * if the app isn't yet allowed to schedule exact alarms the system \"Alarms &\n   * reminders\" settings screen is opened so the user can grant it — regardless\n   * of `isExactMandatory`. If the user still declines, the notification falls\n   * back to an inexact alarm (unless `isExactMandatory` is also set, in which\n   * case the call is rejected instead); a fallback like this sets\n   * `ScheduleResult.warning`. `update()` never prompts and falls back silently.\n   * Set to `false` to schedule this notification as inexact outright,\n   * regardless of permission state.\n   *\n   * @since 8.3.0\n   * @default true\n   */\n  isExactNotification?: boolean;\n\n  /**\n   * Whether an exact alarm is mandatory for this notification.\n   *\n   * Only available for Android, and only meaningful when\n   * `isExactNotification` is `true` (the default) and on `schedule()` calls.\n   * If the exact-alarm permission is denied and any notification being\n   * scheduled has this set to `true`, the whole `schedule()` call is rejected\n   * instead of falling back to an inexact alarm. Has no effect on `update()`:\n   * it never enforces this, and simply falls back to inexact like a\n   * non-mandatory notification would.\n   *\n   * @since 8.3.0\n   * @default false\n   */\n  isExactMandatory?: boolean;\n}\n\n/**\n * Represents a schedule for a notification.\n *\n * Use either `at`, `on`, or `every` to schedule notifications.\n *\n * @since 1.0.0\n */\nexport interface Schedule {\n  /**\n   * Schedule a notification at a specific date and time.\n   *\n   * @since 1.0.0\n   */\n  at?: Date;\n\n  /**\n   * Repeat delivery of this notification at the date and time specified by\n   * `at`.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  repeats?: boolean;\n\n  /**\n   * Allow this notification to fire while in [Doze](https://developer.android.com/training/monitoring-device-state/doze-standby)\n   *\n   * Note that these notifications can only fire [once per 9 minutes, per app](https://developer.android.com/training/monitoring-device-state/doze-standby#assessing_your_app).\n   *\n   * @since 1.0.0\n   */\n  allowWhileIdle?: boolean;\n\n  /**\n   * Schedule a notification on particular interval(s).\n   *\n   * This is similar to scheduling [cron](https://en.wikipedia.org/wiki/Cron)\n   * jobs.\n   *\n   * Only available for iOS and Android.\n   *\n   * @since 1.0.0\n   */\n  on?: ScheduleOn;\n\n  /**\n   * Schedule a notification on a particular interval.\n   *\n   * @since 1.0.0\n   */\n  every?: ScheduleEvery;\n\n  /**\n   * Limit the number times a notification is delivered by the interval\n   * specified by `every`.\n   *\n   * @since 1.0.0\n   */\n  count?: number;\n}\n\nexport interface ScheduleOn {\n  year?: number;\n  month?: number;\n  day?: number;\n  weekday?: Weekday;\n  hour?: number;\n  minute?: number;\n  second?: number;\n}\n\nexport type ScheduleEvery = 'year' | 'month' | 'two-weeks' | 'week' | 'day' | 'hour' | 'minute' | 'second';\n\n/**\n * The interruption level that indicates the priority and delivery timing of a notification.\n *\n * - `active`: The system presents the notification immediately, lights up the screen, and can play a sound.\n * - `critical`: The system presents the notification immediately, lights up the screen, and bypasses the mute switch to play a sound.\n *   Requires the [Critical Alerts entitlement](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.usernotifications.critical-alerts).\n * - `passive`: The system adds the notification to the notification list without lighting up the screen or playing a sound.\n * - `timeSensitive`: The system presents the notification immediately, lights up the screen, can play a sound, and breaks through system notification controls.\n *   Requires the Time Sensitive Notifications capability. Without it, the notification may not break through stricter Focus modes such as Do Not Disturb.\n *   Even with the capability, the user can disable Time Sensitive notifications per Focus mode in Settings.\n *   See [Time Sensitive notifications](https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/timesensitive) for more details.\n *\n * @since 8.1.0\n */\nexport type InterruptionLevel = 'active' | 'critical' | 'passive' | 'timeSensitive';\n\nexport interface ListChannelsResult {\n  /**\n   * The list of notification channels.\n   *\n   * @since 1.0.0\n   */\n  channels: Channel[];\n}\n\nexport interface PermissionStatus {\n  /**\n   * Permission state of displaying notifications.\n   *\n   * @since 1.0.0\n   */\n  display: PermissionState;\n}\n\nexport interface SettingsPermissionStatus {\n  /**\n   * Permission state of using exact alarms.\n   *\n   * @since 6.0.0\n   */\n  exact_alarm: PermissionState;\n}\n\nexport interface ActionPerformed {\n  /**\n   * The identifier of the performed action.\n   *\n   * @since 1.0.0\n   */\n  actionId: string;\n\n  /**\n   * The value entered by the user on the notification.\n   *\n   * Only available on iOS for notifications with `input` set to `true`.\n   *\n   * @since 1.0.0\n   */\n  inputValue?: string;\n\n  /**\n   * The original notification schema.\n   *\n   * @since 1.0.0\n   */\n  notification: LocalNotificationSchema;\n}\n\n/**\n * @deprecated\n */\nexport interface EnabledResult {\n  /**\n   * Whether or not the device has local notifications enabled.\n   *\n   * @since 1.0.0\n   */\n  value: boolean;\n}\n\nexport interface DeliveredNotificationSchema {\n  /**\n   * The notification identifier.\n   *\n   * @since 4.0.0\n   */\n  id: number;\n\n  /**\n   * The notification tag.\n   *\n   * Only available on Android.\n   *\n   * @since 4.0.0\n   */\n  tag?: string;\n  /**\n   * The title of the notification.\n   *\n   * @since 4.0.0\n   */\n  title: string;\n\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 4.0.0\n   */\n  body: string;\n\n  /**\n   * The configured group of the notification.\n   *\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  group?: string;\n\n  /**\n   * If this notification is the summary for a group of notifications.\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  groupSummary?: boolean;\n\n  /**\n   * Any additional data that was included in the\n   * notification payload.\n   *\n   * Only available for Android.\n   *\n   * @since 4.0.0\n   */\n  data?: any;\n\n  /**\n   * Extra data to store within this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  extra?: any;\n\n  /**\n   * The attachments for this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  attachments?: Attachment[];\n\n  /**\n   * Action type ssociated with this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  actionTypeId?: string;\n\n  /**\n   * Schedule used to fire this notification.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  schedule?: Schedule;\n\n  /**\n   * Sound that was used when the notification was displayed.\n   *\n   * Only available for iOS.\n   *\n   * @since 4.0.0\n   */\n  sound?: string;\n}\n\nexport interface DeliveredNotifications {\n  /**\n   * List of notifications that are visible on the\n   * notifications screen.\n   *\n   * @since 1.0.0\n   */\n  notifications: DeliveredNotificationSchema[];\n}\n\nexport interface Channel {\n  /**\n   * The channel identifier.\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The human-friendly name of this channel (presented to the user).\n   *\n   * @since 1.0.0\n   */\n  name: string;\n\n  /**\n   * The description of this channel (presented to the user).\n   *\n   * @since 1.0.0\n   */\n  description?: string;\n\n  /**\n   * The sound that should be played for notifications posted to this channel.\n   *\n   * Notification channels with an importance of at least `3` should have a\n   * sound.\n   *\n   * The file name of a sound file should be specified relative to the android\n   * app `res/raw` directory.\n   *\n   * If the sound is not provided, or the sound file is not found no sound will be used.\n   *\n   * @since 1.0.0\n   * @example \"jingle.wav\"\n   */\n  sound?: string;\n\n  /**\n   * The level of interruption for notifications posted to this channel.\n   *\n   * @default `3`\n   * @since 1.0.0\n   */\n  importance?: Importance;\n\n  /**\n   * The visibility of notifications posted to this channel.\n   *\n   * This setting is for whether notifications posted to this channel appear on\n   * the lockscreen or not, and if so, whether they appear in a redacted form.\n   *\n   * @since 1.0.0\n   */\n  visibility?: Visibility;\n\n  /**\n   * Whether notifications posted to this channel should display notification\n   * lights, on devices that support it.\n   *\n   * @since 1.0.0\n   */\n  lights?: boolean;\n\n  /**\n   * The light color for notifications posted to this channel.\n   *\n   * Only supported if lights are enabled on this channel and the device\n   * supports it.\n   *\n   * Supported color formats are `#RRGGBB` and `#RRGGBBAA`.\n   *\n   * @since 1.0.0\n   */\n  lightColor?: string;\n\n  /**\n   * Whether notifications posted to this channel should vibrate.\n   *\n   * @since 1.0.0\n   */\n  vibration?: boolean;\n}\n\n/**\n * Day of the week. Used for scheduling notifications on a particular weekday.\n */\nexport enum Weekday {\n  Sunday = 1,\n  Monday = 2,\n  Tuesday = 3,\n  Wednesday = 4,\n  Thursday = 5,\n  Friday = 6,\n  Saturday = 7,\n}\n\n/**\n * The importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)\n * @since 1.0.0\n */\nexport type Importance = 0 | 1 | 2 | 3 | 4 | 5;\n\n/**\n * The notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)\n * @since 1.0.0\n */\nexport type Visibility = -1 | 0 | 1;\n\n/**\n * @deprecated Use 'Channel`.\n * @since 1.0.0\n */\nexport type NotificationChannel = Channel;\n\n/**\n * @deprecated Use `LocalNotificationDescriptor`.\n * @since 1.0.0\n */\nexport type LocalNotificationRequest = LocalNotificationDescriptor;\n\n/**\n * @deprecated Use `ScheduleResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationScheduleResult = ScheduleResult;\n\n/**\n * @deprecated Use `PendingResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationPendingList = PendingResult;\n\n/**\n * @deprecated Use `ActionType`.\n * @since 1.0.0\n */\nexport type LocalNotificationActionType = ActionType;\n\n/**\n * @deprecated Use `Action`.\n * @since 1.0.0\n */\nexport type LocalNotificationAction = Action;\n\n/**\n * @deprecated Use `EnabledResult`.\n * @since 1.0.0\n */\nexport type LocalNotificationEnabledResult = EnabledResult;\n\n/**\n * @deprecated Use `ListChannelsResult`.\n * @since 1.0.0\n */\nexport type NotificationChannelList = ListChannelsResult;\n\n/**\n * @deprecated Use `Attachment`.\n * @since 1.0.0\n */\nexport type LocalNotificationAttachment = Attachment;\n\n/**\n * @deprecated Use `AttachmentOptions`.\n * @since 1.0.0\n */\nexport type LocalNotificationAttachmentOptions = AttachmentOptions;\n\n/**\n * @deprecated Use `LocalNotificationSchema`.\n * @since 1.0.0\n */\nexport type LocalNotification = LocalNotificationSchema;\n\n/**\n * @deprecated Use `Schedule`.\n * @since 1.0.0\n */\nexport type LocalNotificationSchedule = Schedule;\n\n/**\n * @deprecated Use `ActionPerformed`.\n * @since 1.0.0\n */\nexport type LocalNotificationActionPerformed = ActionPerformed;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/local-notifications",
-  "version": "8.3.0",
+  "version": "8.3.1",
   "description": "The Local Notifications API provides a way to schedule device notifications locally (i.e. without a server sending push notifications).",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",