com.raspoid.network.pushbullet

Class Pushbullet

java.lang.Object

com.raspoid.network.pushbullet.Pushbullet

public class Pushbullet
extends java.lang.Object

This class is an abstraction to easily use some of the Pushbullet services.

We implemented here the main Pushbullet features that can be useful for your project. The utilization is really simple. You can for example easily send some requests to your robots from any of your Pushbullet devices, receive a response from your robot, or even setup a notification system to be notified when some specific event occurs.

All you need to use this Pushbullet wrapper is a Pushbullet account, and an access token for this account.
This access token can easily be retrieved from your Pushbullet settings.

Constructor Summary

Constructors

Constructor and Description
Pushbullet(java.lang.String accessToken, java.lang.String deviceName, Router router) Constructor for a new Pushbullet instance with a specific access token, a device name corresponding to the name that your robot will take in your Pushbullet list of devices, and the Raspoid router to use with this Pushbullet instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<Device>	getListOfDevices() Retrieve the list of Pushbullet devices linked to the specified access token account.
java.util.List<Push>	getListOfPushes(double modifiedAfter, int limit) Retrieve the list of pushes received after a specific timestamp, with a specific limit in the number of retrieved pushes.
java.util.List<Push>	getListOfPushes(int limit) Retrieve the list of pushes without any limit in time, with a specific limit in the number of retrieved pushes.
int	postFile(java.lang.String url, java.lang.String filePath) Upload a file on the Pushbullet servers.
java.lang.String	sendGetRequest(java.lang.String url) Executes an Http Get request and returns the String representation of the response from the server.
Push	sendNewFile(java.lang.String filePath, java.lang.String fileName, java.lang.String fileType, java.lang.String targetDeviceIden) Sends a new file to the Pushbullet servers and sends this file through a push.
Push	sendNewPush(java.lang.String body) Sends a new push with a specific body to the Pushbullet server.
Push	sendNewPush(java.lang.String title, java.lang.String body) Sends a new push with a specific title and a specific body to the Pushbullet server.
Push	sendNewPush(java.lang.String title, java.lang.String body, java.lang.String targetDeviceIden) Sends a new push with a specific title and a specific body to the Pushbullet server.
java.lang.String	sendPostRequest(java.lang.String url) Executes an Http Post request and returns the String representation of the response from the server.
java.lang.String	sendPostRequest(java.lang.String url, java.util.List<org.apache.http.NameValuePair> urlParameters) Executes an Http Post request with specific url parameters and returns the String representation of the response from the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pushbullet

public Pushbullet(java.lang.String accessToken,
                  java.lang.String deviceName,
                  Router router)

Constructor for a new Pushbullet instance with a specific access token, a device name corresponding to the name that your robot will take in your Pushbullet list of devices, and the Raspoid router to use with this Pushbullet instance.

The access token can easily be retrieved from your Pushbullet account settings.

Note that if a device with the specified name already exists, this device will be retrieved. If no devices with this name exists, a new one will be created.

As for other types of servers, the router is used to deal with requests received on this Pushbullet instance.

Parameters:

accessToken - the access token used to access Pushbullet services.

deviceName - the name corresponding to your robot's Pushbullet device.

router - the router to use to deal with requests received on the deviceName.

Method Detail

sendGetRequest

public java.lang.String sendGetRequest(java.lang.String url)

Executes an Http Get request and returns the String representation of the response from the server. Returns null in case of problem.

Parameters:

url - the url of the Get request to execute.

Returns:

the String representation of the response from the server.

sendPostRequest

public java.lang.String sendPostRequest(java.lang.String url)

Executes an Http Post request and returns the String representation of the response from the server. Returns null in case of problem.

Parameters:

url - the url of the Post request to execute.

Returns:

the String representation of the response from the server.

sendPostRequest

public java.lang.String sendPostRequest(java.lang.String url,
                                        java.util.List<org.apache.http.NameValuePair> urlParameters)

Executes an Http Post request with specific url parameters and returns the String representation of the response from the server. Returns null in case of problem.

Parameters:

url - the url of the Post request to execute.

urlParameters - the url parameters to add to the request.

Returns:

the String representation of the response from the server.

postFile

public int postFile(java.lang.String url,
                    java.lang.String filePath)

Upload a file on the Pushbullet servers.

Parameters:

url - authorized url to post the file.

filePath - the local path of the file to post.

Returns:

the response from the HTTP request.

getListOfPushes

public java.util.List<Push> getListOfPushes(double modifiedAfter,
                                            int limit)

Retrieve the list of pushes received after a specific timestamp, with a specific limit in the number of retrieved pushes.

Parameters:

modifiedAfter - the timestamp from which to retrieve pushes.

limit - the maximum number of pushes to retrieve on the Pushbullet servers. -1 if no limit.

Returns:

the list of last limit pushes modified after the modifiedAfter timestamp, retrieved on the Pushbullet services.

getListOfPushes

public java.util.List<Push> getListOfPushes(int limit)

Retrieve the list of pushes without any limit in time, with a specific limit in the number of retrieved pushes.

Parameters:

limit - the maximum number of pushes to retrieve on the Pushbullet servers. -1 if no limit.

Returns:

the list of last limit pushes, retrieved on the Pushbullet services.

getListOfDevices

public java.util.List<Device> getListOfDevices()

Retrieve the list of Pushbullet devices linked to the specified access token account.

Returns:

the list of Pusbullet devices linked to the specifiec access token account.

sendNewPush

public Push sendNewPush(java.lang.String body)

Sends a new push with a specific body to the Pushbullet server. The push is sent in broadcast mode (to all account devices) to the account linked to the specified access token.

Parameters:

body - the body of the push sent to Pushbullet server.

Returns:

a Push entity representing the newly sent push to the Pushbullet server.

sendNewPush

public Push sendNewPush(java.lang.String title,
                        java.lang.String body)

Sends a new push with a specific title and a specific body to the Pushbullet server. The push is sent in broadcast mode (to all account devices) to the account linked to the specified access token.

Parameters:

title - the title of the push sent to the Pusbullet server.

body - the body of the push sent to the Pushbullet server.

Returns:

a Push entity representing the newly sent push to the Pushbullet server.

sendNewPush

public Push sendNewPush(java.lang.String title,
                        java.lang.String body,
                        java.lang.String targetDeviceIden)

Sends a new push with a specific title and a specific body to the Pushbullet server. The push is sent to a specific device, or in broadcast mode (to all account devices) if targetDeviceIden is null, to the account linked to the specified access token.

Parameters:

title - the title of the push sent to the Pusbullet server.

body - the body of the push sent to the Pushbullet server.

targetDeviceIden - the user's device targeted by the push. null for broadcast.

Returns:

a Push entity representing the newly sent push to the Pushbullet server.

sendNewFile

public Push sendNewFile(java.lang.String filePath,
                        java.lang.String fileName,
                        java.lang.String fileType,
                        java.lang.String targetDeviceIden)

Sends a new file to the Pushbullet servers and sends this file through a push. The push is sent to a specific device, or in broadcast mode if targetDeviceIden is null.

Parameters:

filePath - the path of the file to send.

fileName - the name of the file to send.

fileType - the type of the file to send.

targetDeviceIden - the user's device targeted by the push. null for broadcast.

Returns:

a Push entity representing the newly sent push.