yehor/ha-client.app
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update mobile_app_integration.md

Browse Source
This commit is contained in:
Yegor Vialov
2020-06-24 17:15:01 +03:00
committed by GitHub
parent 64b612316a
commit 5019c277db
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
help/mobile_app_integration.md
View File

@@ -57,7 +57,7 @@ data:
| Option | Value | Description | | Option | Value | Description |
| ------------- | ------------- | ----- | | ------------- | ------------- | ----- |
| title | *String* | Notification title. Default is `HA Client` | | title | *String* | Notification title. Default is `HA Client` |
| message | *String* | Notification body | | message | *String* | Notification body. This field is required by Home Assistant. You need to add it event if you want to dismiss any notification. |
| data | *Object* | Notification settings | | data | *Object* | Notification settings |
#### options for **data** #### options for **data**
@@ -66,7 +66,7 @@ data:
| ------------- | ------------- | ----- | | ------------- | ------------- | ----- |
| tag | *String* | Notification tag. Not mandatory. Use it to replace existing notification with the same tag | | tag | *String* | Notification tag. Not mandatory. Use it to replace existing notification with the same tag |
| image | *String* | Image url to be shown in notification | | image | *String* | Image url to be shown in notification |
| dismiss | `true` or `false` | Use it to dismiss excisting notification with specific `tag`. Default is `false` | | dismiss | `true` or `false` | Use it to dismiss excisting notification with specific `tag`. Default is `false`. Note that `message` field is always required so you need to use it even in case of dismissing any notification. Just use any random value for `message` |
| autoDismiss | `true` or `false` | If `false` notification will not be dismissed after click/tap on its body or action. Default is `true` | | autoDismiss | `true` or `false` | If `false` notification will not be dismissed after click/tap on its body or action. Default is `true` |
| channelId | *String* | Custom notification channel to create and use. Default is `ha_notify` | | channelId | *String* | Custom notification channel to create and use. Default is `ha_notify` |
| actions | *List* | Up to 3 actions to add to the notification | | actions | *List* | Up to 3 actions to add to the notification |