docs

Author: sagiegurari

README.md

@@ -109,6 +109,7 @@ See [contributing guide](.github/CONTRIBUTING.md)
 
 | Date        | Version | Description |
 | ----------- | ------- | ----------- |
+| 2017-01-22  | v1.2.1  | Maintenance |
 | 2017-01-22  | v1.2.0  | Split the internal web notification API into a new project: simple-web-notification |
 | 2017-01-13  | v1.0.26 | Maintenance |
 | 2016-11-23  | v1.0.19 | Use forked version of html5-desktop-notifications in order to resolve few issues |

angular-web-notification.js

@@ -23,41 +23,48 @@
      * @returns {Object} The service instance
      *
      * @description
-     * The web notification service wraps the HTML 5 Web Notifications API as an angular service.<br>
-     * See [simple-web-notification](https://github.com/sagiegurari/simple-web-notification/blob/master/docs/api.md) for detailed API.
-     *
-     * @example
-     * ```js
-     * angular.module('exampleApp').directive('showButton', ['webNotification', function (webNotification) {
-     *   return {
-     *     link: function (scope, element) {
-     *     element.on('click', function onClick() {
-     *       webNotification.showNotification('Example Notification', {
-     *         body: 'Notification Text...',
-     *         icon: 'my-icon.ico',
-     *         onClick: function onNotificationClicked() {
-     *           console.log('Notification clicked.');
-     *         },
-     *         autoClose: 4000 //auto close the notification after 4 seconds (you can manually close it via hide function)
-     *         }, function onShow(error, hide) {
-     *           if (error) {
-     *             window.alert('Unable to show notification: ' + error.message);
-     *           } else {
-     *             console.log('Notification Shown.');
-     *
-     *             setTimeout(function hideNotification() {
-     *               console.log('Hiding notification....');
-     *               hide(); //manually close the notification (you can skip this if you use the autoClose option)
-     *             }, 5000);
-     *           }
-     *         });
-     *       });
-     *     }
-     *   };
-     * }]);
-     * ```
+     * The web notification service wraps the HTML 5 Web Notifications API as an angular service.
      */
     webNotification.factory('webNotification', function onCreateService() {
+        /**
+         * Shows the notification based on the provided input.<br>
+         * The callback invoked will get an error object (in case of an error, null in
+         * case of no errors) and a 'hide' function which can be used to hide the notification.
+         *
+         * @function
+         * @memberof! webNotification
+         * @alias webNotification.showNotification
+         * @public
+         * @param {String} [title] - The notification title text (defaulted to empty string if null is provided)
+         * @param {Object} [options] - Holds the notification data (web notification API spec for more info)
+         * @param {String} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico)
+         * @param {Number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close)
+         * @param {function} [options.onClick] - An optional onclick event handler
+         * @param {ShowNotificationCallback} [callback] - Called after the show is handled.
+         * @example
+         * ```js
+         * webNotification.showNotification('Example Notification', {
+         *   body: 'Notification Text...',
+         *   icon: 'my-icon.ico',
+         *   onClick: function onNotificationClicked() {
+         *     console.log('Notification clicked.');
+         *   },
+         *   autoClose: 4000 //auto close the notification after 4 seconds (you can manually close it via hide function)
+         * }, function onShow(error, hide) {
+         *   if (error) {
+         *     window.alert('Unable to show notification: ' + error.message);
+         *   } else {
+         *     console.log('Notification Shown.');
+         *
+         *     setTimeout(function hideNotification() {
+         *       console.log('Hiding notification....');
+         *       hide(); //manually close the notification (you can skip this if you use the autoClose option)
+         *     }, 5000);
+         *   }
+         * });
+         * ```
+         */
+
         return webNotificationAPI;
     });
 }(window.webNotification));

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "AngularJS service for displaying web notifications.",
   "authors": [
     "Sagie Gur-Ari <sagiegurari@gmail.com>"

docs/CHANGELOG.md

@@ -1,5 +1,6 @@
 | Date        | Version | Description |
 | ----------- | ------- | ----------- |
+| 2017-01-22  | v1.2.1  | Maintenance |
 | 2017-01-22  | v1.2.0  | Split the internal web notification API into a new project: simple-web-notification |
 | 2017-01-13  | v1.0.26 | Maintenance |
 | 2016-11-23  | v1.0.19 | Use forked version of html5-desktop-notifications in order to resolve few issues |

docs/api.md

@@ -1,40 +1,9 @@
 <a name="webNotification"></a>
 
 ## webNotification ⇒ <code>Object</code>
-The web notification service wraps the HTML 5 Web Notifications API as an angular service.<br>
-See [simple-web-notification](https://github.com/sagiegurari/simple-web-notification/blob/master/docs/api.md) for detailed API.
+The web notification service wraps the HTML 5 Web Notifications API as an angular service.
 
 **Kind**: global namespace  
 **Returns**: <code>Object</code> - The service instance  
 **Ngdoc**: service  
 **Author:** Sagie Gur-Ari  
-**Example**  
-```js
-angular.module('exampleApp').directive('showButton', ['webNotification', function (webNotification) {
-  return {
-    link: function (scope, element) {
-    element.on('click', function onClick() {
-      webNotification.showNotification('Example Notification', {
-        body: 'Notification Text...',
-        icon: 'my-icon.ico',
-        onClick: function onNotificationClicked() {
-          console.log('Notification clicked.');
-        },
-        autoClose: 4000 //auto close the notification after 4 seconds (you can manually close it via hide function)
-        }, function onShow(error, hide) {
-          if (error) {
-            window.alert('Unable to show notification: ' + error.message);
-          } else {
-            console.log('Notification Shown.');
-
-            setTimeout(function hideNotification() {
-              console.log('Hiding notification....');
-              hide(); //manually close the notification (you can skip this if you use the autoClose option)
-            }, 5000);
-          }
-        });
-      });
-    }
-  };
-}]);
-```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "AngularJS service for displaying web notifications.",
   "author": {
     "name": "Sagie Gur-Ari",