GitHub - katzer/cordova-plugin-local-notifications: Cordova Local-Notification Plugin

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.

Notification components

Header area
Content area
Action area

How notifications may be noticed

Showing a status bar icon
Appearing on the lock screen
Playing a sound or vibrating
Peeking onto the current screen
Blinking the device's LED

Supported platforms

Android 7.0+ (cordova-android 13.0.0)
iOS 11.3+ (cordova-ios 7.0.0)

Installation

The plugin can be installed via Cordova-CLI and is publicly available on NPM.

NPM

Execute from the projects root folder:

$ cordova plugin add cordova-plugin-local-notification

Install a specific version:

$ cordova plugin add cordova-plugin-local-notification@VERSION

Git

Install the latest head version:

$ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git

Install from a branch:

$ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#branch

Install from a tag:

$ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#v1.0.0

Install from a specific commit:

$ cordova plugin add https://github.com/katzer/cordova-plugin-local-notifications.git#5e4f131

Local

Install from local source:

$ cordova plugin add <path> --nofetch --nosave --link

Upgrade Notice

In Version 1.1.0 some properties were changed. Please see Changes since Version 1.1.0

Basics

The plugin creates the object cordova.plugins.notification.local and is accessible after deviceready has been fired.

cordova.plugins.notification.local.schedule({
    title: 'My first notification',
    text: 'Thats pretty easy...'
});

The plugin allows to schedule multiple notifications at once.

cordova.plugins.notification.local.schedule([
    { id: 1, title: 'My first notification' },
    { id: 2, title: 'My first notification' }
]);

Notification Limits

On each platform are limits about how much notifications can be scheduled:

iOS: 64
Android: 500

Repeating notifications count as 1 notification, except if you schedule with the trigger count option on Android.

Properties

A notification does have a set of configurable properties. See documentation.

Android notification channels

Since Android 8 notification channels must be created to post noitifications. A default channel will be created, if you do not create one.

Default channel

The following settings will be used, if you do not specifiy a channel.

{
    androidChannelId: "default_channel",
    androidChannelName: "Default channel",
    androidChannelImportance: "IMPORTANCE_DEFAULT"
}

You can change the defaults by calling setDefaults or you can overwrite them, when scheduling a notification or creating a channel.

Create channel

You can create a channel directly with createChannel or when scheduling a notification. A channel is not changeable, after it is created. This is a restriction by Android. For setting the channel, use androidChannelId when scheduling a notification.

Create channel by posting a notification

A channel can be created directly, when posting a notification:

cordova.plugins.notification.local.schedule({
    id: 1,
    title: 'My first notification',
    androidChannelId: "my_channel_01",
    androidChannelName: "My Channel Name"
});

If you omit some channel properties, the defaults will be used.

Delete a channel

You can delete a channel with the deleteChannel method.

Android inexact and exact alarms

Since Android 13 notifications will be scheduled inexact by default. This means the notifications can be delayed by some minutes. If you want exact alarms, the user must grant the permission in the "Alarms & Reminders"-setting, which you can call by openAlarmSettings. To check, if exact alarms are permitted, you can use canScheduleExactAlarms.

Specials about Android

App Update

When installing an update of your app, all notifications will be rescheduled by this plugin, because Android removes all scheduled alarms on an update.

Device reboot

When the device reboots, all notifications will be rescheduled by the plugin, because Android cancels all alarams after a device reboot. If the user has setup a device lock, the user must first unlock this so the notifications can be rescheduled.

Actions

The plugin knows two types of actions: button and input.

cordova.plugins.notification.local.schedule({
    title: 'The big survey',
    text: 'Are you a fan of RB Leipzig?',
    attachments: ['www/img/rb-leipzig.jpg'],
    actions: [
        { id: 'yes', title: 'Yes' },
        { id: 'no',  title: 'No' }
    ]
});

Icons on action buttons are not displayed anymore since Android 7, see documentation

Input

