@@ -9,6 +9,9 @@ by Sebastián Katzer ([github.com/katzer](https://github.com/katzer))
-**iOS**<br>
See [Local and Push Notification Programming Guide](http://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/WhatAreRemoteNotif.html) for detailed informations and screenshots.
-**Android**<br>
See [Notification Guide](http://developer.android.com/guide/topics/ui/notifiers/notifications.html) for detailed informations and screenshots.
## Adding the Plugin to your project
Through the [Command-line Interface](http://cordova.apache.org/docs/en/3.0.0/guide_cli_index.md.html#The%20Command-line%20Interface):
*Based on the LocalNotifications Android plugin made by****Daniël (dvtoever)***
#### Version 0.2.0 (11.08.2013)
- Added iOS support<br>
*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:
The plugin creates the object ```window.plugin.notification.local``` with the following methods:
### add()
All settings are optional. If no date object is given, the notification will popup immediately.
To add a custom notification:
The method allows to add a custom notification. It takes an hash as an argument to specify the notification's properties. All properties are optional. If no date object is given, the notification will popup immediately.
```javascript
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,// (only iOS) displays number badge to notification
repeat:repeat,// has the options of daily', 'weekly',''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// (only iOS) a sound to be played, the sound must be located in your project's resources and must be a caf file