1+ ## Objects
2+ <dl >
3+ <dt ><a href =" #webNotification " >webNotification</a > ⇒ <code >object</code ></dt >
4+ <dd ><p >The web notification service wraps the HTML 5 Web Notifications API as an angular service.</p >
5+ </dd >
6+ </dl >
7+ ## Typedefs
8+ <dl >
9+ <dt ><a href =" #ShowNotificationCallback " >ShowNotificationCallback</a > : <code >function</code ></dt >
10+ <dd ><p >' ; showNotification' ; callback.</p >
11+ </dd >
12+ </dl >
113<a name =" webNotification " ></a >
214## webNotification ⇒ <code >object</code >
315The web notification service wraps the HTML 5 Web Notifications API as an angular service.
@@ -9,26 +21,27 @@ The web notification service wraps the HTML 5 Web Notifications API as an angula
921
1022* [ webNotification] ( #webNotification ) ⇒ <code >object</code >
1123 * [ .allowRequest] ( #webNotification.allowRequest )
12- * [ .showNotification([ title] , [ options] , callback)] ( #webNotification.showNotification )
24+ * [ .showNotification([ title] , [ options] , callback)] ( #webNotification.showNotification ) ⇒ < code > \* </ code >
1325
1426<a name =" webNotification.allowRequest " ></a >
1527### webNotification.allowRequest
1628True to enable automatic requesting of permissions if needed.
1729
1830** Access:** public
1931<a name =" webNotification.showNotification " ></a >
20- ### webNotification.showNotification([ title] , [ options] , callback)
32+ ### webNotification.showNotification([ title] , [ options] , callback) ⇒ < code > \* </ code >
2133Shows the notification based on the provided input.<br >
2234The callback invoked will get an error object (in case of an error, null in
2335case of no errors) and a 'hide' function which can be used to hide the notification.
2436
37+ ** Returns** : <code >\* </code > - The callback function return value or undefined
2538** Access:** public
2639
2740| Param | Type | Description |
2841| --- | --- | --- |
2942| [ title] | <code >string</code > | The notification title text (defaulted to empty string if null is provided) |
3043| [ options] | <code >object</code > | Holds the notification data (web notification API spec for more info) |
31- | callback | <code >function </code > | Called after the show is handled. |
44+ | callback | <code >[ ShowNotificationCallback ] ( #ShowNotificationCallback ) </code > | Called after the show is handled. |
3245
3346** Example**
3447``` js
@@ -45,3 +58,14 @@ webNotification.showNotification('Example Notification', {
4558 }
4659});
4760```
61+ <a name =" ShowNotificationCallback " ></a >
62+ ## ShowNotificationCallback : <code >function</code >
63+ 'showNotification' callback.
64+
65+ ** Kind** : global typedef
66+
67+ | Param | Type | Description |
68+ | --- | --- | --- |
69+ | [ error] | <code >error</code > | The error object in case of any error |
70+ | [ hide] | <code >function</code > | The hide notification function |
71+
0 commit comments