JPushover (JPushover 2.1.0 API)

java.lang.Object
- de.svenkubiak.jpushover.JPushover

```
public class JPushover
extends Object
```
Author:

svenkubiak

Constructor Summary

Constructors
Constructor and Description

JPushover()

Constructors
Constructor and Description
`JPushover()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JPushover`	`build()` Creates a new JPushover instance
`JPushover`	`enableHtml()` Enables HTML in the pushover message (optional)
`File`	`getAttachment()`
`String`	`getCallback()`
`String`	`getDevice()`
`String`	`getExpire()`
`String`	`getMessage()`
`Priority`	`getPriority()`
`String`	`getRetry()`
`Sound`	`getSound()`
`String`	`getTimestamp()`
`String`	`getTitle()`
`String`	`getToken()`
`String`	`getUrl()`
`String`	`getUrlTitle()`
`String`	`getUser()`
`boolean`	`isHtml()`
`JPushoverResponse`	`push()` Sends a message to pushover
`boolean`	`validate()` Sends a validation request to pushover ensuring that the token and user is correct, that there is at least one active device on the account.
`JPushover`	`withAttachment(File attachment)` Add a file attachment to be added to the request
`JPushover`	`withCallback(String callback)` Callback parameter may be supplied with a publicly-accessible URL that the pushover servers will send a request to when the user has acknowledged your notification.
`JPushover`	`withDevice(String device)` Your user's device name to send the message directly to that device, rather than all of the user's devices (optional)
`JPushover`	`withExpire(String expire)` Specifies how many seconds your notification will continue to be retried for (every retry seconds).
`JPushover`	`withMessage(String message)` Your message (required)
`JPushover`	`withPriority(Priority priority)` Priority of the message based on the @see documentation (optional)
`JPushover`	`withRetry(String retry)` Specifies how often (in seconds) the Pushover servers will send the same notification to the user.
`JPushover`	`withSound(Sound sound)` The name of one of the sounds supported by device clients to override the user's default sound choice (optional)
`JPushover`	`withTimestamp(String timestamp)` A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by our API
`JPushover`	`withTitle(String title)` Your message's title, otherwise your app's name is used (optional)
`JPushover`	`withToken(String token)` Your application's API token (required)
`JPushover`	`withUrl(String url)` A supplementary URL to show with your message (optional)
`JPushover`	`withUrlTitle(String urlTitle)` A title for your supplementary URL, otherwise just the URL is shown
`JPushover`	`withUser(String user)` The user/group key (not e-mail address) of your user (or you), viewable when logged into the @see pushover dashboard (required)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JPushover
```
public JPushover()
```
- Method Detail
  - build
```
public static JPushover build()
```
    Creates a new JPushover instance
    
    Returns:
    
    JPushover instance
  - withToken
```
public final JPushover withToken(String token)
```
    Your application's API token (required)
    
    Parameters:
    
    token - The pushover API token
    
    Returns:
    
    JPushover instance
  - withUser
```
public final JPushover withUser(String user)
```
    The user/group key (not e-mail address) of your user (or you), viewable when logged into the @see pushover dashboard (required)
    
    Parameters:
    
    user - The username
    
    Returns:
    
    JPushover instance
  - withRetry
```
public final JPushover withRetry(String retry)
```
    Specifies how often (in seconds) the Pushover servers will send the same notification to the user. Only required if priority is set to emergency.
    
    Parameters:
    
    retry - Number of seconds
    
    Returns:
    
    JPushover instance
  - withAttachment
```
public final JPushover withAttachment(File attachment)
```
    Add a file attachment to be added to the request
    
    Parameters:
    
    attachment - The attachment to add
    
    Returns:
    
    JPushover instance
  - withExpire
```
public final JPushover withExpire(String expire)
```
    Specifies how many seconds your notification will continue to be retried for (every retry seconds). Only required if priority is set to emergency.
    
    Parameters:
    
    expire - Number of seconds
    
    Returns:
    
    JPushover instance
  - withMessage