cordova.plugins.notification.local.schedule({
    title: 'Justin Rhyss',
    text: 'Do you want to go see a movie tonight?',
    actions: [{
        id: 'reply',
        type: 'input',
        title: 'Reply',
        emptyText: 'Type message',
    }, ... ]
});

It is recommended to pre-define action groups rather then specifying them with each new notification of the same type.

cordova.plugins.notification.local.addActions('yes-no', [
    { id: 'yes', title: 'Yes' },
    { id: 'no',  title: 'No'  }
]);

Once you have defined an action group, you can reference it when scheduling notifications:

cordova.plugins.notification.local.schedule({
    title: 'Justin Rhyss',
    text: 'Do you want to go see a movie tonight?',
    actions: 'yes-no'
});

Properties

Actions do have a set of configurable properties. Not all of them are supported across all platforms.

Property	Type	Android	iOS
id	button+input	x	x
title	button+input	x	x
launch	button+input	x	x
ui	button+input		x
needsAuth	button+input		x
icon	button+input	x
emptyText	input	x	x
submitTitle	input		x
editable	input	x
choices	input	x
defaultValue	input

Triggers

Notifications may trigger immediately or depend on calendar or location.

To trigger at a fix date:

cordova.plugins.notification.local.schedule({
    title: 'Design team meeting',
    text: '3:00 - 4:00 PM',
    trigger: { at: new Date(2017, 10, 27, 15) }
});

Or relative from now:

cordova.plugins.notification.local.schedule({
    title: 'Design team meeting',
    trigger: { in: 1, unit: 'hour' }
});

Repeating

Repeat relative from now:

cordova.plugins.notification.local.schedule({
    title: 'Design team meeting',
    trigger: { every: 'day', count: 5 }
});

Or trigger every time the date matches:

cordova.plugins.notification.local.schedule({
    title: 'Happy Birthday!!!',
    trigger: { every: { month: 10, day: 27, hour: 9, minute: 0 } }
});

Location based

To trigger when the user enters a region:

cordova.plugins.notification.local.schedule({
    title: 'Welcome to our office',
    trigger: {
        type: 'location',
        center: [x, y],
        radius: 15,
        notifyOnEntry: true
    }
});

Properties

The properties depend on the trigger type. Not all of them are supported across all platforms.

Type	Property	Type	Value	Android	iOS
Fix
	at	Date		x	x
Timespan
	in	Int		x	x
	unit	String	`second`	x	x
	unit	String	`minute`	x	x
	unit	String	`hour`	x	x
	unit	String	`day`	x	x
	unit	String	`week`	x	x
	unit	String	`month`	x	x
	unit	String	`quarter`	x	x
	unit	String	`year`	x	x
Repeat
	count	Int		x
	every	String	`minute`	x	x
	every	String	`hour`	x	x
	every	String	`day`	x	x
	every	String	`week`	x	x
	every	String	`month`	x	x
	every	String	`quarter`	x
	every	String	`year`	x	x
	before	Date		x
	firstAt	Date		x
Match
	count	Int		x
	every	Object	`minute`	x	x
	every	Object	`hour`	x	x
	every	Object	`day`	x	x
	every	Object	`weekday`	x	x
	every	Object	`weekdayOrdinal`		x
	every	Object	`week`		x
	every	Object	`weekOfMonth`	x	x
	every	Object	`month`	x	x
	every	Object	`quarter`		x
	every	Object	`year`	x	x
	before	Date		x
	after	Date		x
Location
	center	Array	`[lat, long]`		x
	radius	Int			x
	notifyOnEntry	Boolean			x
	notifyOnExit	Boolean			x
	single	Boolean			x

Progress

Android only

Notifications can include an animated progress indicator that shows users the status of an ongoing operation.

cordova.plugins.notification.local.schedule({
    title: 'Sync in progress',
    text: 'Copied 2 of 10 files',
    androidProgressBar: {
        value: 20, // Default 0
        maxValue: 100, // Default 100
        indeterminate: false // Default false
    }
});

Calls NotificationCompat.Builder#setProgress(int,int,boolean)

Indeterminate Progress

