Parcourir la source

Updated Readme

Sebastián Katzer il y a 12 ans
Parent
commit
51db82033d
2 fichiers modifiés avec 23 ajouts et 8 suppressions
  1. 20 8
      README.md
  2. 3 0
      www/local-notification.js

+ 20 - 8
README.md

@@ -12,6 +12,10 @@ See [Local and Push Notification Programming Guide](http://developer.apple.com/l
 - **Android**<br>
 See [Notification Guide](http://developer.android.com/guide/topics/ui/notifiers/notifications.html) for detailed informations and screenshots.
 
+- **WP8**<br>
+See [Tiles, Lock and Notifications for Windows Phone 8](http://code.msdn.microsoft.com/Tiles-Lock-and-Notification-e63f498b) 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):
 ```
@@ -25,6 +29,12 @@ cordova plugin rm de.appplant.cordova.plugin.local-notifications
 ```
 
 ## Release Notes
+#### Version 0.6.0 (not yet released)
+- Added WP8 support<br>
+  *Based on the LiveTiles WP8 plugin made by* ***XXX***
+- [enhancement:] The `add()` function now returns the id of the created notification.
+- [feature:] Added new `title` property.
+
 #### Version 0.4.0 (06.10.2013)
 - Added Android support<br>
   *Based on the LocalNotifications Android plugin made by* ***Daniël (dvtoever)***
@@ -33,15 +43,20 @@ cordova plugin rm de.appplant.cordova.plugin.local-notifications
 - 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 the following methods:
 
 ### add()
-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.
+The method allows to add a custom notification. It takes an hash as an argument to specify the notification's properties and returns the ID for the notification.<br>
+All properties are optional. If no date object is given, the notification will popup immediately.
+
 ```javascript
 window.plugin.notification.local.add({
+    id: id, // a unique id of the notifiction
     date: date, // this expects a date object
     message: message, // the message that is displayed
+    title: title, // the title of the message
     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
@@ -67,9 +82,11 @@ window.plugin.notification.local.cancelAll();
 var now                  = new Date().getTime(),
     _60_seconds_from_now = new Date(now + 60*1000);
 
-window.plugin.notification.local.add({
+var notificationId = window.plugin.notification.local.add({
+    id:         1,
     date:       _60_seconds_from_now,
     message:    'Hello world!',
+    title:      'Check that out!',
     repeat:     'weekly', // will fire every week on this day
     foreground: 'foreground',
     background: 'background'
@@ -82,9 +99,4 @@ function foreground (id) {
 function background (id) {
     console.log('I WAS IN THE BACKGROUND ID='+id)
 }
-```
-
-**Android:** The `message` property can be devided into *title* and *subtitle* section:
-```javascript
-message: "Title\r\nSubtitle comes after linebreak"
-```
+```

+ 3 - 0
www/local-notification.js

@@ -16,6 +16,7 @@ LocalNotification.prototype = {
      * Fügt einen neuen Eintrag zur Registry hinzu.
      *
      * @param {Object} options
+     * @return {Number} Die ID der Notification
      */
     add: function (options) {
         var defaults = {
@@ -40,6 +41,8 @@ LocalNotification.prototype = {
         }
 
         cordova.exec(null, null, 'LocalNotification','add', [defaults]);
+
+        return defaults.id;
     },
 
     /**