```
public final JPushover withMessage(String message)
```
    Your message (required)
    
    Parameters:
    
    message - The message to sent
    
    Returns:
    
    JPushover instance
  - withDevice
```
public final JPushover withDevice(String device)
```
    Your user's device name to send the message directly to that device, rather than all of the user's devices (optional)
    
    Parameters:
    
    device - The device name
    
    Returns:
    
    JPushover instance
  - withTitle
```
public final JPushover withTitle(String title)
```
    Your message's title, otherwise your app's name is used (optional)
    
    Parameters:
    
    title - The title
    
    Returns:
    
    JPushover instance
  - withUrl
```
public final JPushover withUrl(String url)
```
    A supplementary URL to show with your message (optional)
    
    Parameters:
    
    url - The url
    
    Returns:
    
    JPushover instance
  - enableHtml
```
public final JPushover enableHtml()
```
    Enables HTML in the pushover message (optional)
    
    Returns:
    
    JPushover instance
  - withUrlTitle
```
public final JPushover withUrlTitle(String urlTitle)
```
    A title for your supplementary URL, otherwise just the URL is shown
    
    Parameters:
    
    urlTitle - The url title
    
    Returns:
    
    JPushover instance
  - withTimestamp
```
public final JPushover withTimestamp(String timestamp)
```
    A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by our API
    
    Parameters:
    
    timestamp - The Unix timestamp
    
    Returns:
    
    JPushover instance
  - withPriority
```
public final JPushover withPriority(Priority priority)
```
    Priority of the message based on the @see documentation (optional)
    
    Parameters:
    
    priority - The priority enum
    
    Returns:
    
    JPushover instance
  - withSound
```
public final JPushover withSound(Sound sound)
```
    The name of one of the sounds supported by device clients to override the user's default sound choice (optional)
    
    Parameters:
    
    sound - THe sound enum
    
    Returns:
    
    JPushover instance
  - withCallback
```
public final JPushover withCallback(String callback)
```
    Callback parameter may be supplied with a publicly-accessible URL that the pushover servers will send a request to when the user has acknowledged your notification. Only required if priority is set to emergency.
    
    Parameters:
    
    callback - The callback URL
    
    Returns:
    
    JPushover instance
  - validate
```
public boolean validate()
```
    Sends a validation request to pushover ensuring that the token and user is correct, that there is at least one active device on the account. Requires token parameter Requires user parameter Optional device parameter to check specific device
    
    Returns:
    
    true if token and user are valid and at least on device is on the account, false otherwise
  - push
```
public final JPushoverResponse push()
```
    Sends a message to pushover
    
    Returns:
    
    JPushoverResponse instance
  - getToken
```
public String getToken()
```
  - getUser
```
public String getUser()
```
  - getMessage
```
public String getMessage()
```
  - getDevice
```
public String getDevice()
```
  - getTitle
```
public String getTitle()
```
  - getUrl
```
public String getUrl()
```
  - getUrlTitle
```
public String getUrlTitle()
```
  - getTimestamp
```
public String getTimestamp()
```
  - getRetry
```
public String getRetry()
```
  - getAttachment
```
public File getAttachment()
```
  - getExpire
```
public String getExpire()
```
  - getCallback
```
public String getCallback()
```
  - getPriority
```
public Priority getPriority()
```
  - getSound
```
public Sound getSound()
```
  - isHtml
```
public boolean isHtml()
```

Class JPushover

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JPushover

Method Detail

build

withToken

withUser

withRetry

withAttachment

withExpire

withMessage

withDevice

withTitle

withUrl

enableHtml

withUrlTitle

withTimestamp

withPriority

withSound

withCallback

validate

push

getToken

getUser

getMessage

getDevice

getTitle

getUrl

getUrlTitle

getTimestamp

getRetry

getAttachment

getExpire

getCallback

getPriority

getSound

isHtml