Use 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.

See ProgressBar#indeterminate-progress

Determinate Progress

Use 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.

See ProgressBar#determinate-progress

Patterns

Android only

Split the text by line breaks if the message comes from a single person and just too long to show in a single line.

cordova.plugins.notification.local.schedule({
    title: 'The Big Meeting',
    text: '4:15 - 5:15 PM\nBig Conference Room',
    androidSmallIcon: 'res://ic_menu_my_calendar',
    androidLargeIcon: 'res://large_icon'
});

Summarizing

Android only

Instead of displaying multiple notifications, you can create one notification that summarizes them all.

cordova.plugins.notification.local.schedule({
    id: 15,
    title: 'Chat with Irish',
    androidLargeIcon: 'res://large_icon',
    androidMessages: [
        { person: 'Me', message: 'I miss you' },
        { person: 'Irish', message: 'I miss you more!' },
        { person: 'Me', message: 'I always miss you more by 10%' }
    ]
});

To add a new message to the existing chat:

cordova.plugins.notification.local.update({
    id: 15,
    androidMessages: [{ person: 'Irish', message: 'Bye bye' }]
});

For displaying the messages, NotificationCompat.MessagingStyle will be used.

Available properties for `androidMessages`

androidMessags: [
    {
        message: "The message", // Default is `null`
        date: 1234567890, // Timestamp in milliseconds for e.g. by Date.getTime(), default is System.currentTimeMillis()
        person: "Michael", // Default is `null`
        personIcon: "www/personIcon.png" // Default is `null`
    }
]

For setting the path for personIcon see URL resolving.

Grouping

Android only

Your app can present multiple notifications as a single group:

A parent notification displays a summary of its child notifications.
The child notifications are presented without duplicate header information.

cordova.plugins.notification.local.schedule([
    { id: 0, title: 'Design team meeting', ... },
    { id: 1, androidSummary: '[email protected]', androidGroup: 'email', androidGroupSummary: true },
    { id: 2, title: 'Please take all my money', ... androidGroup: 'email' },
    { id: 3, title: 'A question regarding this plugin', ... androidGroup: 'email' },
    { id: 4, title: 'Wellcome back home', ... androidGroup: 'email' }
]);

Permissions

Each platform may require the user to grant permissions first before the app is allowed to schedule notifications.

cordova.plugins.notification.local.hasPermission(function (granted) { ... });

If requesting via plug-in, a system dialog does pop up for the first time. Later its only possible to tweak the settings through the system settings.

cordova.plugins.notification.local.requestPermission(function (granted) { ... });

Checking the permissions is done automatically, however it's possible to skip that.

cordova.plugins.notification.local.schedule(toast, callback, scope, { skipPermission: true });

Events

The following events are supported: add, trigger, click, clear, cancel, update, clearall and cancelall.

cordova.plugins.notification.local.on(event, callback, scope);

To unsubscribe from events:

cordova.plugins.notification.local.un(event, callback, scope);

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. Hence 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.

Custom

The plugin also fires events specified by actions.

cordova.plugins.notification.local.schedule({
    title: 'Do you want to go see a movie tonight?',
    actions: [{ id: 'yes', title: 'Yes' }]
});

The name of the event is the id of the action.

cordova.plugins.notification.local.on('yes', function (notification, eopts) { ... });

Fire manually

Not an official interface, however its possible to manually fire events.

cordova.plugins.notification.local.core.fireEvent(event, args);

Launch Details

Check the launchDetails to find out if the app was launched by clicking on a notification.

document.addEventListener('deviceready', function () {
    console.log(cordova.plugins.notification.local.launchDetails);
}, false);

It 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.

Therefore its possible to fire the queued events manually by defining a global variable.

window.skipLocalNotificationReady = true

Once the app and Ionic is ready, you can fire the queued events manually.

cordova.plugins.notification.local.fireQueuedEvents();

Methods

All methods work asynchronous and accept callback methods.

Note: This list has still to be documented.

