cordova-plugin-local-notifications

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 4.4+
• iOS 10+
• Windows 10

Important Notice

Read the installation section below to correctly install the latest version, since this repository is forked.

Known issues

• None

Please report bugs or missing features!

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...',
    foreground: true
});

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' }
]);

Properties

A notification does have a set of configurable properties. Not all of them are supported across all platforms.

Property	Property	Property	Property	Property	Property	Property	Property
id	data	timeoutAfter	summary	led	clock	channel	channelDescription
text	icon	attachments	smallIcon	color	defaults	launch	groupSummary
title	silent	progressBar	sticky	vibrate	priority	mediaSession	foreground
sound	trigger	group	autoClear	lockscreen	number	badge	wakeup
actions	when

For their default values see:

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

To change some default values:

cordova.plugins.notification.local.setDefaults({
    led: { color: '#FF00FF', on: 500, off: 500 },
    vibrate: false
});

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: ['file://img/rb-leipzig.jpg'],
    actions: [
        { id: 'yes', title: 'Yes' },
        { id: 'no',  title: 'No' }
    ]
});

         

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	Windows
id	button+input	x	x	x
title	button+input	x	x	x
launch	button+input	x	x	x
ui	button+input		x
needsAuth	button+input		x
icon	button+input	x
emptyText	input	x	x	x
submitTitle	input		x
editable	input	x
choices	input	x
defaultValue	input			x

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	Windows
Fix
	at	Date		x	x	x
Timespan
	in	Int		x	x	x
	unit	String	second	x	x	x
	unit	String	minute	x	x	x
	unit	String	hour	x	x	x
	unit	String	day	x	x	x
	unit	String	week	x	x	x
	unit	String	month	x	x	x
	unit	String	quarter	x	x	x
	unit	String	year	x	x	x
Repeat
	count	Int		x		x
	every	String	minute	x	x	x
	every	String	hour	x	x	x
	every	String	day	x	x	x
	every	String	week	x	x	x
	every	String	month	x	x	x
	every	String	quarter	x		x
	every	String	year	x	x	x
	before	Date		x		x
	firstAt	Date		x		x
Match
	count	Int		x		x
	every	Object	minute	x	x	x
	every	Object	hour	x	x	x
	every	Object	day	x	x	x
	every	Object	weekday	x	x	x
	every	Object	weekdayOrdinal		x
	every	Object	week		x
	every	Object	weekOfMonth	x	x	x
	every	Object	month	x	x	x
	every	Object	quarter		x
	every	Object	year	x	x	x
	before	Date		x		x
	after	Date		x		x
Location
	center	Array	[lat, long]		x
	radius	Int			x
	notifyOnEntry	Boolean			x
	notifyOnExit	Boolean			x
	single	Boolean			x

Progress

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',
    progressBar: { value: 20 }
});

Patterns

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',
    smallIcon: 'res://calendar',
    icon: 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTzfXKe6Yfjr6rCtR6cMPJB8CqMAYWECDtDqH-eMnerHHuXv9egrw'
});

Summarizing

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',
    icon: 'http://climberindonesia.com/assets/icon/ionicons-2.0.1/png/512/android-chat.png',
    text: [
        { message: 'I miss you' },
        { person: 'Irish', message: 'I miss you more!' },
        { message: 'I always miss you more by 10%' }
    ]
});

To add a new message to the existing chat:

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

Grouping

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, summary: 'me@gmail.com', group: 'email', groupSummary: true },
    { id: 2, title: 'Please take all my money', ... group: 'email' },
    { id: 3, title: 'A question regarding this plugin', ... group: 'email' },
    { id: 4, title: 'Wellcome back home', ... group: '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();

Channels

Since Android 8+ push notifications require a channel to work. By passing the channel parameter you can specify which channel the notification should use. You can't edit the channel after creating it, so be sure to pass the correct parameters within the first notification.

When there is no channel specified in the notification, it (creates and) uses a default channel.

Example of a notification using a specific channel:

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

It's also possible to give the channel a custom description which will show up in the settings of the phone. You can declare the description by passing the paramter channelDescription to the notification.

First notification

As mentioned before, the first notification is the most important for your custom channels. Whenever you pass a new channel to a notification, the settings from that specific notification will be used to create the channel. All other notifications inside the same channel will inherit those settings.

Priorities

The priority of the channel will be set equivalent to the priority given to the notification. Below a summary of all priorities you can use and to which they'll change inside the channel.

Priority	Native constant	New channel constant	Description
-2	PRIORITY_MIN	IMPORTANCE_MIN	No sound and does not appear in the status bar
-1	PRIORITY_LOW	IMPORTANCE_LOW	No sound
0	PRIORITY_DEFAULT	IMPORTANCE_DEFAULT	Makes a sound
1	PRIORITY_HIGH	IMPORTANCE_HIGH	Makes a sound and appears as a heads-up notification
2	PRIORITY_MAX	IMPORTANCE_HIGH	Makes a sound and appears as a heads-up notification

So don't forget to use the correct priority based on your settings, you won't get the desired result if you pass the wrong priority.

The plugin will override your priority parameter if it detects a wrong configuration. For example when foreground is declared true, priority will always be 1 or higher. If foreground is declared false, priority will always be 0 or lower.

Methods

All methods work asynchronous and accept callback methods. See the sample app for how to use them.

Method	Method	Method	Method	Method	Method
schedule	cancelAll	isTriggered	get	removeActions	un
update	hasPermission	getType	getAll	hasActions	fireQueuedEvents
clear	requestPermission	getIds	getScheduled	getDefaults
clearAll	isPresent	getScheduledIds	getTriggered	setDefaults
cancel	isScheduled	getTriggeredIds	addActions	on

Installation

To install the latest version:

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

License

This software is released under the Apache 2.0 License.

Made with 😋 from Leipzig

© 2013 appPlant GmbH