JPushover11/README.md
2018-10-06 07:49:05 +02:00

49 lines
1.5 KiB
Markdown

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.svenkubiak/jpushover/badge.svg)](https://maven-badges.herokuapp.com/maven-central/de.svenkubiak/jpushover)
JPushover
================
Minimalist convenient class for sending messages to [Pushover][1] in Java.
Starting with version 3.x JPushover is build for and requires Java 11.
Usage
------------------
1) Add the jpushover dependency to your pom.xml:
```
<dependency>
<groupId>de.svenkubiak</groupId>
<artifactId>jpushover</artifactId>
<version>x.x.x</version>
</dependency>
```
2) Use the JPushover object with the required informations were you want
```
JPushover.create()
.withToken("MyToken")
.withUser("MyUser")
.withMessage("MyMessage")
.push();
```
You can additionally add all available options from the official [Pushover documentation][2]
You can also validate a user and token using the following method
boolean valid = JPushover.create()
.withToken("MyToken")
.withUser("MyUser")
.validate();
If you want more information and/or the response from the Pushover API, use the JPushoverResponse object.
JPushoverResponse jPushoverResponse = JPushover.create()
.withToken("MyToken")
.withUser("MyUser")
.withMessage("MyMessage")
.push();
The JPushoverResponse will return the raw HTTP status code, along with the raw JSON response and a convenient boolean if the request was successful or not.
[1]: https://pushover.net
[2]: https://pushover.net/api