Method	Android	iOS	Comment
addActions
cancel	x	x
cancelAll	x	x
canScheduleExactAlarms	x	-	Android only. Checks if exact alarms are permitted. Since Android 13 inexact alarms are permitted by default.
clear	x	x	On Android, it clears a already posted notification from the statusbar.
clearAll	x	x
createChannel	x	-	Android only. Creates a channel for Android to post notifications on.
deleteChannel	x	-	Android only. Delete a channel by an id. See Documentation
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.
get
getAll
getDefaults	x	x	Gets the default for notification properties. See getDefaults
getIds
getScheduled
getScheduledIds
getTriggered
getTriggeredIds
getType
hasActions
hasPermission
iOSClearBadge	-	x	Clears the badge
isPresent
isScheduled
isTriggered
on
openAlarmSettings	x	-	Android only. Supported since Android 12. Opens the "Alarms & Reminders"-settings, where the user can manually enable exact alarms.
openNotificationSettings	x	(x)	Opens the notifications settings since Android 8. On iOS it opens the app settings.
removeActions
requestPermission
schedule
setDefaults	x	x	Overwrites default values of notifications. Gets the default for notification properties. See setDefaults
un
update

canScheduleExactAlarms

Android only

Checks if the user has enabled the "Alarms & Reminders"-setting. If not, the notificiatons will be scheduled inexact, which is still ok and will only be delayed by some minutes.

On Android 11 and older, this method will always return true in the successCallback.
On Android 12 the permission is granted by default
On Android 13 and newer, the permission is not granted by default and have to be explicitly enabled by the user.

createChannel

Android only

Creates a channel, if it not already exists.

A channel is not changeable, after it is created. This is a restriction by Android. If a notification does not specify a androidChannelId a default channel will be used.

For setting the channel, use androidChannelId when scheduling a notification.

Overview of all properties for a channel:

cordova.plugins.notification.local.createChannel({
    androidChannelId: "my_channel_01", // string, to separate something in the id, use "_" instead of "-"
    androidChannelName: "My Channel Name", // string, defaults to "Default Channel"
    androidChannelDescription: "Description of channel", // string (optional)
    androidChannelImportance: "IMPORTANCE_DEFAULT", // string (optional), see property documentation for importance
    vibrate: true, // bool (optional), default is false
    androidChannelEnableLights: true, // bool (optional), default is false
    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
    androidChannelSoundUsage: 5 // int (optional), default is USAGE_NOTIFICATION
  }, successCallback, this)

deleteChannel

Android only

Deletes a Android channel.

Example:

cordova.plugins.notification.local.deleteChannel("my_channel_id", successCallback, this)

These 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

getDefaults

Returns the default values all properties on each platform.

Example:

cordova.plugins.notification.local.getDefaults();

iOSClearBadge

Clears the badge.

openAlarmSettings

Android only. Since Android 12 (SDK 31).

Opens the "Alarms & Reminders"-settings as an Activity when running on Android 12 (SDK 31) or later, where the user can enable exact alarms. This 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.

If the user grants permission, already inexact scheduled notifications will be rescheduled as exact alarms.
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.
On Android older then 12, it will just call the successCallback, without doing anything.

openNotificationSettings

Opens 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.

On Android, the callback will just return "OK", after starting the activity.
On Android older then 8, it opens the app details.
On iOS it's not possible to open the notification settings, it will open the app settings.

setDefaults

Changes default values of properties.

Example:

cordova.plugins.notification.local.setDefaults({
    androidChannelId: "my_channel_01",
    title: "My default Title"
});

Properties

Changed properties

List of changed properties on newer plugin versions.

Changes since version `1.1.0`

There 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.

