demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improved format of README.md (#9184)

Browse Source 
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
This commit is contained in:
Christoph Weitkamp 2020-11-30 17:04:21 +01:00 committed by GitHub
parent 90ea8d8106
commit 7fe7b60f83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
bundles/org.openhab.binding.pushover/README.md
View File

@ -30,23 +30,28 @@ Currently the binding does not support any Channels.
## Thing Actions
All actions return a `Boolean` value to indicate if the message - parameter `message` **mandatory** - was sent successfully or not.
The `title` parameter defaults to whatever value you defined in the `title` related configuration parameter.
All actions return a `Boolean` value to indicate if the message was sent successfully or not.
The parameter `message` is **mandatory**, the `title` parameter defaults to whatever value you defined in the `title` related configuration parameter.
`sendMessage(String message, @Nullable String title)` - This method is used to send a plain text message.
`sendHtmlMessage(String message, @Nullable String title)` - This method is used to send a HTML message.
`sendMonospaceMessage(String message, @Nullable String title)` - This method is used to send a monospace message.
`sendAttachmentMessage(String message, @Nullable String title, String attachment, @Nullable String contentType)` - This method is used to send a message with an attachment. It takes a (local) path (`attachment` **mandatory**) to the attachment and an optional parameter `contentType` to define the content-type of the attachment (default: `image/jpeg`).
`sendURLMessage(String message, @Nullable String title, String url, @Nullable String urlTitle)` - This method is used to send a message with an URL. A supplementary `url` to show with the message and a `urlTitle` for the URL, otherwise just the URL is shown.
`sendMessageToDevice(String device, String message, @Nullable String title)` - This method is used to send a message to a specific device. Parameter `device` **mandatory** is the name of a specific device (multiple devices may be separated by a comma).
- `sendMessage(String message, @Nullable String title)` - This method is used to send a plain text message.
- `sendHtmlMessage(String message, @Nullable String title)` - This method is used to send a HTML message.
- `sendMonospaceMessage(String message, @Nullable String title)` - This method is used to send a monospace message.
- `sendAttachmentMessage(String message, @Nullable String title, String attachment, @Nullable String contentType)` - This method is used to send a message with an attachment. It takes a (local) path to the attachment (parameter `attachment` **mandatory**) and an optional `contentType` to define the content-type of the attachment (default: `image/jpeg`).
- `sendURLMessage(String message, @Nullable String title, String url, @Nullable String urlTitle)` - This method is used to send a message with an URL. A supplementary `url` to show with the message and a `urlTitle` for the URL, otherwise just the URL is shown.
- `sendMessageToDevice(String device, String message, @Nullable String title)` - This method is used to send a message to a specific device. Parameter `device` **mandatory** is the name of a specific device (multiple devices may be separated by a comma).
The `sendPriorityMessage` action returns a `String` value (the `receipt`) if the message was sent successfully, otherwise `null`.
`sendPriorityMessage(String message, @Nullable String title, @Nullable Integer priority)` - This method is used to send a priority message. Parameter `priority` is the priority (`-2`, `-1`, `0`, `1`, `2`) to be used (default: `2`).
- `sendPriorityMessage(String message, @Nullable String title, @Nullable Integer priority)` - This method is used to send a priority message. Parameter `priority` is the priority (`-2`, `-1`, `0`, `1`, `2`) to be used (default: `2`).
`cancelPriorityMessage` returns a `Boolean` value to indicate if the message was cancelled successfully or not.
The `cancelPriorityMessage` returns a `Boolean` value to indicate if the message was cancelled successfully or not.
`cancelPriorityMessage(String receipt)` - This method is used to cancel a priority message.
- `cancelPriorityMessage(String receipt)` - This method is used to cancel a priority message.
## Full Example
@ -67,7 +72,7 @@ actions.sendHtmlMessage("Hello <font color='green'>World</font>!", "openHAB")
```java
val actions = getActions("pushover", "pushover:pushover-account:account")
// send priority message
var receipt = actions.sendPriorityMessage("Hello <font color='green'>World</font>!", "openHAB", 3)
var receipt = actions.sendPriorityMessage("Emergency!!!", "openHAB", 2)
// wait for your cancel condition