|
16 | 16 | * @description |
17 | 17 | * Initializes the angular web notification service. |
18 | 18 | * |
19 | | - * @param {object} NotifyLib - The HTML5 notification library instance |
| 19 | + * @param {Object} NotifyLib - The HTML5 notification library instance |
20 | 20 | */ |
21 | 21 | (function initWebNotification(NotifyLib) { |
22 | 22 | 'use strict'; |
|
28 | 28 | * @name webNotification |
29 | 29 | * @namespace webNotification |
30 | 30 | * @author Sagie Gur-Ari |
31 | | - * @returns {object} The service instance |
| 31 | + * @returns {Object} The service instance |
32 | 32 | * |
33 | 33 | * @description |
34 | 34 | * The web notification service wraps the HTML 5 Web Notifications API as an angular service. |
|
62 | 62 | * @function |
63 | 63 | * @memberof! webNotification |
64 | 64 | * @private |
65 | | - * @returns {boolean} True if permission is granted, else false |
| 65 | + * @returns {Boolean} True if permission is granted, else false |
66 | 66 | */ |
67 | 67 | get: function getPermission() { |
68 | 68 | var permission = NotifyLib.permission; |
|
110 | 110 | * @description |
111 | 111 | * Checks if web notifications are permitted. |
112 | 112 | * |
113 | | - * @returns {boolean} True if allowed to show web notifications |
| 113 | + * @returns {Boolean} True if allowed to show web notifications |
114 | 114 | */ |
115 | 115 | var isEnabled = function () { |
116 | 116 | return service.permissionGranted; |
|
126 | 126 | * @description |
127 | 127 | * Displays the web notification and returning a 'hide' notification function. |
128 | 128 | * |
129 | | - * @param {string} title - The notification title text (defaulted to empty string if null is provided) |
130 | | - * @param {object} options - Holds the notification data (web notification API spec for more info) |
131 | | - * @param {string} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico) |
132 | | - * @param {number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
| 129 | + * @param {String} title - The notification title text (defaulted to empty string if null is provided) |
| 130 | + * @param {Object} options - Holds the notification data (web notification API spec for more info) |
| 131 | + * @param {String} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico) |
| 132 | + * @param {Number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
133 | 133 | * @param {function} [options.onClick] - An optional onclick event handler |
134 | 134 | * @returns {function} The hide notification function |
135 | 135 | */ |
|
172 | 172 | * @description |
173 | 173 | * Returns an object with the show notification input. |
174 | 174 | * |
175 | | - * @param {array} argumentsArray - An array of all arguments provided to the show notification function |
176 | | - * @returns {object} The parsed data |
| 175 | + * @param {Array} argumentsArray - An array of all arguments provided to the show notification function |
| 176 | + * @returns {Object} The parsed data |
177 | 177 | */ |
178 | 178 | var parseInput = function (argumentsArray) { |
179 | 179 | //callback is always the last argument |
|
218 | 218 | * @memberof! webNotification |
219 | 219 | * @alias webNotification.showNotification |
220 | 220 | * @public |
221 | | - * @param {string} [title] - The notification title text (defaulted to empty string if null is provided) |
222 | | - * @param {object} [options] - Holds the notification data (web notification API spec for more info) |
223 | | - * @param {string} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico) |
224 | | - * @param {number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
| 221 | + * @param {String} [title] - The notification title text (defaulted to empty string if null is provided) |
| 222 | + * @param {Object} [options] - Holds the notification data (web notification API spec for more info) |
| 223 | + * @param {String} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico) |
| 224 | + * @param {Number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
225 | 225 | * @param {function} [options.onClick] - An optional onclick event handler |
226 | 226 | * @param {ShowNotificationCallback} [callback] - Called after the show is handled. |
227 | 227 | * @example |
|
0 commit comments