Old Property	New Property
autoClear	androidAutoCancel
badge	badgeNumber
channelDescription	androidChannelDescription
channelId	androidChannelId
channelImportance	androidChannelImportance
channelName	androidChannelName
clock	Use for `clock: true` = `androidShowWhen` and `clock: 'chronometer'` = `androidUsesChronometer`
color	androidColor
defaults	androidDefaults
description	androidChannelDescription
foreground	iOSForeground
group	androidGroup
groupSummary	androidGroupSummary
icon	androidLargeIcon
iconType	androidLargeIconType
importance	androidChannelImportance
lockscreen	androidLockscreen
mediaSession	Property was removed
onlyAlertOnce	androidOnlyAlertOnce
prio	Use `androidChannelImportance`, `androidAlarmType` and `androidAllowWhileIdle` instead.
priority	Use `androidChannelImportance`, `androidAlarmType` and `androidAllowWhileIdle` instead.
progressBar	androidProgressBar
smallIcon	androidSmallIcon
sticky	androidOngoing
soundUsage	androidChannelSoundUsage
ongoing	androidOngoing
summary	androidSummary
text as Array	androidMessages
timeoutAfter	androidTimeoutAfter
titleCount	androidTitleCount
wakeup	androidWakeUpScreen

Common properties

These properties can be used on all platforms, but some may behave differently on each platform.

Property	Default	Comment
actions	`[]`	Actions of a notification
attachments	`[]`	List of resources, to attach to the notification.
badgeNumber	Android: `1`, iOS: `-1`	Sets the badge for the application. The behaviour differs on Android and iOS.
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.
id	`0`	Id of the notification as number.
launch	`true`	If a click on the notification should launch the app.
priority	`0` (=PRIORITY_DEFAULT)	Deprecated. Use androidChannelImportance, androidAlarmType and androidAllowWhileIdle
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)
text	`""`	Text of the notification. Android features: 1. If the text contains line breaks (`\n`) the notification style NotificationCompat.InboxStyle will be used. 2. If the text is longer then 44 chars, the notifications style NotificationCompat.BigTextStyle will be used.
sound	`default`
title	`""` (Sets the app name)	Title of the notification. Has to be a String. If it is empty, the app name will be used.
trigger	`{type : "calendar"}`	Notifications may trigger immediately or depend on calendar or location.

Android properties

These properties are only available on Android.

