{"id":13553057,"url":"https://github.com/katzer/cordova-plugin-local-notifications","last_synced_at":"2025-05-10T07:58:14.550Z","repository":{"id":1017188,"uuid":"12019742","full_name":"katzer/cordova-plugin-local-notifications","owner":"katzer","description":"Cordova Local-Notification Plugin","archived":false,"fork":false,"pushed_at":"2025-04-28T13:58:55.000Z","size":11939,"stargazers_count":2567,"open_issues_count":2,"forks_count":1756,"subscribers_count":132,"default_branch":"master","last_synced_at":"2025-05-10T07:58:09.310Z","etag":null,"topics":["appplant","cordova-android-plugin","cordova-ios-plugin","cordova-plugin","cordova-plugin-local-notification","cordova-windows-plugin","local-notifications","notifications","user-notifications"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/katzer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"GitToTheHub"}},"created_at":"2013-08-10T11:25:59.000Z","updated_at":"2025-05-09T05:33:31.000Z","dependencies_parsed_at":"2023-07-10T13:01:51.626Z","dependency_job_id":"bd0b7fc3-e8f2-4f7f-a708-72cbaed2e688","html_url":"https://github.com/katzer/cordova-plugin-local-notifications","commit_stats":{"total_commits":862,"total_committers":68,"mean_commits":"12.676470588235293","dds":0.2529002320185615,"last_synced_commit":"208d8187a485e579ccf29f0947e89a0be0d9e371"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fcordova-plugin-local-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fcordova-plugin-local-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fcordova-plugin-local-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fcordova-plugin-local-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/katzer","download_url":"https://codeload.github.com/katzer/cordova-plugin-local-notifications/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253384819,"owners_count":21899930,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appplant","cordova-android-plugin","cordova-ios-plugin","cordova-plugin","cordova-plugin-local-notification","cordova-windows-plugin","local-notifications","notifications","user-notifications"],"created_at":"2024-08-01T12:02:16.458Z","updated_at":"2025-05-10T07:58:14.516Z","avatar_url":"https://github.com/katzer.png","language":"Java","funding_links":["https://github.com/sponsors/GitToTheHub"],"categories":["Java"],"sub_categories":[],"readme":"\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg src=\"images/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003c!--\n  GitHub caches the npm badge and changes the url to a cached github url like:\n  https://camo.githubusercontent.com/11f744ab82c...\n  The GitHub can be cleared with the following bash command:\n  curl -X PURGE https://camo.githubusercontent.com/11f744ab82c...\n  The browser would have to be cleared also to let the updated badge appear.\n--\u003e\n[![npm version](https://badge.fury.io/js/cordova-plugin-local-notification.svg)](https://badge.fury.io/js/cordova-plugin-local-notification)\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" alt=\"License\" /\u003e\n\u003c/a\u003e\n\n\n\u003e A notification is a message you display to the user outside of your app's normal UI. When you tell the system to issue a notification, it first appears as an icon in the notification area. To see the details of the notification, the user opens the notification drawer. Both the notification area and the notification drawer are system-controlled areas that the user can view at any time.\n\n\u003cimg style=\"float: right; padding: 20px; padding-right: 40px;\" width=\"320\" src=\"images/android-notification-example.png\"\u003e\n\n### Notification components\n\n- Header area\n- Content area\n- Action area\n\n### How notifications may be noticed\n\n- Showing a status bar icon\n- Appearing on the lock screen\n- Playing a sound or vibrating\n- Peeking onto the current screen\n- Blinking the device's LED\n\n### Supported platforms\n\n- Android 7.0+ (minimum version by cordova-android 13.0.0) with a minimum WebView Version 60 (Android 8 is shipped with a WebView version 58 and must be updated with Google Play Store before)\n- iOS 11.3+ (minimum version by cordova-ios 7.0.0)\n\n### Installation\n\nThe plugin can be installed via [Cordova-CLI][CLI] and is publicly available on [NPM][npm].\n\n#### NPM\n\nExecute from the projects root folder:\n\n    $ cordova plugin add cordova-plugin-local-notification\n\nInstall a specific version:\n\n    $ cordova plugin add cordova-plugin-local-notification@VERSION\n\n#### Git\nInstall the latest head version:\n\n    $ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git\n\nInstall from a branch:\n\n    $ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#branch\n\nInstall from a tag:\n\n    $ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#v1.0.0\n\nInstall from a specific commit:\n\n    $ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#5e4f131\n\n#### Local\nInstall from local source:\n\n    $ cordova plugin add \u003cpath\u003e --nofetch --nosave --link\n\n## Upgrade Notice\n\n### Updates in version 1.1.0\nA lot of properties were renamed, see [Changed properties](#changes-since-version-110).\n\n#### Android\nThe [Default channel](#default-channel) id was changed from `default-channel-id` to `default_channel`. If you upgrade to this version and schedule notifications, there will be two channels from then on, the old one and the new one. You can remove the old one with [deleteChannel](#deletechannel).\n\n#### iOS\n[iOSForeground](#property-iosforeground) is `true` by default\n\n### Updates in version 1.1.1\n\n#### Android\nThe property `vibrate` was renamed to [androidChannelEnableVibration](#property-androidchannelenablevibration).\n\n#### iOS\nA notification will be always showed in the notification center like on Android. Happens also if [iOSForeground](#property-iosforeground) is `false`.\n\n### Updates in Version 1.1.4\n\n#### Android\nNotifications with an old `trigger.at` date will be shown when you schedule them. Before they were ignored.\n\n## Basics\n\nThe plugin creates the object `cordova.plugins.notification.local` and is accessible after *deviceready* has been fired.\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'My first notification',\n    text: 'Thats pretty easy...'\n});\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg width=\"320\" src=\"images/ios-notification.png\"\u003e\n\u003c/p\u003e\n\nThe plugin allows to schedule multiple notifications at once.\n\n```js\ncordova.plugins.notification.local.schedule([\n    { id: 1, title: 'My first notification' },\n    { id: 2, title: 'My first notification' }\n]);\n```\n\n## Notification Limits\nOn each platform are limits about how much notifications can be scheduled:\n\n- iOS: 64\n- Android: 500\n\nRepeating notifications count as 1 notification.\n\n## Properties\nA notification does have a set of configurable properties. See [all properties](#properties-1).\n\n## Permissions\nOn iOS and Android 13+ permissions must be requested from the user before notifications can be posted. This is done automatically, when scheduling a notification. If you want do it manually, you can use [requestPermission](#requestpermission). Please keep in mind, that the user can still change the permission later in the system. If you want to check, if you have still the permission to post notifications, use [hasPermission](#haspermission).\n\n\u003cimg width=\"240\" src=\"images/ios-request-permission.png\"\u003e\n\u003cimg width=\"240\" src=\"images/android-request-permission.png\"\u003e\n\nOn Android, the permissions must be requested since Android 13. In earlier versions no permissions must be granted.\n\n## Android specials\n\n### Notification channels\nSince Android 8 notification channels must be created to post noitifications. A [default channel](#default-channel) will be created for you, if you do not create one. You can also create your own channel by [createChannel](#createchannel) or when [scheduling a notification](#create-channel-by-posting-a-notification). For deleting a channel use [deleteChannel](#deletechannel).\n\n### Inexact alarms since Android 12\nSince Android 12 alarms will be scheduled inexact by default. On Android 12 (API level 31) and higher, the system invokes the alarm within one hour of the supplied trigger time, unless any battery-saving restrictions are in effect such as battery saver or Doze. Most apps can schedule tasks and events using inexact alarms to complete several common use cases. If your app's core functionality depends on a precisely-timed alarm — such as for an alarm clock app or a calendar app — then it's OK to use an exact alarm instead.\n\nSee [Schedule exact alarms](#android-schedule-exact-alarms), if you want use exact alarms.\n\nSee [Android documentation](https://developer.android.com/develop/background-work/services/alarms/schedule) for more information.\n\n### App hibernation / App unused\nIf your app runs on Android 12 and newer and the user doesn't interact with your app for 3 months, the system places your app in a hibernation state which will cancel all pending notifications and revokes permissions. When the user interacts with your app again, the app exits hibernation and the notifications will be re-scheduled. It doesn't count as app usage if the user dismisses a notification. If the app is hibernated, the user will get informed about it:\n\n\u003cimg width=\"320\" src=\"images/android-app-hibernation-notification.png\"\u003e\n\nThe documentation says that permissions are also revoked, but testing the hibernation behavior on an Android 15 emulator showed, that the app keeps the permission to post notifications.\n\n#### Notes\n- Android introduced this behavior in Android 11 and additionally backported this to Android 6 to 10 through the Google Play Store but only the permissions are revoked and not the pending notifications. Because permissions are only needed since Android 13, this does not affect this plugin. Since Android 12 notifications are also canceld besides revoking the permissions.\n- You can manually test the hibernation behavior, see [App hibernation \u003e Manually invoke hibernation behavior](https://developer.android.com/topic/performance/app-hibernation#manually-invoke).\n- To see a complete list, what counts as app usage and what not, see [App hibernation \u003e App usage](https://developer.android.com/topic/performance/app-hibernation#app-usage).\n- 3 months are based on executing `adb shell device_config get permissions \\ auto_revoke_unused_threshold_millis2` which will return `7776000000` milliseconds on an Android 15 Emulator which are nearly 3 months (~2.96 months).\n\n#### Manage App hibernation\n\nYou can get the status of the setting by calling [getUnusedAppRestrictionsStatus](#getunusedapprestrictionsstatus). To redirect the user to the setting, call [openManageUnusedAppRestrictions](#openmanageunusedapprestrictions). Before opening the setting, you can inform the user about this behavior and explain which setting he has to deactivate. When opening the settings, the system will not scroll to the right entry and the setting is named differently on different Android versions:\n\nSample Android 12:\n\n\u003cimg width=\"240\" src=\"images/android-app-hibernation-settings-android-12.png\"\u003e\n\nOn other Android versions it is named differently:\n\nAndroid 13/14:\n\n\u003cimg width=\"320\" src=\"images/android-app-hibernation-settings-android-13-14.png\"\u003e\n\nAndroid 15:\n\n\u003cimg width=\"320\" src=\"images/android-app-hibernation-settings-android-15.png\"\u003e\n\n### Doze and Standby\n\nAndroid has two power-saving features that extend battery life for users by managing how apps behave when a device isn't connected to a power source: Doze and App Standby. Doze reduces battery consumption by deferring background CPU and network activity for apps when the device is unused for long periods of time. App Standby defers background network activity for apps with no recent user activity.\n\nTo fire notifications when the device is in doze mode, you can schedule notifications with the property [androidAllowWhileIdle](#property-androidallowwhileidle).\n\nApp Standby does not affect you when showing a notification.\n\nYou can read everything about it in the [Android documentatation](https://developer.android.com/training/monitoring-device-state/doze-standby).\n\n### Alarm rescheduling\n\n#### App Update\nAndroid removes all alarms when the app is updated. The plugin reschedules all alarms by a [BroadcastReceiver](https://developer.android.com/develop/background-work/background-tasks/broadcasts) listening to [ACTION_MY_PACKAGE_REPLACED](https://developer.android.com/reference/android/content/Intent#ACTION_MY_PACKAGE_REPLACED).\n\n#### Device reboot\nAndroid removes all alarms when the device reboots. The plugin reschedules all alarms by a [BroadcastReceiver](https://developer.android.com/develop/background-work/background-tasks/broadcasts) listening to [ACTION_BOOT_COMPLETED](https://developer.android.com/reference/android/content/Intent#ACTION_BOOT_COMPLETED), but only after the device has been unlocked.\n\n#### User grants exact alarms\nIf you use [SCHEDULE_EXACT_ALARM](#exact-alarms-user-grants-permission) for scheduling exact alarms and the user permits the permission in the \"Alarms \u0026 Reminders\", inexact alarms will be rescheduled as exact alarms. This is done by a [BroadcastReceiver](https://developer.android.com/develop/background-work/background-tasks/broadcasts) listening to [ACTION_SCHEDULE_EXACT_ALARM_PERMISSION_STATE_CHANGED](https://developer.android.com/reference/android/app/AlarmManager#ACTION_SCHEDULE_EXACT_ALARM_PERMISSION_STATE_CHANGED). This action will not be called if the user revokes the permission. All exact alarms will be canceld then.\n\n[](README.md#android-15-alarms-get-canceled-on-force-stop)\n#### Android 15: Alarms get canceled on `Force stop`\nSince Android 15 all pending alarms will get canceled if the user force stops an app, this is a change by Google, see https://developer.android.com/about/versions/15/behavior-changes-all#enhanced-stop-states. The alarms will be re-registered, if the user starts the app again. If the user clears the app from the app stack the alarms will not get canceled.\n\nKeep in mind, that force stopping is only known by advised users and if they do it, they have a reason to do this and they should be aware, that the app will no longer function correctly as the System also states when clicking on `Force stop` by showing an alert with the message `If you force stop an app, it may misbehave.`\n\n## Actions\n\nYou can add actions, which can be a button or an input to a notification. Before you can use them you have to pre-define them:\n\n```javascript\ncordova.plugins.notification.local.addActions('YES_NO_CATEGORY', [\n    { id: 'YES_ACTION', title: 'Yes' },\n    { id: 'NO_ACTION',  title: 'No'  }\n]);\n```\n\nThen you have to assign the defined actions when scheduling a notification:\n\n```javascript\ncordova.plugins.notification.local.schedule({\n    title: 'Justin Rhyss',\n    text: 'Do you want to go see a movie tonight?',\n    actions: 'YES_NO_CATEGORY'\n});\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg width=\"320\" src=\"images/ios-actions.png\"\u003e\n    \u003cimg width=\"320\" src=\"images/android-actions.png\"\u003e\n\u003c/p\u003e\n\nOn iOS the actions are not visible by default. You have to long press on the notification to see them.\n\nIcons on action buttons are not possible. Android had supported it, but stopped this in [Android 7](https://developer.android.com/reference/android/app/Notification.Action.Builder#Builder(int,%20java.lang.CharSequence,%20android.app.PendingIntent)).\n\nThe plugin knows two types of actions `button` and `input`. If you do not specifiy a type, an action is by default a button.\n\n### Input\n\nYou can define an action as input.\n\nRegister actions:\n\n```javascript\ncordova.plugins.notification.local.addActions('REPLY_NO_CATEGORY', [\n    { id: 'REPLY_ACTION', type: 'input', title: 'Reply', emptyText: 'Type message',},\n    { id: 'NO_ACTION', title: 'No'}\n]);\n```\n\nSchedule with registered actions:\n\n```javascript\ncordova.plugins.notification.local.schedule({\n    title: 'Justin Rhyss',\n    text: 'Do you want to go see a movie tonight?',\n    actions: 'REPLY_NO_CATEGORY'\n});\n```\n\n| iOS          | Android      |\n| :----------- | :----------- |\n| \u003cimg width=\"240\" src=\"images/ios-actions-with-input.png\"\u003e | \u003cimg width=\"240\" src=\"images/android-actions-with-input-not-clicked.png\"\u003e\u003cbr\u003e\u003cimg width=\"240\" src=\"images/android-actions-with-input-clicked.png\"\u003e |\n\n### Handle action events\nYou can subscribe to an action event.\n\nExample:\n\n```javascript\ncordova.plugins.notification.local.addActions('YES_NO_CATEGORY', [\n    { id: 'YES_ACTION', title: 'Yes' },\n    { id: 'NO_ACTION',  title: 'No'  }\n]);\n```\n\nYou have to subscribe to the action id:\n\n```javascript\ncordova.plugins.notification.local.on('YES_ACTION', (notification, eopts) =\u003e {\n    // Your code\n});\n```\n\nTo unsubcribe see [Events](#events).\n\n### Action properties\n\nActions do have a set of configurable properties. Not all of them are supported across all platforms.\n\n| Property     | Type         | Android | iOS |\n| :----------- | :----------- | :------ | :-- |\n| id           | button+input | x       | x   |\n| title        | button+input | x       | x   |\n| launch       | button+input | x       | x   |\n| ui           | button+input |         | x   |\n| needsAuth    | button+input |         | x   |\n| icon         | button+input | x       |     |\n| emptyText    | input        | x       | x   |\n| submitTitle  | input        |         | x   |\n| editable     | input        | x       |     |\n| choices      | input        | x       |     |\n| defaultValue | input        |         |     |\n\n\n## Triggers\n\nNotifications may trigger immediately or depend on calendar or location.\n\n### Fixed date\nTrigger at a fixed date:\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Design team meeting',\n    text: '3:00 - 4:00 PM',\n    trigger: { at: new Date(2017, 10, 27, 15) }\n});\n```\n\n| Property      | Type    | Value            | Android | iOS |\n| :------------ | :------ | :--------------- | :------ | :-- |\n| at            | Date    |                  | x       | x   |\n\n### Relative\nRelative from now:\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Design team meeting',\n    trigger: { in: 1, unit: 'hour' }\n});\n```\n\n| Property      | Type    | Value            | Android | iOS |\n| :------------ | :------ | :--------------- | :------ | :-- |\n| in            | Int     |                  | x       | x   |\n| unit          | String  | `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year` | x       | x   |\n\n### Repeating\n\nRepeat relative from now:\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Design team meeting',\n    trigger: { every: 'day', count: 5 } // count is only supported by Android\n});\n```\n\n| Property      | Type    | Value            | Android | iOS | Note |\n| :------------ | :------ | :--------------- | :------ | :-- | :--- |\n| before        | Date    |                  | x       |     | |\n| firstAt       | Date    |                  | x       |     | |\n| count         | Int     |                  | x       |     |      |\n| every         | String  | `minute`, `hour`, `day`, `week`, `month`, `quarter` \u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e, `year` | x       | x   | |\n\nTrigger every time the date matches:\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Happy Birthday!!!',\n    trigger: { every: { month: 10, day: 27, hour: 9, minute: 0 } }\n});\n```\n\n| Property      | Type    | Value            | Android | iOS | Note |\n| :------------ | :------ | :--------------- | :------ | :-- | :--- |\n| before        | Date    |                  | x       |     | |\n| after         | Date    |                  | x       |     | |\n| count         | Int     |                  | x       |     |      |\n| every         | Object  | `minute`, `hour`, `day`, `weekday`, `weekdayOrdinal` \u003cimg src=\"images/apple-icon.svg\" width=\"16\"\u003e, `week` \u003cimg src=\"images/apple-icon.svg\" width=\"16\"\u003e, `weekOfMonth`, `month`, `quarter`  \u003cimg src=\"images/apple-icon.svg\" width=\"16\"\u003e | x       | x   | |\n\n### Location based\n\u003cimg src=\"images/apple-icon.svg\" width=\"16\"\u003e iOS only\n\nTo trigger when the user enters a region:\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Welcome to our office',\n    trigger: {\n        type: 'location',\n        center: [x, y],\n        radius: 15,\n        notifyOnEntry: true\n    }\n});\n```\n\n| Property      | Type    | Value            | Android | iOS | Note |\n| :------------ | :------ | :--------------- | :------ | :-- | :--- |\n| center        | Array   | `[lat, long]`    |         | x   |      |\n| radius        | Int     |                  |         | x   |      |\n| notifyOnEntry | Boolean |                  |         | x   |      |\n| notifyOnExit  | Boolean |                  |         | x   |      |\n| single        | Boolean |                  |         | x   |      |\n\n## Progress\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nNotifications can include an animated progress indicator that shows users the status of an ongoing operation.\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'Sync in progress',\n    text: 'Copied 2 of 10 files',\n    androidProgressBar: {\n        value: 20, // Default 0\n        maxValue: 100, // Default 100\n        indeterminate: false // Default false\n    }\n});\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg src=\"images/android-progress.png\"\u003e\n\u003c/p\u003e\n\nCalls [NotificationCompat.Builder#setProgress(int,int,boolean)](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder#setProgress(int,int,boolean))\n\n### Indeterminate Progress\n\nUse indeterminate mode for the progress bar when you do not know how long an operation will take. It shows a cyclic animation without a specific amount of progress indicated.\n\nSee [ProgressBar#indeterminate-progress](https://developer.android.com/reference/android/widget/ProgressBar.html#indeterminate-progress)\n\n### Determinate Progress\n\nUse determinate mode for the progress bar when you want to show that a specific quantity of progress has occurred. For example, the percent remaining of a file being retrieved, the amount records in a batch written to database, or the percent remaining of an audio file that is playing.\n\nSee [ProgressBar#determinate-progress](https://developer.android.com/reference/android/widget/ProgressBar.html#determinate-progress)\n\n## Patterns\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nSplit the text by line breaks if the message comes from a single person and just too long to show in a single line.\n\n```js\ncordova.plugins.notification.local.schedule({\n    title: 'The Big Meeting',\n    text: '4:15 - 5:15 PM\\nBig Conference Room',\n    androidSmallIcon: 'res://ic_menu_my_calendar',\n    androidLargeIcon: 'res://large_icon'\n});\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg src=\"images/android-inbox.png\"\u003e\n\u003c/p\u003e\n\n## Summarizing\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nInstead of displaying multiple notifications, you can create one notification that summarizes them all.\n\n```js\ncordova.plugins.notification.local.schedule({\n    id: 15,\n    title: 'Chat with Irish',\n    androidLargeIcon: 'res://large_icon',\n    androidMessages: [\n        { person: 'Me', message: 'I miss you' },\n        { person: 'Irish', message: 'I miss you more!' },\n        { person: 'Me', message: 'I always miss you more by 10%' }\n    ]\n});\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg src=\"images/android-chat.png\"\u003e\n\u003c/p\u003e\n\nTo add a new message to the existing chat:\n\n```js\ncordova.plugins.notification.local.update({\n    id: 15,\n    androidMessages: [{ person: 'Irish', message: 'Bye bye' }]\n});\n```\n\nFor displaying the messages, [NotificationCompat.MessagingStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.MessagingStyle) will be used.\n\n### Properties for `androidMessages`\n```javascript\nandroidMessags: [\n    {\n        message: \"The message\", // Default is `null`\n        date: 1234567890, // Timestamp in milliseconds for e.g. by Date.getTime(), default is System.currentTimeMillis()\n        person: \"Michael\", // Default is `null`\n        personIcon: \"www/personIcon.png\" // Default is `null`\n    }\n]\n```\n\n#### Property `personIcon`\nWill be drawn as a circle icon.\n\nPossible values:\n- `res://personIcon.png` - Resource from the app bundle, see [documentation](#resource-pattern-res)\n- `www/personIcon.png` - Resource from the `www` folder, see [documentation](#resource-pattern-www)\n- `shared://personIcon.png` - Resource from the shared folder, see [documentation](#resource-pattern-shared)\n\n## Grouping\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nYour app can present multiple notifications as a single group:\n\n- A parent notification displays a summary of its child notifications.\n- The child notifications are presented without duplicate header information.\n\n```js\ncordova.plugins.notification.local.schedule([\n    { id: 0, title: 'Design team meeting', ... },\n    { id: 1, androidSummary: 'me@gmail.com', androidGroup: 'email', androidGroupSummary: true },\n    { id: 2, title: 'Please take all my money', ... androidGroup: 'email' },\n    { id: 3, title: 'A question regarding this plugin', ... androidGroup: 'email' },\n    { id: 4, title: 'Wellcome back home', ... androidGroup: 'email' }\n]);\n```\n\n\u003cp style=\"text-align: center;\"\u003e\n    \u003cimg src=\"images/android-stack.png\"\u003e\n\u003c/p\u003e\n\n## Android channels\n\n### Default channel\nThe following settings will be used for the default Android channel.\n\n```javascript\n{\n    androidChannelId: \"default_channel\",\n    androidChannelName: \"Default channel\",\n    androidChannelImportance: \"IMPORTANCE_DEFAULT\"\n}\n```\n\nYou can change the defaults by calling [setDefaults](#setdefaults) or you can overwrite them, when scheduling a notification or [creating a channel](#createchannel).\n\nThe default channel id was changed in version 1.1.0 from `default-channel-id` to `default_channel`.\n\n### Create channel by posting a notification\nA channel can be created directly when posting a notification:\n\n```javascript\ncordova.plugins.notification.local.schedule({\n    id: 1,\n    title: 'My first notification',\n    androidChannelId: \"my_channel_01\",\n    androidChannelName: \"My Channel Name\"\n});\n```\n\nIf you omit some channel properties the [default channel properties](#default-channel) will be used.\n\n## Android: Schedule exact alarms\nSince Android 12 notifications will be scheduled inexact by default. On Android 12 (API level 31) and higher, the system invokes the alarm within one hour of the supplied trigger time, unless any battery-saving restrictions are in effect such as battery saver or Doze. Most apps can schedule tasks and events using inexact alarms to complete several common use cases. If your app's core functionality depends on a precisely-timed alarm — such as for an alarm clock app or a calendar app — then it's OK to use an exact alarm instead.\n\nSee [Android documentation](https://developer.android.com/develop/background-work/services/alarms/schedule) for more information.\n\nYou have two options, to schedule exact alarms.\n\n### Exact alarms: User grants permission\nYou must add the [SCHEDULE_EXACT_ALARM](https://developer.android.com/reference/android/Manifest.permission#SCHEDULE_EXACT_ALARM) permission to `AndroidManifest.xml`. You can do this with your `config.xml`.\n\nFirst add the Android xml namespace to your `widget` tag:\n\n```xml\n\u003cwidget ... xmlns:android=\"http://schemas.android.com/apk/res/android\"\u003e\n````\n\nThen add the following [config-file](https://cordova.apache.org/docs/en/12.x/plugin_ref/spec.html#config-file) declaration to your `config.xml`:\n\n```xml\n\u003cconfig-file target=\"AndroidManifest.xml\" parent=\"/manifest\"\u003e\n    \u003cuses-permission android:name=\"android.permission.SCHEDULE_EXACT_ALARM\" /\u003e\n\u003c/config-file\u003e\n```\n\nThis tells Android that your app wants to have the permission to schedule exact alarms.\n\n|      |      |\n| :--- | :--- |\n| \u003cimg width=\"320\" src=\"images/android-alarms-and-reminders-in-app-settings.png\" /\u003e | After declaring `SCHEDULE_EXACT_ALARM` as permission, your app have a new entry in the app settings called `Alarms \u0026 reminders`, where the user can enable/disable exact alarms. |\n| \u003cimg width=\"320\" src=\"images/android-alarms-and-reminders-setting.png\" /\u003e | Clicking on this entry will open the setting to enable/disable exact alarms. This screen will also been shown if you call [openAlarmSettings](#openalarmsettings) |\n\nOn Android 12 `SCHEDULE_EXACT_ALARM` is pre-granted. On Android 13 and newer the user has to permit this in the \"Alarms \u0026 Reminders\" setting, which you can open by [openAlarmSettings](#openalarmsettings). You can use the [resume](https://cordova.apache.org/docs/en/12.x/cordova/events/events.html#resume) event of Cordova to check if exact alarms are permitted by [canScheduleExactAlarms](#canscheduleexactalarms). If you have already posted inexact alarms, before the user granted the exact alarm permission, inexact alarms will be automatically rescheduled by this plugin as exact alarms. The downside is, when the user revokes the exact alarm permission, your app will be killed and all exact alarms will be canceled without rescheduling them as inexact alarms. You have to reschedule them the next time the user starts your app. You can read everything about it in the [Android documentation](https://developer.android.com/about/versions/14/changes/schedule-exact-alarms).\n\n### Exact alarms: Define your app as a Calender or Alarm Clock app\nThis is a very special case you should think about. When you declare your app as a calendar or alarm clock app, the app have to fullfill the requirements and must be approved by Google in the Play Store. Google could remove the app from the store if the app is found to be misusing the permission.\n\nCalendar or alarm clock apps need to send calendar reminders, wake-up alarms, or alerts when the app is no longer running. These apps can request the [USE_EXACT_ALARM](https://developer.android.com/reference/android/Manifest.permission#USE_EXACT_ALARM) permission. The `USE_EXACT_ALARM` permission will be granted on install, and apps holding this permission will be able to schedule exact alarms just like apps with the `SCHEDULE_EXACT_ALARM` permission. The advantage is, that this permission can't be revoked by the user.\n\nTo declare the `USE_EXACT_ALARM` permission in the `AndroidManifest.xml`, you can do this with your `config.xml`.\n\nFirst add the Android xml namespace to your `widget` tag:\n\n```xml\n\u003cwidget ... xmlns:android=\"http://schemas.android.com/apk/res/android\"\u003e\n````\n\nThen add the following [config-file](https://cordova.apache.org/docs/en/12.x/plugin_ref/spec.html#config-file) declaration to your `config.xml`:\n\n```xml\n\u003cconfig-file target=\"AndroidManifest.xml\" parent=\"/manifest\"\u003e\n    \u003cuses-permission android:name=\"android.permission.SCHEDULE_EXACT_ALARM\" android:maxSdkVersion=\"32\" /\u003e\n    \u003cuses-permission android:name=\"android.permission.USE_EXACT_ALARM\" /\u003e\n\u003c/config-file\u003e\n```\n\nThe permission `SCHEDULE_EXACT_ALARM` must be decared to be backward compatible with Android 12. The is why the permission is limited by `android:maxSdkVersion=\"32\"`, see [StackOverflow](https://stackoverflow.com/questions/73972021/android-permission-schedule-exact-alarm-required-with-use-exact-alarm-for-alarm) or the documentation of [USE_EXACT_ALARM](https://developer.android.com/reference/android/Manifest.permission#USE_EXACT_ALARM).\n\nThe permission `USE_EXACT_ALARM` exists since Android 13 and will be used from then on.\n\n## Events\n\nThe following events are supported: `add`, `trigger`, `click`, `clear`, `cancel`, `update`, `clearall` and `cancelall` and [action events](#handle-action-events).\n\n```js\ncordova.plugins.notification.local.on(event, callback, scope);\n```\n\nTo unsubscribe from events:\n\n```js\ncordova.plugins.notification.local.un(event, callback, scope);\n```\n\n__Note:__ You have to provide the exact same callback to `cordova.plugins.notification.local.un` as you provided to `cordova.plugins.notification.local.on` to make unsubscribing work.\nHence you should define your callback as a separate function, not inline. If you want to use `this` inside of your callback, you also have to provide `this` as `scope` to `cordova.plugins.notification.local.on`.\n\n### Fire manually\n\nNot an official interface, however its possible to manually fire events.\n\n```js\ncordova.plugins.notification.local.core.fireEvent(event, args);\n```\n\n## Launch Details\n\nCheck the `launchDetails` to find out if the app was launched by clicking on a notification.\n\n```js\ndocument.addEventListener('deviceready', function () {\n    console.log(cordova.plugins.notification.local.launchDetails);\n}, false);\n```\n\nIt might be possible that the underlying framework like __Ionic__ is not compatible with the launch process defined by cordova. With the result that the plugin fires the click event on app start before the app is able to listen for the events.\n\nTherefore its possible to fire the queued events manually by defining a global variable.\n\n```js\nwindow.skipLocalNotificationReady = true\n```\n\nOnce the app and Ionic is ready, you can fire the queued events manually.\n\n```js\ncordova.plugins.notification.local.fireQueuedEvents();\n```\n\n## Methods\n\nAll methods work asynchronous and accept callback methods.\n\nNote: This list has still to be documented.\n\n\n| Method                         | Android | iOS | Comment                   |\n| :------------------------------| :-------| :-- | :------------------------ |\n| addActions                     | x       | x   | Defines some actions in a group to re-use them. See [Actions](#actions). |\n| cancel                         | x       | x   |                           |\n| cancelAll                      | x       | x   |                           |\n| [canScheduleExactAlarms](#canscheduleexactalarms) | x       | -   | Checks if exact alarms are permitted. Since Android 13 inexact alarms are permitted by default. |\n| clear                          | x       | x   | On Android, it clears a already posted notification from the statusbar. |\n| clearAll                       | x       | x   |                           |\n| [createChannel](#createchannel) | x       | -   | Creates a channel for Android to post notifications on. |\n| [deleteChannel](#deletechannel) | x       | -   | Delete a channel by an id. |\n| fireQueuedEvents               | x       | x   | Fire queued events once the device is ready and all listeners are registered. This is done automatically, when `deviceready` is fired. Calls the Plugin with a `ready` action. |\n| get                            |         |     |                           |\n| getAll                         |         |     |                           |\n| getDefaults                    | x       | x   | Gets the default for notification properties. See [getDefaults](#getdefaults) |\n| getIds                         |         |     |                           |\n| getScheduled                   |         |     |                           |\n| getScheduledIds                |         |     |                           |\n| getTriggered                   |         |     |                           |\n| getTriggeredIds                |         |     |                           |\n| getType                        |         |     |                           |\n| [getUnusedAppRestrictionsStatus](#getUnusedAppRestrictionsStatus) | x       | -   | Gets the status of the unused app restrictions status |\n| hasActions                     | x       | x   | Checks if an action group exists by id like `hasActions('YES_NO_CATEGORY', (hasActions) =\u003e {}, this)`                       |\n| [hasPermission](#hasPermission) | x       | x   | Checks if the app has permission to post notifications. |\n| [iOSClearBadge](#iosclearbadge) | -       | x   | Clears the badge          |\n| isPresent                      |         |     |                           |\n| isScheduled                    |         |     |                           |\n| isTriggered                    |         |     |                           |\n| on                             | x       | x   | Listen to an [Event](#events) |\n| [openAlarmSettings](#openalarmsettings) | x       | -   | Supported since Android 12. Opens the \"Alarms \u0026 Reminders\"-settings, where the user can manually enable exact alarms. |\n| [openManageUnusedAppRestrictions](#openManageUnusedAppRestrictions) | x       | -   | Opens the unused app restriction settings directly in the app. |\n| [openNotificationSettings](#opennotificationsettings) | x       | (x) | Opens the notifications settings since Android 8. On iOS it opens the app settings. |\n| removeActions                  |  x      | x   | Removes actions by a group id like `removeActions('YES_NO_CATEGORY', () =\u003e {}, this)` which were previously created by `addActions` |\n| [requestPermission](#requestpermission) | x       | x   | Request permission to post notifications. This is called automatically when scheduling notifications. |\n| schedule                       | x       | x    | Schedules a single notification or multiple notifications. Accepts an object or an Array. |\n| [setDefaults](#setdefaults)    | x       | x   | Overwrites default values of notifications. Gets the default for notification properties. |\n| un                             | x       | x   | Unlisten to an [Event](#events) |\n| update                         | x       | x  | Updates a single notification or multiple notifications. The notification id has to be set to update a notification. Accepts an obect or an Array. |\n\n### canScheduleExactAlarms\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nChecks if the user has enabled the \"Alarms \u0026 Reminders\"-setting. If not, the notificiatons will be scheduled inexact, which is still ok and will only be delayed by some minutes.\n- On Android 11 and older, this method will always return `true` in the `successCallback`.\n- On Android 12 the permission is granted by default\n- On Android 13 and newer, the permission is not granted by default and have to be explicitly enabled by the user.\n\n### createChannel\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nCreates a channel, if it not already exists. A channel is not changeable, after it is created. This is a restriction by Android.\nIf a notification does not specify a [androidChannelId](#property-androidchannelid) a [default channel](#default-channel) will be used.\n\nFor setting the channel, use [androidChannelId](#property-androidchannelid) when scheduling a notification.\n\nOverview of all properties for a channel:\n\n```js\ncordova.plugins.notification.local.createChannel({\n    androidChannelId: \"my_channel_01\", // string, to separate something in the id, use \"_\" instead of \"-\"\n    androidChannelName: \"My Channel Name\", // string, defaults to \"Default Channel\"\n    androidChannelDescription: \"Description of channel\", // string (optional)\n    androidChannelImportance: \"IMPORTANCE_DEFAULT\", // string (optional), see property documentation for importance\n    androidChannelEnableLights: true, // bool (optional), default is false\n    androidChannelEnableVibration: true, // bool (optional), default is false\n    sound: 'www/audio/ring.mp3', // string (optional), defaults to \"default\", which represents the default sound for a notification. If you set `null`, no sound will be set for the notification\n    androidChannelSoundUsage: 5 // int (optional), default is USAGE_NOTIFICATION\n  }, successCallback, this)\n```\n\n### deleteChannel\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only\n\nDeletes a Android channel.\n\nExample:\n\n```javascript\ncordova.plugins.notification.local.deleteChannel(\"my_channel_id\", successCallback, this)\n```\n\nThese will delete all associated notificiations for this channel. If you create a new channel with the same id, the deleted channel will be un-deleted with all of the same settings it had before it was deleted, see [NotificationManagerCompat.deleteNotificationChannel](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#deleteNotificationChannel(java.lang.String))\n\n### getDefaults\n\nReturns the default values all properties on each platform.\n\nExample:\n\n```js\ncordova.plugins.notification.local.getDefaults();\n```\n\n### getUnusedAppRestrictionsStatus\n\nReturns the status of unused app restrictions also called [app hibernation](#app-hibernation--app-unused), which was introduced in Android 11 and is backported to Android 6 through the Google Play Store. From Android 6 to 11, only permissions gets revoked, what does not affect notifications, because notifications needs requesting permissions only since Android 13. But because since Android 12 also notifications get canceled, the status is relevant for Android 12 and later. When unused app restrictions are active, it will return `API_30_BACKPORT` (on Android 6 to 10), `API_30` on Android 11 or `API_31`on Android 12 and later. If it is disabled, `DISABLED` will be returned.\n\nSample:\n\n```javascript\ncordova.plugins.notification.local.getUnusedAppRestrictionsStatus(\n    (status) =\u003e {\n        // Shortcode for getting possibile status codes for status\n        const statusCodes = cordova.plugins.notification.local.androidUnusedAppRestrictionsStatusCodes;\n\n        // app hibernation is active on Android 12 and later\n        if (status == statusCodes.API_31) {\n\n        }\n    },\n    this\n);\n```\n\nPossible status codes:\n\n| Name                    | Value     | Description             |\n| :---------------------- | :-------- | ----------------------- |\n| ERROR                   | 0         | The status of Unused App Restrictions could not be retrieved from this app e.g. if the user is in locked device boot mode. Check the logs for the reason. |\n| FEATURE_NOT_AVAILABLE   | 1         | There are no available Unused App Restrictions for this app. This would happen on devices older then Android 6, but this plugin supports minimum Android 7. |\n| DISABLED                | 2         | Any available Unused App Restrictions on the device are disabled for this app. In other words, this app is exempt from having its permissions automatically removed or being hibernated. |\n| API_30_BACKPORT         | 3         | Unused App Restrictions introduced by Android API 30 (Android 11), and since made available on earlier (API 23-29 = Android 6 to 10) devices are enabled for this app: permission auto-reset. Note: This value is only used on API 29 (Android 10) or earlier devices. |\n| API_30                  | 4         | Unused App Restrictions introduced by Android API 30 (Android 11) are enabled for this app: permission auto-reset. Note: This value is only used on API 30 (Android 11) or later devices. |\n| API_31                  | 5         | Unused App Restrictions introduced by Android API 31 (Android 12) are enabled for this app: permission auto-reset and app hibernation. Note: This value is only used on API 31 (Android 12) or later devices. |\n\n### hasPermission\nChecks if the app has permissions to post notifications.\n\n```js\ncordova.plugins.notification.local.hasPermission(function (granted) { ... });\n```\n\n### iOSClearBadge\nClears the badge.\n\n### openAlarmSettings\n\u003cimg src=\"images/android-icon.svg\" width=\"16\"\u003e Android only. Since Android 12 (SDK 31).\n\nOpens the `Alarms \u0026 reminders` setting as an Activity when running on Android 12 (SDK 31) or later, where the user can enable exact alarms.\n\n\u003cimg width=\"240\" src=\"images/android-alarms-and-reminders-setting.png\" /\u003e\n\nThis is only available, if [SCHEDULE_EXACT_ALARM](#exact-alarms-user-grants-permission) is declared as permission in the `AndroidManifest.xml`.\n\nThis method will not wait for the user to be returned back to the app. For this, the `resume`-event can be used. The callback will just return `OK`, after starting the activity.\n- If the user grants permission, already inexact scheduled notifications will be rescheduled as exact alarms.\n- If exact alarms were already granted and the user revokes it, the app will be killed and all scheduled notifications will be canceld. The app have to schedule the notifications as inexact alarms again, when the app is opened the next time, see https://developer.android.com/develop/background-work/services/alarms/schedule#using-schedule-exact-permission.\n- On Android older then 12, it will just call the `successCallback`, without doing anything. \n\n### openManageUnusedAppRestrictions\n\nOpens the unused app restriction settings directly in your app. The `successCallback` will be called if the user returns to your app.\n\nSample:\n\n```javascript\ncordova.plugins.notification.local.openManageUnusedAppRestrictions((result) =\u003e {\n    // User has returned from the settings\n}, this);\n```\n\nYou can check in the `successCallback` what the user selected, by calling [getUnusedAppRestrictionsStatus](#getunusedapprestrictionsstatus).\n\n### openNotificationSettings\nOpens the notifications settings of the app on Android 8 and newer. This method will not wait for the user to be returned back to the app. For this, the `resume`-event can be used.\n- On Android, the callback will just return \"OK\", after starting the activity.\n- On Android older then 8, it opens the app details.\n- On iOS it's not possible to open the notification settings, it will open the app settings.\n\n### requestPermission\nRequest permission to post notifications. This is called automatically by the plugin when scheduling notifications, but you can also request it manually before scheduling notifications:\n\n```js\ncordova.plugins.notification.local.requestPermission(function (granted) { ... });\n```\n\nIf this method is called, a dialog will be shown to the user to ask for the permission.\n\n\u003cimg width=\"240\" src=\"images/ios-request-permission.png\"\u003e\n\u003cimg width=\"240\" src=\"images/android-request-permission.png\"\u003e\n\nThe user can still allow/deny the permission through the system settings.\n\nTo check if permissions are granted, without calling this method, use [hasPermission](#haspermission).\n\n### setDefaults\n\nChanges default values of properties.\n\nExample:\n\n```js\ncordova.plugins.notification.local.setDefaults({\n    androidChannelId: \"my_channel_01\",\n    title: \"My default Title\"\n});\n```\n\n## Properties\n\n### Changed properties\nList of changed properties on newer plugin versions.\n\n#### Changes since version `1.1.0`\n\nThere were some properties renamed. You can still use the old ones, but you will get a deprecation warning in the log and they will be removed in future versions.\n\n| Old Property            | New Property                |\n| :---------------------- | :-------------------------- |\n| autoClear               | androidAutoCancel           |\n| badge                   | badgeNumber                 |\n| channelDescription      | androidChannelDescription   |\n| channelId               | androidChannelId            |\n| channelImportance       | androidChannelImportance    |\n| channelName             | androidChannelName          |\n| clock                   | Use for `clock: boolean` = `androidShowWhen: boolean` and for `clock: 'chronometer'` = `androidUsesChronometer: true` |\n| color                   | androidColor                |\n| defaults                | androidDefaults             |\n| description             | androidChannelDescription   |\n| foreground              | iOSForeground               |\n| group                   | androidGroup                |\n| groupSummary            | androidGroupSummary         |\n| icon                    | androidLargeIcon            |\n| iconType                | androidLargeIconType        |\n| importance              | androidChannelImportance    |\n| lockscreen              | androidLockscreen           |\n| mediaSession            | *Property was removed*      |\n| onlyAlertOnce           | androidOnlyAlertOnce        |\n| prio                    | Use `androidChannelImportance`, `androidAlarmType` and `androidAllowWhileIdle` instead. |\n| priority                | Use `androidChannelImportance`, `androidAlarmType` and `androidAllowWhileIdle` instead. |\n| progressBar             | androidProgressBar          |\n| smallIcon               | androidSmallIcon            |\n| sticky                  | androidOngoing              |\n| soundUsage              | androidChannelSoundUsage    |\n| ongoing                 | androidOngoing              |\n| summary                 | androidSummary              |\n| text as Array           | androidMessages             |\n| timeoutAfter            | androidTimeoutAfter         |\n| titleCount              | androidTitleCount           |\n| wakeup                  | androidWakeUpScreen         |\n\n##### Changes on androidProgressBar\nThe default value changed from:\n\n```json\n{enabled: false, value:0, maxValue:100, indeterminate:false}\n```\n\nto\n\n`null`\n\nThe property `androidProgressBar.enabled` is not supported anymore.\nJust set `androidProgressBar: null` to disable the progressbar.\n\n##### Changes on sound\nThe property `sound` takes no longer additionally a boolean, now only a string, which points to a sound file.\n- The value `sound: true` is replaced with `sound: 'default'`\n- The value `sound: false` is replaced with `sound: null`\n\n### Changes since version `1.1.1`\n\nThere were some properties renamed. You can still use the old ones, but you will get a deprecation warning in the log and they will be removed in future versions.\n\n| Old Property            | New Property                  | Reason                  |\n| :---------------------- | :---------------------------- | ----------------------- |\n| vibrate                 | androidChannelEnableVibration | The vibration cannot be controlled on iOS. So this is a Android only property and can only be set on a channel. See [androidChannelEnableVibration](#property-androidchannelenablevibration)|\n\n### Common properties\n\nThese properties can be used on all platforms, but some may behave differently on each platform.\n\n| Property               | Default           | Comment                   |\n| :----------------------| :-----------------|:--------------------------|\n| [actions](#actions)    | `[]`              | Actions of a notification |\n| [attachments](#property-attachments) | `[]`              | List of resources, to attach to the notification. |\n| [badgeNumber](#property-badgenumber) | Android: `1`, iOS: `-1` | Sets the badge for the application. The behaviour differs on Android and iOS.  |\n| data                   | `null`            | Custom data for the notification. Can be used, when the notification is send back to the app, e.g. by clicking on it. |\n| id                     | `0`               | Id of the notification as number. |\n| launch                 | `true`            | If a click on the notification should launch the app. |\n| [priority](#property-priority) | `0` (=PRIORITY_DEFAULT) | Deprecated. Use [androidChannelImportance](#property-androidchannelimportance), [androidAlarmType](#property-androidalarmtype) and [androidAllowWhileIdle](#property-androidallowwhileidle) |\n| silent                | `false`            | iOS: Don't show a notification, make no sound, no vibration, when app is in foreground. Android: Don't show a notification (Does not create a Builder. Must be tested if that works) |\n| text                  | `\"\"`               | Text of the notification. Android features: 1. If the text contains line breaks (`\\n`) the notification style [NotificationCompat.InboxStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.InboxStyle) will be used. 2. If the text is longer then 44 chars, the notifications style [NotificationCompat.BigTextStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigTextStyle) will be used. |\n| [sound](#property-sound) | `default`          | Sets the sound of a notification. On iOS it also turns on/off the vibration. |\n| title                 | `\"\"` (Sets the app name)               | Title of the notification. Has to be a String. If it is empty, the app name will be used. |\n| [trigger](#triggers)  | `{type : \"calendar\"}`| Notifications may trigger immediately or depend on calendar or location. |\n\n### Android properties\n\nThese properties are only available on Android.\n\n| Property               | Default           | Comment                   |\n| :----------------------| :-----------------|:--------------------------|\n| [androidAlarmType](#property-androidalarmtype) | `RTC_WAKEUP` |              |\n| [androidAllowWhileIdle](#property-androidallowwhileidle) | `false` | Alarm will be allowed to execute even when the system is in low-power idle (a.k.a. doze) modes. |\n| androidAutoCancel      | `true`            | Make this notification automatically dismissed when the user touches it |\n| androidChannelDescription | `null`            | Sets the `description` of a [notification channel](#android-notification-channels). |\n| androidChannelEnableLights | `false` | Can be `true` or `false`and sets whether notifications posted to a [notification channel](#create-channel) should display notification lights, on devices that support that feature. |\n| [androidChannelEnableVibration](#property-androidchannelenablevibration) | `false`            | Enables the vibration of a channel. |\n| [androidChannelId](#property-androidchannelid) | `default_channel` | Specifies the channel id to be posted on. |\n| androidChannelImportance | `IMPORTANCE_DEFAULT` | Sets the [importance](#property-androidchannelimportance) of a [notification channel](#android-notification-channels) |\n| androidChannelName     | `Default channel` | Set the `channelName` for the notification to be posted on. See [Android Notification Channels](#android-notification-channels) for more information. |\n| androidChannelSoundUsage | `5` (=USAGE_NOTIFICATION) | Sets the [androidChannelSoundUsage](#property-androidchannelsoundusage) of a [notification channel](#create-channel). |\n| [androidColor](#property-androidcolor) | `null`            | The notification background color for the small icon in the notification style. |\n| [androidGroup](#grouping) | `null`            | Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may display in a cluster or stack on devices which support such rendering. To make this notification the summary for its group, also call setGroupSummary(boolean). A sort order can be specified for group members by using setSortKey(String) (not implemented yet). Calls [Notification.Builder#setGroup(java.lang.String)](https://developer.android.com/reference/android/app/Notification.Builder#setGroup(java.lang.String)) |\n| [androidGroupSummary](#grouping) | `false`        | Set this notification to be the group summary for a group of notifications. Grouped notifications may display in a cluster or stack on devices which support such rendering. Requires a group key also be set using setGroup(String). The group summary may be suppressed if too few notifications are included in the group. Calls [Notification.Builder#setGroupSummary(boolean)](https://developer.android.com/reference/android/app/Notification.Builder#setGroupSummary(boolean)) |\n| [androidLargeIcon](#property-androidlargeicon) | `null` | Add a large icon to the notification content view. |\n| androidLargeIconType   | `square`          | Can be `square` or `circle` |\n| androidLockscreen      | `true`            | If the entire notification should be shown on all lockscreens and while screen sharing. If the value is `true`, [Notification#VISIBILITY_PUBLIC](https://developer.android.com/reference/android/app/Notification#VISIBILITY_PUBLIC) will be set, otherwise [Notification#VISIBILITY_SECRET](https://developer.android.com/reference/android/app/Notification#VISIBILITY_SECRET). Sets [Notification#visibility](https://developer.android.com/reference/android/app/Notification#visibility). |\n| androidMessages        | `null`            | Array of messages to [summarize](#summarizing) notifications. [NotificationCompat.MessagingStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.MessagingStyle) will be used. |\n| androidOngoing         | `false`           | Set whether this is an ongoing notification. Ongoing notifications cannot be dismissed by the user on locked devices, or by notification listeners, and some notifications (call, device management, media) cannot be dismissed on unlocked devices. |\n| androidOnlyAlertOnce   | `false`           | Set this flag if you would only like the sound, vibrate and ticker to be played if the notification is not already showing (see [documentation](https://developer.android.com/reference/android/app/Notification.Builder#setOnlyAlertOnce(boolean))). |\n| androidProgressBar     | `null`  | See [documentation](#progress) |\n| androidShowWhen        | `true`            | If the Notification should show the when date. Before Version 1.1.0 called `clock`. |\n| [androidSmallIcon](#property-androidsmallicon) | `res://ic_popup_reminder` (=Bell icon) | Set the small icon resource, which will be used to represent the notification in the status bar. |\n| [androidSummary](#property-androidsummary) | `null`             |  |\n| androidTimeoutAfter    | `0`               | Specifies a duration in milliseconds after which this notification should be canceled, if it is not already canceled. `0` means no automatic cancellation.  |\n| androidTitleCount      | `%n%`              | Additional text added to the title for displaying the number of messages if there is more than one. Only used, if using MessagingStyle. Use `%n%` in the string for specifying the location of the number. |\n| androidUsesChronometer | `false`           | Show the Notification#when field as a stopwatch. Instead of presenting when as a timestamp, the notification will show an automatically updating display of the minutes and seconds since when. Useful when showing an elapsed time (like an ongoing phone call). Was former handeld by `clock: 'chronometer'` |\n| androidWakeUpScreen    | `true`            | If the screen should go on, when a notification arrives |\n| androidDefaults        | `0`               | Android 7 only. Sets the default notification options that will be used only on Android 7. Bitwise-or of: DEFAULT_SOUND, DEFAULT_VIBRATE, DEFAULT_LIGHTS. |\n| led                    | `false`           | Android 7 only. Can be a Hex-String like `#FF00FF` or `{color: '#FF00FF', on: 500, off: 500}` and sets the led of a notification. Replaced by `androidChannelEnableLights`. |\n\n### iOS properties\n\nThese properties are only available on iOS.\n\n| Property                                 | Default value         | Comment                   |\n| :--------------------------------------- | :-------------------- | :------------------------ |\n| [iOSForeground](#property-iosforeground) | `true`                | Displays a notification banner, when app is in foreground. |\n\n#### Some notes:\n- A progressbar is natively not supported by iOS, [see Stackoverflow](https://stackoverflow.com/questions/48500532/progress-view-in-local-notification/48500734#48500734)\n- The vibration cannot be turned off separately. It can only be turned off, if no sound is set.\n\n### Default values\n\nDefault values for the properties can be get by [getDefaults](#getdefaults).\nValues can be changed by [setDefaults](#setdefaults)\n\n### Available properties\n\n#### Property `androidAllowWhileIdle`\nDefault: `false`\n\nAlarm will be allowed to execute even when the system is in low-power idle (a.k.a. doze) modes.\n\nThis type of alarm must only be used for situations where it is actually required that the alarm go off while in idle -- a reasonable example would be for a calendar notification that should make a sound so the user is aware of it. When the alarm is dispatched, the app will also be added to the system's temporary power exemption list for approximately 10 seconds to allow that application to acquire further wake locks in which to complete its work.\n\nThis executes [AlarmManager.setAndAllowWhileIdle](https://developer.android.com/reference/android/app/AlarmManager#setAndAllowWhileIdle(int,%20long,%20android.app.PendingIntent)) or [AlarmManager.setExactAndAllowWhileIdle](https://developer.android.com/reference/android/app/AlarmManager#setExactAndAllowWhileIdle(int,%20long,%20android.app.PendingIntent)) depending on [canScheduleExactAlarms](#canscheduleexactalarms).\n\n#### Property `androidAlarmType`\nDefault: `RTC_WAKEUP`\n\nIf the alarm should be scheduled on a specific time or in relevance to the time, when the device was booted and if the alarm should wakeup the device cpu (not the screen). See also the Android documentation [Choose an alarm type](https://developer.android.com/develop/background-work/services/alarms/schedule#type).\n\n| Value            | Support | Description |\n|:-----------------|:--------|:------------|\n| [RTC_WAKEUP](https://developer.android.com/reference/android/app/AlarmManager#RTC_WAKEUP) | x | Alarm time in `System.currentTimeMillis()` (wall clock time in UTC), which will wake up the device (the CPU not the screen) when it goes off. |\n| [RTC](https://developer.android.com/reference/android/app/AlarmManager#RTC) | x | Alarm time in `System.currentTimeMillis()` (wall clock time in UTC). This alarm does not wake the device up; if it goes off while the device is asleep, it will not be delivered until the next time the device wakes up. |\n| [ELAPSED_REALTIME_WAKEUP](https://developer.android.com/reference/android/app/AlarmManager#ELAPSED_REALTIME_WAKEUP) | - | Alarm time in `SystemClock.elapsedRealtime()` (time since boot, including sleep), which will wake up the device (the CPU, not the screen) when it goes off. |\n| [ELAPSED_REALTIME](https://developer.android.com/reference/android/app/AlarmManager#ELAPSED_REALTIME) | - | Alarm time in `SystemClock.elapsedRealtime()` (time since boot, including sleep). This alarm does not wake the device up; if it goes off while the device is asleep, it will not be delivered until the next time the device wakes up. |\n\n#### Property `androidChannelEnableVibration`\nDefault: `false`\n\nSets the vibration of a [notification channel](#create-channel) by setting [NotificationChannel#enableVibration(boolean)](https://developer.android.com/reference/android/app/NotificationChannel#enableVibration(boolean)). On Android 7 this sets the vibration of a notification directly.\n\n#### Property `androidChannelId`\nDefault: `default_channel`\n\nSets the `channelId` for the notification to be posted on. Use [Snake Case](https://en.wikipedia.org/wiki/Snake_case) for the id, which means, the id should be written in lowercase and words should be separated by underscores (`_`) and not hyphens (`-`) or whitespaces.\n\n#### Property `androidChannelImportance`\nDefault: `\"IMPORTANCE_DEFAULT\"`\n\nThe property can have one of the following values:\n\n| Value            | Description |\n|:-----------------|:------------|\n| [IMPORTANCE_NONE](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_NONE()) | A notification with no importance: shows nowhere, is blocked. |\n| [IMPORTANCE_MIN](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_MIN()) | Min notification importance: only shows in the shade, below the fold. |\n| [IMPORTANCE_LOW](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_LOW()) | Low notification importance: shows everywhere, but is not intrusive. |\n| [IMPORTANCE_DEFAULT](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_DEFAULT()) | Default notification importance: shows everywhere, allowed to makes noise, but does not visually intrude. |\n| [IMPORTANCE_HIGH](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_HIGH()) | Higher notification importance: shows everywhere, allowed to makes noise and peek. |\n| [IMPORTANCE_MAX](https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_MAX()) | Highest notification importance: shows everywhere, allowed to makes noise, peek, and use full screen intents. |\n\nSee the [Android documentation](https://developer.android.com/develop/ui/views/notifications#importance) about this property.\n\nSee also [NotificationChannel#NotificationChannel(java.lang.String,%20java.lang.CharSequence,%20int)](https://developer.android.com/reference/android/app/NotificationChannel#NotificationChannel(java.lang.String,%20java.lang.CharSequence,%20int))\n\n#### Property `androidChannelSoundUsage`\nDefault: `5` (=`USAGE_NOTIFICATION`)\n\nThe property can have one of the following values:\n\n| Property value   | Android variable | Description |\n|:-----------------|:-----------------|:------------|\n| 0                | [USAGE_UNKNOWN](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_UNKNOWN) | Usage value to use when the usage is unknown. |\n| 1                | [USAGE_MEDIA](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_MEDIA) | Usage value to use when the usage is media, such as music, or movie soundtracks. |\n| 2                | [USAGE_VOICE_COMMUNICATION](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION)| Usage value to use when the usage is voice communications, such as telephony or VoIP. |\n| 3                | [USAGE_VOICE_COMMUNICATION_SIGNALLING](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_VOICE_COMMUNICATION_SIGNALLING) | Usage value to use when the usage is in-call signalling, such as with a \"busy\" beep, or DTMF tones. |\n| 4                | [USAGE_ALARM](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ALARM) | Usage value to use when the usage is an alarm (e.g. wake-up alarm). |\n| 5                | [USAGE_NOTIFICATION](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION) | Usage value to use when the usage is notification. See other notification usages for more specialized uses. |\n| 6                | [USAGE_NOTIFICATION_RINGTONE](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_RINGTONE) | Usage value to use when the usage is telephony ringtone. |\n| 7                | [USAGE_NOTIFICATION_COMMUNICATION_REQUEST](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_REQUEST) | This constant was deprecated in API level 33. Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework. Usage value to use when the usage is a request to enter/end a communication, such as a VoIP communication or video-conference. |\n| 8                | [USAGE_NOTIFICATION_COMMUNICATION_INSTANT](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_INSTANT) | This constant was deprecated in API level 33. Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework. Usage value to use when the usage is notification for an \"instant\" communication such as a chat, or SMS. |\n| 9                | [USAGE_NOTIFICATION_COMMUNICATION_DELAYED](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_COMMUNICATION_DELAYED) | This constant was deprecated in API level 33. Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework. Usage value to use when the usage is notification for a non-immediate type of communication such as e-mail. |\n| 10               | [USAGE_NOTIFICATION_EVENT](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_NOTIFICATION_EVENT) | Usage value to use when the usage is to attract the user's attention, such as a reminder or low battery warning. |\n| 11               | [USAGE_ASSISTANCE_ACCESSIBILITY](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY) | Usage value to use when the usage is for accessibility, such as with a screen reader. | \n| 12               | [USAGE_ASSISTANCE_NAVIGATION_GUIDANCE](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE) | Usage value to use when the usage is driving or navigation directions. |\n| 13               | [USAGE_ASSISTANCE_SONIFICATION](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANCE_SONIFICATION)  | Usage value to use when the usage is driving or navigation directions. |\n| 14               | [USAGE_GAME](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_GAME) | Usage value to use when the usage is media, such as music, or movie soundtracks. |\n| 16               | [USAGE_ASSISTANT](https://developer.android.com/reference/android/media/AudioAttributes#USAGE_ASSISTANT)  | Usage value to use for audio responses to user queries, audio instructions or help utterances. |\n\nSee [Android Documentation](https://developer.android.com/reference/android/media/AudioAttributes.Builder#setUsage(int))\n\n#### Property `androidColor`\nDefault: `null`\n\nThe notification background color for the small icon. The color will only be applied on the notification style and not on the status bar.\nSet as Hex-String like `#FF0000`. Calls [Notification.Builder#setColor](https://developer.android.com/reference/android/app/Notification.Builder#setColor(int)), which sets [Notification#color](https://developer.android.com/reference/android/app/Notification#color). \n\n#### Property `androidLargeIcon`\nDefault: `null`\n\nAdd a large icon to the notification content view. In the platform template, this image will be shown either on the right of the notification, with an aspect ratio of up to 16:9, or (when the notification is grouped) on the left in place of the small icon. Calls [Notification.Builder#setLargeIcon(android.graphics.Bitmap)](https://developer.android.com/reference/android/app/Notification.Builder#setLargeIcon(android.graphics.Bitmap)).\n\nExamples:\n- `res://myLargeIcon.png` - Resource from the app bundle, see [documentation](#resource-pattern-res)\n- `www/myLargeIcon.png` - `www` folder, see [documentation](#resource-pattern-file)\n- `shared://myLargeIcon.png` - Shared folder, see [documentation](#resource-pattern-shared), Android only\n\n#### Property `androidSmallIcon`\nDefault: `res://ic_popup_reminder` (=Bell icon)\n\nSets the small icon resource, which will be used to represent the notification in the status bar. Since Android 8, the icon must be a monochrome icon, which can only use a white color on a transparent background. The icon will be colored by the system in respective circumstances. You can also use a vector drawable, but only for a `res:\\\\` paths. You can get vector drawables on [Google Fonts Icons](https://fonts.google.com/icons) as example or for using it. Just select the download for Android. To know, what vector drawables are, see the Android documentation [Vector drawables overview](https://developer.android.com/develop/ui/views/graphics/vector-drawable-resources).\n\nThe platform template for the expanded view will draw this icon in the left, unless a large icon has also been specified, in which case the small icon will be moved to the right-hand side. Calls [Notification.Builder#setSmallIcon(int)](https://developer.android.com/reference/android/app/Notification.Builder#setSmallIcon(int)).\n\nExample: `res://myIcon.png` - Resource from the app bundle, see [documentation](#resource-pattern-res)\n\nOnly `res://` paths are allowed.\n\n#### Property `androidSummary`\nDefault: `null`\n\nUsed in the following cases:\n\n1. For [NotificationCompat.InboxStyle#setSummaryText(java.lang.CharSequence)](https://developer.android.com/reference/androidx/core/app/NotificationCompat.InboxStyle#setSummaryText(java.lang.CharSequence)), when using [NotificationCompat.InboxStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.InboxStyle), which happens, when the `text` property has line breaks.\n2. For [NotificationCompat.BigPictureStyle#setSummaryText(java.lang.CharSequence)](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigPictureStyle#setSummaryText(java.lang.CharSequence)), when [NotificationCompat.BigPictureStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigPictureStyle) is used, which happens, when `attachments` are used. If `androidSummary` is not set, `text` will be used.\n3. For [NotificationCompat.BigTextStyle#setSummaryText(java.lang.CharSequence)](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigTextStyle#setSummaryText(java.lang.CharSequence)), when [NotificationCompat.BigTextStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigTextStyle) is used, which happens, if the `text` property is longer then 44 characters.\n\n#### Property `attachments`\nDefault: `[]`\n\nList of resources, to attach to the notification.\n\n##### Android\nOnly the first entry will be used as a [bigPicture](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigPictureStyle#bigPicture(android.graphics.Bitmap)) of [NotificationCompat.BigPictureStyle](https://developer.android.com/reference/androidx/core/app/NotificationCompat.BigPictureStyle).\n\nSupport resource patterns:\n- [res://](#resource-pattern-res)\n- [shared://](#resource-pattern-shared)\n- [www](#resource-pattern-www)\n\nExample folded and unfolded:\n\n\u003cimg width=\"320\" src=\"images/android-attachments-image-folded.png\"\u003e\n\n\u003cimg width=\"320\" src=\"images/android-attachments-image-unfolded.png\"\u003e\n\nThe notification will be automatically unfolded in the notification center if your app presents only one notification. On the lockscreen the notification is always folded.\n\n##### iOS\nThe visual and audio attachments to display alongside the notification’s main content, see documentation of [UNMutableNotificationContent.attachments](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/attachments).\n\nSupport resource patterns:\n- `file:///` - Absolute file path\n- [res://](#resource-pattern-res) - App resource\n- [www](#resource-pattern-www)\n- `base64://` - Base64 string\n\nIf you attach an image, the image will shown as a small image to the right in the notification and will be expanded when you press long on the notification.\n\nExample folded and unfolded:\n\n\u003cimg width=\"320\" src=\"images/ios-attachments-image-folded.png\"\u003e\n\n\u003cimg width=\"320\" src=\"images/ios-attachments-image-unfolded.png\"\u003e\n\n##### Code example\n\n```javascript\ncordova.plugins.notification.local.schedule({\n    id: 1,\n    title: 'Get a fan!',\n    text: 'RB Leipzig is looking for a new fan! Click here to apply!',\n    attachments: ['www/img/rb-leipzig.png']\n});\n```\n\n#### Property `badgeNumber`\nDefault:\n- Android: `1` - Each notification increments the badge count by 1\n- iOS: `-1` - Does not set any badge\n\nSet the badge count. The behavior differs on Android and iOS.\n\n##### Android\nSets the number of items a notification represents. If the value is `1`, each notification increments the badge of the application by one. If 3 notifications are posted, the badge count will be `3`.\n\nOn newer Android versions, the badge count will be presented as a dot and shows the number, if you long press on the app icon.\n\nFor using the badge, see the Android documentation [Modify a notification badge](https://developer.android.com/develop/ui/views/notifications/badges).\n\nCalls [NotificationCompat.Builder#setNumber(int)](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder#setNumber(int)).\n\n##### iOS\nA notification does not increment the badge, it sets the badge count directly. If 3 notifications are posted with the value of `1`, the badge count will be `1` and not `3`.\n\nSpecials of this value:\n- `-1`: The badge  will not be changed.\n- `0`: The badge will be cleared.\n\nSets [UNMutableNotificationContent#badge](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/badge).\n\n###### Clearing the badge\nYou can clear the badge with the function [iOSClearBadge](#iosclearbadge).\n\nThe badge will also be cleared, if you call `clearAll` or `cancelAll`.\n\n#### Property `iOSForeground`\nDefault: `true`\n\nDisplays a notification banner when the app is in foreground, otherwise the notification would only make a noise (sound and vibrate), change the badge, but is not shown as a banner. Since iOS 14, the notification is always displayed in the Notification Center, no matter how this option is set to be consistent with Android. Renamed from `foreground` to `iOSForeground` and changed to `true` by default in Version `1.1.0`.\n\n#### Property `priority`\nDefault: `0` (=PRIORITY_DEFAULT)\n\nDeprecated since Android 8.\n\nReplaced by [androidChannelImportance](#property-androidchannelimportance), which sets also the [priority](https://developer.android.com/reference/android/app/Notification#priority) value for notifications on Android 7.\n\nThis property had aditional functionality for the plugin, which is replaced by [androidAlarmType](#property-androidalarmtype) and [androidAllowWhileIdle](#property-androidallowwhileidle).\n\n##### Old use case\nWhen the value was [PRIORITY_MIN](https://developer.android.com/reference/android/app/Notification#PRIORITY_MIN)(=-2), the alarm was scheduled with [RTC](https://developer.android.com/reference/android/app/AlarmManager#RTC).\nThis can now be achieved by setting [androidAlarmType](#property-androidalarmtype) to `RTC` and [androidAllowWhileIdle](#property-androidallowwhileidle) to false.\n\nWhen the value was [PRIORITY_DEFAULT](https://developer.android.com/reference/android/app/Notification#PRIORITY_DEFAULT)(=0), which was set as the default for this plugin, the alarm was scheduled with [RTC_WAKEUP](https://developer.android.com/reference/android/app/AlarmManager#RTC_WAKEUP). This can now be set by [androidAlarmType](#property-androidalarmtype).\n\nWhen the value was [PRIORITY_MAX](https://developer.android.com/reference/android/app/Notification#PRIORITY_MAX)(=2), the alarm was scheduled by [AlarmManager.setAndAllowWhileIdle](https://developer.android.com/reference/android/app/AlarmManager#setAndAllowWhileIdle(int,%20long,%20android.app.PendingIntent)) or [AlarmManager.setExactAndAllowWhileIdle](https://developer.android.com/reference/android/app/AlarmManager#setExactAndAllowWhileIdle(int,%20long,%20android.app.PendingIntent)). This can now be set by [androidAllowWhileIdle](#property-androidallowwhileidle).\n\n#### Property `sound`\nDefault: `default`\n\nThe value `default` sets the system default sound for a notification. The value `null` will disable the sound.\nOn Android it sets the sound of a notification channel. On iOS it enables/disables also the vibration.\n\nExample:\n- `res://mySound.wav` - Resource from the app bundle, see [documentation](#resource-pattern-res)\n- `shared://mySound.wav` - Shared folder, see [documentation](#resource-pattern-shared), Android only\n- `www/mySound.wav` - [Documentation](#resource-pattern-file)\n\n##### Android\nBefore Android 8 it sets the sound of a notification. Since Android 8 it sets the sound of a [notification channel](#create-channel).\n\n##### iOS\nEnables/disables also the vibration. If no sound is set, no vibration will occur.\n\nYou can package the audio data in an `aiff`, `wav`, or `caf` file. Sound files must be less than 30 seconds in length.\nIf the sound file is longer than 30 seconds, the system plays the default sound instead. See [UNNotificationSound - Prepare Sound Resources](https://developer.apple.com/documentation/usernotifications/unnotificationsound?language=objc#Prepare-Sound-Resources).\n\nThe system looks in the following folders for the file:\n- The `/Library/Sounds` directory of the app’s container directory.\n- The `/Library/Sounds` directory of one of the app’s shared group container directories.\n- The main bundle of the current executable.\n\nSee documentation [UNNotificationSound#soundNamed](https://developer.apple.com/documentation/usernotifications/unnotificationsound/init(named:)?language=objc#Discussion).\n\n### Resource resolving\n\nIf a property can take a resource, the following patterns could be used. Not all patterns are available for every property.\n\n#### Resource pattern `file://`\nExample: `file://myImage.png`\n\nLooks for a file in the `www` folder. `file://myImage.png` is equivalent to `www/myImage.png`.\n\n#### Resource pattern `www/`\nExample: `www/myImage.png`\n\nLooks for a file in the `www` folder.\n\n#### Resource pattern `res://`\nExample: `res://myImage.png`\n\nDefines a resource for Android or iOS. In Android it looks in the app's `res` folder, in iOS it looks for a file in the root of the app package.\n\n##### Android\nGets a resource from the `res` directory of your app or the system resources. Normally, when getting a resource file on Android, the resource name should not contain the file extension like `res://myImage`, but, to be compatible with iOS, you can also include the extension like `res://myImage.png`. An explanation what the `res`directory is, can be read in the Android documentation [Providing Resources](https://developer.android.com/guide/topics/resources/providing-resources).\n\nThe property, which you use, defines, in which subfolder of `res` the resource should be:\n- For a graphic: `drawable` and `mipmap`\n- For a sound: `raw`\n\nThe plugin trys first to get the resource from you app package, if it does not find one there, it trys to get it from the [system resources](https://developer.android.com/reference/android/content/res/Resources#getSystem()).\n\nIf you want to use a system resource, you have to use a valid resource identifier, which you can look for in [Android Code Search](https://cs.android.com/android/platform/superproject/main/+/main:frameworks/base/core/res/res/). An example would be [ic_popup_reminder](https://cs.android.com/android/platform/superproject/main/+/main:frameworks/base/core/res/res/drawable-mdpi/ic_popup_reminder.png), which you would set with `res://ic_popup_reminder`.\n\nTo make files files available in the `res` directory, you can use the [resource-file](https://cordova.apache.org/docs/en/12.x/config_ref/#resource-file) tag in `config.xml` like:\n\n```xml\n\u003cplatform name=\"android\"\u003e\n    \u003cresource-file src=\"res/drawable/myImage.png\" target=\"app/src/main/res/drawable/myImage.png\" /\u003e\n    \u003cresource-file src=\"res/raw/mySound.wav\" target=\"app/src/main/res/raw/mySound.wav\" /\u003e\n\u003c/platform\u003e\n``` \n\nThe directory structure for this example would be:\n```\n|- res\n   |- drawable\n       |- myImage.png \n   |- raw\n       |- mySound.wav\n|- config.xml\n|- plugins\n|- platforms\n...\n```\n\n##### iOS\nLooks for a file in the root of the app package.\n\nFor e.g.:\n`res://AppIcon60x60@3x.png` would point to `YourApp.ipa/AppIcon60x60@3x.png` on a release build or `YourApp.app/AppIcon60x60@3x.png` on a debug build. The app container is a zip file. On a mac, you can right click on your app container and choose `Show package contents`.\n\nTo copy files to the app bundle, use the [resource-file](https://cordova.apache.org/docs/en/12.x/config_ref/#resource-file) tag in your `config.xml` like:\n\n```xml\n\u003cplatform name=\"ios\"\u003e\n    \u003cresource-file src=\"res/myAudio.wav\" target=\"myAudio.wav\" /\u003e\n\u003c/platform\u003e\n```\n\nThe directory structure for the example would be:\n```\n|- res\n   |- myAudio.wav\n|- config.xml\n|- plugins\n|- platforms\n...\n```\n\n#### Resource pattern `shared://`\nExample: `shared://myImage.png`\n\nAndroid only.\n\n##### Android\nA shared file in `[Installed-App-Path]/files/shared_files`. This is necessary to get useable Uris for asset files, which are the files of the `www` directory. You can also use the `shared_files` directory, to store files created on runtime. To access the directory, you can use [cordova.file.dataDirectory](https://github.com/apache/cordova-plugin-file#where-to-store-files) of the plugin [cordova-plugin-file](https://github.com/apache/cordova-plugin-file) and write to the folder `shared_files`. The folder `shared_files` will be created on plugin initialization.\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## License\n\nThis software is released under the [Apache 2.0 License][apache2_license].\n\nMade with :yum: from Leipzig and since 2024 from Cuxhaven\n\n© 2013-2023 [appPlant GmbH][appplant]\n\u003cbr\u003e© 2024-2025 [Manuel Beck](https://manuelbeck.software)\n\n\n[ticket_template]: https://github.com/katzer/cordova-plugin-local-notifications/issues/1188\n[cordova]: https://cordova.apache.org\n[CLI]: http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface\n[npm]: https://www.npmjs.com/package/cordova-plugin-local-notification\n[apache2_license]: http://opensource.org/licenses/Apache-2.0\n[appplant]: http://appplant.de","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fcordova-plugin-local-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatzer%2Fcordova-plugin-local-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fcordova-plugin-local-notifications/lists"}