Once you have created the broker thing with a valid API key, you can use the Prowl service in your rules.
First you need to create an instance of the broker just before any call or on the top rules level. (replace the _mybroker_ with the right name of your instance).
-Then you can call method _pushNotification_, which requires two parameters - _event_ and _description_.
+Then you can call method _pushNotification_, which requires two parameters - _event_ and _description_.
+There is also an optional third parameter _priority_ which represents the message priority (very low) -2,-1,0,1,2 (emergency). The default priority is 0.
```
val prowl = getActions("prowl","prowl:broker:mybroker")
prowl.pushNotification("Event", "This is the description of the event")
+prowl.pushNotification("Emergency Event", "This is the description of the event", 2)
```
private final Logger logger = LoggerFactory.getLogger(ProwlHandler.class);
private ProwlConfiguration config = new ProwlConfiguration();
- final private HttpClient httpClient;
+ private final HttpClient httpClient;
/**
* Future to poll for status
}
public void pushNotification(@Nullable String event, @Nullable String description) {
+ pushNotification(event, description, 0);
+ }
+
+ public void pushNotification(@Nullable String event, @Nullable String description, int priority) {
if (event == null || description == null) {
logger.debug("Cannot push message with null event or null description");
return;
}
+ if (priority < -2) {
+ priority = -2;
+ } else if (priority > 2) {
+ priority = 2;
+ }
+
logger.debug("Pushing an event: {} with desc: {}", event, description);
try {
ContentResponse response = httpClient.POST(PROWL_ADD_URI).timeout(5, TimeUnit.SECONDS)
.content(
new StringContentProvider("apikey=" + config.apiKey + "&application=" + config.application
- + "&event=" + event + "&description=" + description),
+ + "&event=" + event + "&description=" + description + "&priority=" + priority),
"application/x-www-form-urlencoded; charset=UTF-8")
.send();
String resp = response.getContentAsString();
handler.pushNotification(event, message);
}
+ @RuleAction(label = "@text/pushNotificationActionLabel", description = "@text/pushNotificationActionDescription")
+ public void pushNotification(
+ @ActionInput(name = "event", label = "@text/pushNotificationActionEventLabel", description = "@text/pushNotificationActionEventDescription") @Nullable String event,
+ @ActionInput(name = "message", label = "@text/pushNotificationActionMessageLabel", description = "@text/pushNotificationActionMessageDescription") @Nullable String message,
+ @ActionInput(name = "priority", label = "@text/pushNotificationActionPriorityLabel", description = "@text/pushNotificationActionPriorityDescription") int priority) {
+ ProwlHandler clientHandler = handler;
+ if (clientHandler == null) {
+ logger.warn("Prowl ThingHandler is null");
+ return;
+ }
+
+ handler.pushNotification(event, message, priority);
+ }
+
public static void pushNotification(@Nullable ThingActions actions, @Nullable String event,
@Nullable String description) {
+ pushNotification(actions, event, description, 0);
+ }
+
+ public static void pushNotification(@Nullable ThingActions actions, @Nullable String event,
+ @Nullable String description, int priority) {
if (actions instanceof ProwlActions) {
- ((ProwlActions) actions).pushNotification(event, description);
+ ((ProwlActions) actions).pushNotification(event, description, priority);
} else {
throw new IllegalArgumentException("Instance is not a ProwlActions class.");
}
pushNotificationActionEventDescription = Event name.
pushNotificationActionMessageLabel = Message
pushNotificationActionMessageDescription = Message text.
+pushNotificationActionPriorityLabel = Priority
+pushNotificationActionPriorityDescription = Message priority (-2,-1,0,1,2).
pushNotificationActionEventDescription = Nom de l'événement.
pushNotificationActionMessageLabel = Message
pushNotificationActionMessageDescription = Texte du message.
+pushNotificationActionPriorityLabel = Priorité
+pushNotificationActionPriorityDescription = Priorité du message (-2,-1,0,1,2).
pushNotificationActionEventDescription = Nome evento.
pushNotificationActionMessageLabel = Messaggio
pushNotificationActionMessageDescription = Testo del messaggio.
+pushNotificationActionPriorityLabel = Priorità
+pushNotificationActionPriorityDescription = Priorità del messaggio (-2,-1,0,1,2).
projects / openhab-addons.git / commitdiff