Property	Default	Comment
androidAlarmType	`RTC_WAKEUP`
androidAllowWhileIdle	`false`	Alarm will be allowed to execute even when the system is in low-power idle (a.k.a. doze) modes.
androidAutoCancel	`true`	Make this notification automatically dismissed when the user touches it
androidChannelDescription	`null`	Sets the `description` of a notification channel.
androidChannelEnableLights	`false`	Can be `true` or `false`and sets whether notifications posted to a notification channel should display notification lights, on devices that support that feature.
androidChannelId	`default_channel`	Set the `channelId` for the notification to be posted on. See Android Notification Channels for more information.
androidChannelImportance	`IMPORTANCE_DEFAULT`	Sets the importance of a notification channel
androidChannelName	`Default channel`	Set the `channelName` for the notification to be posted on. See Android Notification Channels for more information.
androidChannelSoundUsage	`5` (=USAGE_NOTIFICATION)	Sets the androidChannelSoundUsage of a notification channel.
androidColor	`null`	The notification background color for the small icon in the notification style.
androidGroup	`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)
androidGroupSummary	`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)
androidLargeIcon	`null`	Add a large icon to the notification content view.
androidLargeIconType	`square`	Can be `square` or `circle`
androidLockscreen	`true`	If the entire notification should be shown on all lockscreens and while screen sharing. If the value is `true`, Notification#VISIBILITY_PUBLIC will be set, otherwise Notification#VISIBILITY_SECRET. Sets Notification#visibility.
androidMessages	`null`	Array of messages to summarize notifications. NotificationCompat.MessagingStyle will be used.
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.
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).
androidProgressBar	`null`	See documentation
androidShowWhen	`true`	If the Notification should show the when date. Before Version 1.1.0 called `clock`.
androidSmallIcon	`res://ic_popup_reminder` (=Bell icon)	Set the small icon resource, which will be used to represent the notification in the status bar.
androidSummary	`null`
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.
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.
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'`
androidWakeUpScreen	`true`	If the screen should go on, when a notification arrives
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.
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`.
vibrate	`false`	On Android 7, sets the vibration of a notification. Since Android 8, this sets the vibration of a notification channel. In iOS it would be possible, but it is not implemented yet.

iOS properties

These properties are only available on iOS.

Property	Default value	Comment
iOSForeground	`true`	Displays a notification when the app is in foreground. Renamed from `foreground` to `iOSForeground` and changed to `true` by default in Version 1.1.0

Default values

Default values for the properties can be get by getDefaults. Values can be changed by setDefaults

Notes

Some notes about unsupported properties on iOS:

progressBar: Natively not supported by iOS, see Stackoverflow

Available properties

Property `androidAllowWhileIdle`

Default: false

Alarm will be allowed to execute even when the system is in low-power idle (a.k.a. doze) modes.

This 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.

This executes AlarmManager.setAndAllowWhileIdle or AlarmManager.setExactAndAllowWhileIdle depending on canScheduleExactAlarms.

Property `androidAlarmType`

Default: RTC_WAKEUP

If 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).

Value	Support	Description
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.
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.
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.
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.

Property `androidChannelImportance`

Default: "IMPORTANCE_DEFAULT"

The property can have one of the following values:

Value	Description
IMPORTANCE_NONE	A notification with no importance: shows nowhere, is blocked.
IMPORTANCE_MIN	Min notification importance: only shows in the shade, below the fold.
IMPORTANCE_LOW	Low notification importance: shows everywhere, but is not intrusive.
IMPORTANCE_DEFAULT	Default notification importance: shows everywhere, allowed to makes noise, but does not visually intrude.
IMPORTANCE_HIGH	Higher notification importance: shows everywhere, allowed to makes noise and peek.
IMPORTANCE_MAX	Highest notification importance: shows everywhere, allowed to makes noise, peek, and use full screen intents.

See the Android documentation about this property.

See also NotificationChannel#NotificationChannel(java.lang.String,%20java.lang.CharSequence,%20int)

Property `androidChannelSoundUsage`

Default: 5 (=USAGE_NOTIFICATION)

The property can have one of the following values:

Property value	Android variable	Description
0	USAGE_UNKNOWN	Usage value to use when the usage is unknown.
1	USAGE_MEDIA	Usage value to use when the usage is media, such as music, or movie soundtracks.
2	USAGE_VOICE_COMMUNICATION	Usage value to use when the usage is voice communications, such as telephony or VoIP.
3	USAGE_VOICE_COMMUNICATION_SIGNALLING	Usage value to use when the usage is in-call signalling, such as with a "busy" beep, or DTMF tones.
4	USAGE_ALARM	Usage value to use when the usage is an alarm (e.g. wake-up alarm).
5	USAGE_NOTIFICATION	Usage value to use when the usage is notification. See other notification usages for more specialized uses.
6	USAGE_NOTIFICATION_RINGTONE	Usage value to use when the usage is telephony ringtone.
7	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.
8	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.
9	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.
10	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.
11	USAGE_ASSISTANCE_ACCESSIBILITY	Usage value to use when the usage is for accessibility, such as with a screen reader.
12	USAGE_ASSISTANCE_NAVIGATION_GUIDANCE	Usage value to use when the usage is driving or navigation directions.
13	USAGE_ASSISTANCE_SONIFICATION	Usage value to use when the usage is driving or navigation directions.
14	USAGE_GAME	Usage value to use when the usage is media, such as music, or movie soundtracks.
16	USAGE_ASSISTANT	Usage value to use for audio responses to user queries, audio instructions or help utterances.

See Android Documentation

Property `androidColor`

Default: null

The notification background color for the small icon. The color will only be applied on the notification style and not on the status bar. Set as Hex-String like #FF0000. Calls Notification.Builder#setColor, which sets Notification#color.

Property `androidLargeIcon`

Default: null

Add 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)

Examples:

res://myLargeIcon.png - Resource from the app bundle, see documentation
www/myLargeIcon.png - www folder, see documentation
shared://myLargeIcon.png - Shared folder, see documentation, Android only

Property `androidSmallIcon`

Default: res://ic_popup_reminder (=Bell icon)

Sets 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.

The 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).

Example: res://myIcon.png - Resource from the app bundle, see documentation

Only res:// paths are allowed.

Property `androidSummary`

Default: null

Used in the following cases:

For NotificationCompat.InboxStyle#setSummaryText(java.lang.CharSequence), when using NotificationCompat.InboxStyle, which happens, when the text property has line breaks.
For NotificationCompat.BigPictureStyle#setSummaryText(java.lang.CharSequence), when NotificationCompat.BigPictureStyle is used, which happens, when attachments are used. If androidSummary is not set, text will be used.
For NotificationCompat.BigTextStyle#setSummaryText(java.lang.CharSequence), when NotificationCompat.BigTextStyle is used, which happens, if the text property is longer then 44 characters.

Property `attachments`

Default: []

List of resources, to attach to the notification.

Android

Only the first entry will be used as a bigPicture of NotificationCompat.BigPictureStyle.

Support resource patterns:

res://
shared://
www

iOS

The visual and audio attachments to display alongside the notification’s main content, see documentation of UNMutableNotificationContent.attachments.

Support resource patterns:

file:/// - Absolute file path
res:// - App resource
www
base64:// - Base64 string

Property `badgeNumber`

Default:

Android: 1 - Each notification increments the badge count by 1
iOS: -1 - Does not set any badge

Set the badge count. The behavior differs on Android and iOS.

Android

Sets 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.

On newer Android versions, the badge count will be presented as a dot and shows the number, if you long press on the app icon.

For using the badge, see the Android documentation Modify a notification badge.

Calls NotificationCompat.Builder#setNumber(int).

iOS

A 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.

Specials of this value:

-1: The badge will not be changed.
0: The badge will be cleared.

Sets UNMutableNotificationContent#badge.

Clearing the badge

You can clear the badge with the function iOSClearBadge.

The badge will also be cleared, if you call clearAll or cancelAll.

Property `priority`

Default: 0 (=PRIORITY_DEFAULT)

Deprecated since Android 8.

Replaced by androidChannelImportance, which sets also the priority value for notifications on Android 7.

This property had aditional functionality for the plugin, which is replaced by androidAlarmType and androidAllowWhileIdle.

Old use case

When the value was PRIORITY_MIN(=-2), the alarm was scheduled with RTC. This can now be achieved by setting androidAlarmType to RTC and androidAllowWhileIdle to false.

When the value was PRIORITY_DEFAULT(=0), which was set as the default for this plugin, the alarm was scheduled with RTC_WAKEUP. This can now be set by androidAlarmType.

When the value was PRIORITY_MAX(=2), the alarm was scheduled by AlarmManager.setAndAllowWhileIdle or AlarmManager.setExactAndAllowWhileIdle. This can now be set by androidAllowWhileIdle.

Property `sound`

Default: default

The value default sets the system default sound for a notification, on Android for the notification channel. The value null will disable the sound.

Example:

res://mySound.wav - Resource from the app bundle, see documentation
shared://mySound.wav - Shared folder, see documentation, Android only
www/mySound.wav - Documentation

Android

Before Android 8 it sets the sound of a notification. Since Android 8 it sets the sound of a notification channel.

iOS

You can package the audio data in an aiff, wav, or caf file. Sound files must be less than 30 seconds in length. If the sound file is longer than 30 seconds, the system plays the default sound instead. See UNNotificationSound - Prepare Sound Resources.

The system looks in the following folders for the file:

The /Library/Sounds directory of the app’s container directory.
The /Library/Sounds directory of one of the app’s shared group container directories.
The main bundle of the current executable.

See documentation UNNotificationSound#soundNamed.

Resource resolving

If a property can take a resource, the following patterns could be used. Not all patterns are available for every property.

Resource pattern `file://`

