@@ -106,10 +106,10 @@ alert.notify({
106
106
});
107
107
```
108
108
109
- #### ** Custom Notifications**
109
+ #### Custom Notifications
110
110
You can use these two signature to send the custom notification with pre-defined notification types.
111
111
112
- ##### ** Passing the whole notification object**
112
+ #### Passing the whole notification object
113
113
By using this approach you need to pass the whole notification object as described in the API documentation
114
114
``` js
115
115
alert .notify ({
@@ -136,11 +136,11 @@ alert.notify({
136
136
});
137
137
```
138
138
139
- ##### ** Passing the notification object in parts**
139
+ #### Passing the notification object in parts
140
140
By using this approach you can post a notification by providing different parts of the notification object grouped in related units
141
141
``` js
142
142
alert .notify ({
143
- recipients: recipients ,
143
+
144
144
type: " IncidentCreated"
145
145
priority: ' NEUTRAL' ,
146
146
properties: [
@@ -184,12 +184,12 @@ alert.notify({
184
184
```
185
185
186
186
Possible parameters:
187
- * ** recipients** - List of the recipients
188
- * ** type** - Notification type key
189
- * ** priority** - Priority of the notification
190
- * ** properties** - A key-value pair that is used to fill a placeholder of the notification type template
191
- * ** navigation** - All navigation related parameters
192
- * ** payload** - The rest parameters that can be passed
187
+ * ** recipients** - List of the recipients, this argument is mandatory
188
+ * ** type** - Notification type key, this argument is mandatory
189
+ * ** priority** - Priority of the notification, this argument is optional, it defaults to NEUTRAL
190
+ * ** properties** - A key-value pair that is used to fill a placeholder of the notification type template, this argument is optional
191
+ * ** navigation** - All navigation related parameters, this argument is optional
192
+ * ** payload** - The rest parameters that can be passed, this argument is optional
193
193
194
194
### Sample Application with notifications
195
195
0 commit comments