Skip to content
Hal Hockersmith edited this page Jul 10, 2016 · 1 revision

Response Handler

A response is used to handle the returned information from the REST call to the API. The response is required to use if handling an Emergency Priority message as it contains the receipt necessary for further API calls. A Status handler simply contains the api call status and id.

status
int getStatus()
The call status to the API. A status of 1 indicates success. If any other value (often 0) the call to the API failed and the errors list should be checked.

With the user / group validation requests the status will be 1 if the user is valid and 0 if invalid.

request
String getRequest()
Serial number of the request for diagnostic purposes if needing to contact Pushover for support with the API.

errors List<String> getErrors()
A list of Strings detailing why an API call failed.

receipt
String getReceipt()
The API call receipt used to manage Emergency priority messages. Can be used to request a more detailed Receipt of the message or cancel the Emergency message. Only returned if message priority was EMERGENCY.

remaining
int getRemaining()
An integer count of how many messages can be sent for the month.

devices
List<String> getDevices()
Only returned on the group/user verification requests
A list of devices that the user has associated with his account

Clone this wiki locally