damage/JPushover11
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added support for Glances API and completly reworked API

Browse Source
This commit is contained in:
Sven Kubiak
2018-11-22 14:45:16 +01:00
parent e70aa6ccb6
commit 69632b331f
17 changed files with 1023 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -3,47 +3,58 @@
JPushover
================
Zero-dependency convenient class for sending messages to [Pushover][1] in Java.
A zero-dependency convenient class for sending messages to [Pushover][1] in Java.
Starting with version 3.x JPushover is build for and requires Java 11.
Requires Java 11.
Support [Messages API][3] and [Glances API][4].
Usage
------------------
1) Add the jpushover dependency to your pom.xml:
```
<dependency>
<groupId>de.svenkubiak</groupId>
<artifactId>jpushover</artifactId>
<version>x.x.x</version>
</dependency>
```
<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]
JPushover.newMessage()
.withToken("MyToken")
.withUser("MyUser")
.withMessage("MyMessage")
.push();
JPushover.newGlance()
.withToken("MyToken")
.withUser("MyUser")
.withText("MyText")
.push();
When using the Message API you can additionally add available options from the official [Pushover documentation][2]
You can also validate a user and token using the following method
boolean valid = JPushover.create()
boolean valid = JPushover.newMessage()
.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()
JPushoverResponse jPushoverResponse = JPushover.newMessage()
.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.
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
[2]: https://pushover.net/api
[3]: https://pushover.net/api
[4]: https://pushover.net/api/glances