Example: file://myImage.png

Looks for a file in the www folder. file://myImage.png is equivalent to www/myImage.png.

Resource pattern `www/`

Example: www/myImage.png

Looks for a file in the www folder.

Resource pattern `res://`

Example: res://myImage.png

Defines 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.

Android

Gets 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 resdirectory is, can be read in the Android documentation Providing Resources.

The property, which you use, defines, in which subfolder of res the resource should be:

For a graphic: drawable and mipmap
For a sound: raw

The 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.

If you want to use a system resource, you have to use a valid resource identifier, which you can look for in Android Code Search. An example would be ic_popup_reminder, which you would set with res://ic_popup_reminder.

To make files files available in the res directory, you can use the resource-file tag in config.xml like:

<platform name="android">
    <resource-file src="res/drawable/myImage.png" target="app/src/main/res/drawable/myImage.png" />
    <resource-file src="res/raw/mySound.wav" target="app/src/main/res/raw/mySound.wav" />
</platform>

The directory structure for this example would be:

|- res
   |- drawable
       |- myImage.png 
   |- raw
       |- mySound.wav
|- config.xml
|- plugins
|- platforms
...

iOS

Looks for a file in the root of the app package.

For e.g.: res://[email protected] would point to YourApp.ipa/[email protected] on a release build or YourApp.app/[email protected] 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.

