A Deno module for using the PushBullet REST API.
This module is very simple to use. All you need is your PushBullet API key and you can begin pushing.
import PushBullet from 'https://github.com/qgustavor/deno-pushbullet-api/raw/master/lib/pushbullet.js'
const pusher = new PushBullet('YOUR-API-KEY')
const response = await pusher.devices()
const response = await pusher.note(deviceParams, noteTitle, noteBody)The push functions (note, link, file) have a deviceParams parameter which can be several types:
- If it is a string containing an '@' it is treated as an email address.
- If it is a string not containing an '@' it is treated as a device iden.
- If it is a number it is treated as a device id.
- If it is an object it is assumed to have one of the 'target parameters' as defined on https://docs.pushbullet.com/v2/pushes/ as an attribute. It can also have an optional
source_device_idenattribute. If the object is empty,{}, then the push is sent to all devices.
Version 2 of the module supported callback and promise based execution. Version 3 uses async/await. Callbacks can still be used by utilising util.callbackify().
let response = await pusher.devices()
console.log(await response.json())Creates a new PushBullet object.
The apiKey parameter is the string API key provided by PushBullet.
Get the current user's information.
await pusher.me()Retrieves a list of pushable devices.
The options parameter can use two attributes cursor andlimit to control the data returned.
activeis used to restrict the results to only active devices.cursoris used to select the page if the results have been paginated.limitis used to limit the number of objects in the reponse.
let options = {
limit: 10
}
await pusher.devices(options)Creates a new device.
let deviceOptions = {
nickname: 'deno-app'
}
await pusher.createDevice(deviceOptions)Creates a new device.
let deviceOptions = {
nickname: 'deno-app'
}
await pusher.updateDevice(deviceIden, deviceOptions)Delete a device.
await pusher.deleteDevice('u1qSJddxeKwOGuGW')Push a note to the specified device.
await pusher.note('u1qSJddxeKwOGuGW', 'New Note', 'Note body text')Push a link to the specified device.
await pusher.link('u1qSJddxeKwOGuGW', 'GitHub', 'https://github.com/', 'Note body text')Push a file to the specified device.
await pusher.file('u1qSJddxeKwOGuGW', '/path/to/file', 'Important file!')Dismiss a push.
await pusher.dismissPush('udhrSpjAewzdwpCC')Delete a push.
await pusher.deletePush('udhrSpjAewzdwpCC')Delete all pushes associated with the current account.
await pusher.deleteAllPushes(function (error, response) {})Get the push history.
The options parameter can use three attributes cursor, limit and modified_after to control the data returned.
activeis used to only select undeleted pushes. Defaults to true if not specified.cursoris used to select the page if the results have been paginated.limitis used to limit the number of objects in the reponse.modified_aftershould be a timestamp. Defaults to 0 if not specified.
let options = {
limit: 10,
modified_after: 1400000000.00000
}
await pusher.history(options)Get a list of current subscriptions.
The options parameter can use two attributes cursor andlimit to control the data returned.
activeis used to restrict the results to only active devices.cursoris used to select the page if the results have been paginated.limitis used to limit the number of objects in the reponse.
let options = {
limit: 10
}
await pusher.subscriptions(options)Subscribe to a channel.
await pusher.subscribe('jblow')Subscribe to a channel.
await pusher.unsubscribe('udprOsjAsLtNTRAG')Mute a subscription.
await pusher.muteSubscription('udprOsjAsLtNTRAG')Unmute a subscription.
await pusher.unmuteSubscription('udprOsjAsLtNTRAG')Get information about a channel.
await pusher.channelInfo('jblow')Get a list of current chats.
The options parameter can use two attributes cursor andlimit to control the data returned.
activeis used to restrict the results to only active devices.cursoris used to select the page if the results have been paginated.limitis used to limit the number of objects in the reponse.
let options = {
limit: 10
}
await pusher.chats(options)Create a new chat.
await pusher.createChat('a@b.com')Delete a chat.
await pusher.deleteChat('udprOsjAsLtNTRAG')Mute a chat.
await pusher.muteChat('udprOsjAsLtNTRAG')Unmute a chat.
await pusher.unmuteChat('udprOsjAsLtNTRAG')Create a new text.
The options parameter can be used to add additional information to the text request.
file_urlis a URL of a file to send with the text.file_typeis the mime type of the file being sent. Required iffile_urlis used.
Other options are available, see https://docs.pushbullet.com/#text
await pusher.createText('udprOsjAsLtNTRAG', '+13035551212', 'Test Message', {})Update a chat.
options is an object representing the text attributes to update. See https://docs.pushbullet.com/#text for the available attributes and structure.
await pusher.updateText('udprOsjAsLtNTRAG', {})Delete a text.
await pusher.deleteText('udprOsjAsLtNTRAG')Send clipboard content.
let options = {
source_user_iden: 'ujpah72o0', // The iden of the user sending this message
source_device_iden: 'ujpah72o0sjAoRtnM0jc', // The iden of the device sending this message
body: 'http://www.google.com' // The text to copy to the clipboard
}
await pusher.sendClipboard(options)Dismiss an ephemeral.
let options = {
package_name: 'com.pushbullet.android', // Set to the package_name field from the mirrored notification
notification_id: '-8', // Set to the notification_id field from the mirrored notification
notification_tag: null, // Set to the notification_tag field from the mirrored notification
source_user_iden: 'ujpah72o0' // Set to the source_user_iden field from the mirrored notification
}
await pusher.dismissEphemeral(options)Returns a new stream listener which will emit events from the stream.
let stream = pusher.stream()Connects to the stream.
stream.connect()Disconnects from the stream.
stream.close()Emitted when the stream has connected.
stream.on('connect', function () {
// stream has connected
})Emitted when the stream has disconnected.
stream.on('close', function () {
// stream has disconnected
})Emitted when there is a connection or streaming error.
stream.on('error', function (error) {
// stream error
})Emitted when a message is received from the stream. message will be emitted for all messages but you can listen for specific messages with nop, tickle and push.
stream.on('message', function (message) {
// message received
})Emitted when the keep-alive 'no-operation' message is received.
stream.on('nop', function () {
// nop message received
})Emitted when the tickle message is received.
stream.on('tickle', function (type) {
// tickle message received
})Emited when the push message is received.
stream.on('push', function (push) {
// push message received
})Enables End-to-End encryption.
let response = await pusher.me()
let user = await response.json()
await pusher.enableEncryption('YOUR-END-TO-END-PASSWORD', user.iden)
let stream = pusher.stream()
stream.on('message', function (message) {
console.log(message) // message is decrypted automatically
})
stream.connect()
let options = {
source_user_iden: 'ujpah72o0',
target_device_iden: 'ujpah72o0sjAoRtnM0jc',
conversation_iden: '+1 303 555 1212',
message: 'Hello!'
}
await pusher.sendSMS(options) // options are encrypted automatically