Cordova LocalNotification-Plugin

A bunch of local notification plugins for Cordova 3.x.x

Supported Platforms

iOS
See Local and Push Notification Programming Guide for detailed informations and screenshots.

Adding the Plugin to your project

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

Removing the Plugin from your project

Through the Command-line Interface:

cordova plugin rm de.appplant.cordova.plugin.local-notifications

Release Notes

Version 0.2.0 (11.08.2013)

Added iOS support
Based on the LocalNotifications iOS plugin made by Rodrigo Moyle

Using the plugin

The plugin creates the object window.plugin.notification.local with three methods:

add()

All settings are optional. If no date object is given, the notification will popup immediately.

To add a custom notification:

window.plugin.notification.local.add({
    date: date,// this expects a date object
    message: message, // the message that is displayed
    repeat: repeat, // has the options of 'weekly','daily','monthly','yearly')
    badge: badge, // displays number badge to notification
    foreground: forground, //  a javascript function to be called if the app is running
    background: background, // a javascript function to be called if the app is in the background
    sound: sound // a sound to be played, the sound must be located in your project's resources and must be a caf file
});

clear()

To clear a specific notification:

window.plugin.notification.local.clear(__id__);

clearAll()

To clear all notifications:

window.plugin.notification.local.clearAll();

Example

var now                  = new Date().getTime(),
    _60_seconds_from_now = new Date(now + 60*1000);

window.plugin.notification.local.add({
    date: _60_seconds_from_now,
    message: 'Hello world!',
    repeat: 'weekly', // will fire every week on this day
    badge: 1,
    foreground: 'foreground',
    background: 'background',
    sound: 'sub.caf'
});

function foreground (id) {
    console.log('I WAS RUNNING ID='+id)
}

function background (id) {
    console.log('I WAS IN THE BACKGROUND ID='+id)
}

README.md 2.7 KB تاريخچه خام