To copy files to the app bundle, use the resource-file tag in your config.xml like:

<platform name="ios">
    <resource-file src="res/myAudio.wav" target="myAudio.wav" />
</platform>

The directory structure for the example would be:

|- res
   |- myAudio.wav
|- config.xml
|- plugins
|- platforms
...

Resource pattern `shared://`

Example: shared://myImage.png

Android only.

Android

A 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 of the plugin cordova-plugin-file and write to the folder shared_files. The folder shared_files will be created on plugin initialization.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

This software is released under the Apache 2.0 License.

Made with 😋 from Leipzig and since 2024 from Cuxhaven

Name		Name	Last commit message	Last commit date
Latest commit History 961 Commits
images		images
src		src
www		www
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
ISSUE_TEMPLATE.md		ISSUE_TEMPLATE.md
LICENSE		LICENSE
README.md		README.md
package.json		package.json
plugin.xml		plugin.xml

License

katzer/cordova-plugin-local-notifications

Folders and files

Latest commit

History

Repository files navigation

Notification components

How notifications may be noticed

Supported platforms

Installation

NPM

Git

Local

Upgrade Notice

Basics

Notification Limits

Properties

Android notification channels

Default channel

Create channel

Create channel by posting a notification

Delete a channel

Android inexact and exact alarms

Specials about Android

App Update

Device reboot

Actions

Input

Properties

Triggers

Repeating

Location based

Properties

Progress

Indeterminate Progress

Determinate Progress

Patterns

Summarizing

Available properties for androidMessages

Grouping

Permissions

Events

Custom

Fire manually

Launch Details

Methods

canScheduleExactAlarms

createChannel

deleteChannel

getDefaults

iOSClearBadge

openAlarmSettings

openNotificationSettings

setDefaults

Properties

Changed properties

Changes since version 1.1.0

Common properties

Android properties

iOS properties

Default values

Notes

Available properties

Property androidAllowWhileIdle

Property androidAlarmType

Property androidChannelImportance

Property androidChannelSoundUsage

Property androidColor

Property androidLargeIcon

Property androidSmallIcon

Property androidSummary

Property attachments

Android

iOS

Property badgeNumber

Android

iOS

Clearing the badge

Property priority

Old use case

Available properties for `androidMessages`

Changes since version `1.1.0`

Property `androidAllowWhileIdle`

Property `androidAlarmType`

Property `androidChannelImportance`

Property `androidChannelSoundUsage`

Property `androidColor`

Property `androidLargeIcon`

Property `androidSmallIcon`

Property `androidSummary`

Property `attachments`

Property `badgeNumber`

Property `priority`

Property `sound`

Resource pattern `file://`

Resource pattern `www/`

Resource pattern `res://`

Resource pattern `shared://`

Packages