Changes in this fork

This fork adds support for interactive notifications on iOS. It allows to add actions which are then part of the notification a user can interact with.

To add an action, define an array of action objects:

document.addEventListener('deviceready', function () {
    // Schedule notification for tomorrow to remember about the meeting
    cordova.plugins.notification.local.schedule({
        id: 10,
        title: "Meeting in 15 minutes!",
        text: "Jour fixe Produktionsbesprechung",
        at: tomorrow_at_8_45_am,
        data: { meetingId:"#123FG8" },
        actions: [
            {
                id: 'snooze',
                title: 'Snooze',
                destructive: false,
                authenticationRequired: false
            },
            {
                id: 'delete',
                title: 'Delete',
                destructive: true,
                authenticationRequired: true
            }
        ]
    });


    cordova.plugins.notification.local.on("action", function (notification) {
        if (notification.id == 10) {
            if (notification.actionId == 'snooze') {
                snoozeMeetingReminder(notification.data.meetingId);
            } else if (notification.actionId == 'delete') {
                deleteMeeting(notification.data.meetingId);
            }
        }
    });
  });

The notification parameter contains all properties from a notification plus the actionId (in the example above snooze or delete).

---

‼️ Please vote for these cordova-windows issues ‼️

1. https://issues.apache.org/jira/browse/CB-8674 (Missing launch arguments)
2. https://issues.apache.org/jira/browse/CB-8946 (Missing ToastCapable flag)

Thanks a lot!

Cordova Local-Notification Plugin

The essential purpose of local notifications is to enable an application to inform its users that it has something for them — for example, a message or an upcoming appointment — when the application isn’t running in the foreground.
They are scheduled by an application and delivered on the same device.

How they appear to the user

Users see notifications in the following ways:

• Displaying an alert or banner
• Badging the app’s icon
• Playing a sound

Examples of Notification Usage

Local notifications are ideally suited for applications with time-based behaviors, such as calendar and to-do list applications. Applications that run in the background for the limited period allowed by iOS might also find local notifications useful.
For example, applications that depend on servers for messages or data can poll their servers for incoming items while running in the background; if a message is ready to view or an update is ready to download, they can then present a local notification immediately to inform their users.

Supported Platforms

The current 0.8 branch supports the following platforms:

• iOS (including iOS8)
  
• Android (SDK >=7)
• Windows 8.1 (added with v0.8.2)
• Windows Phone 8.1 (added with v0.8.2)

Find out more informations here in our wiki.

Installation

The plugin is installable from source and available on Cordova Plugin Registry and PhoneGap Build.

Find out more informations here in our wiki.

I want to get a quick overview

All wiki pages contain samples, but for a quick overview the sample section may be the fastest way.

Find out more informations here in our wiki.

I want to get a deep overview

The plugin supports scheduling local notifications in various ways with a single interface. It also allows you to update, clear or cancel them. There are different interfaces to query for local notifications and a complete set of events to hook into the life cycle of local notifications.

Find out more about how to schedule single, multiple, delayed or repeating local notifications here.
Informations about events like click or trigger can be found here.

To get a deep overview we recommend to read about all the topics in our wiki and try out the Kitchen Sink App

I want to see the plugin in action

The plugin offers a kitchen sink sample app. Check out the cordova project and run the app directly from your command line or preferred IDE.

Find out more informations here in our wiki.

What's new

We are proud to announce our newest release version 0.8.x. Beside the hard work at the office and at the weekends it contains a lot of goodies, new features and easy to use APIs.

Find out more informations here in our wiki.

Sample

The sample demonstrates how to schedule a local notification which repeats every week. The listener will be called when the user has clicked on the local notification.

cordova.plugins.notification.local.schedule({
    id: 1,
    title: "Production Jour fixe",
    text: "Duration 1h",
    firstAt: monday_9_am,
    every: "week",
    sound: "file://sounds/reminder.mp3",
    icon: "http://icons.com/?cal_id=1",
    data: { meetingId:"123#fg8" }
});

cordova.plugins.notification.local.on("click", function (notification) {
    joinMeeting(notification.data.meetingId);
});

Find out more informations here in our wiki.

I would like to propose new features

We appricate any feature proposal and support for their development. Please describe them here.

Find out more informations here in our wiki.

Supporting

Your support is needed. If you use the plugin please send us a drop through the donation button.

Thank you!

Contributing

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

License

This software is released under the Apache 2.0 License.

© 2013-2015 appPlant UG, Inc. All rights reserved