This module is very simple to use. All you need is your PushBullet API key and you can begin pushing.
let PushBullet = require('pushbullet');let pusher = new PushBullet('YOUR-API-KEY');let response = await pusher.devices();let response = await pusher.note(deviceParams, noteTitle, noteBody);
Target devices
The push functions (, , ) have a parameter which can be several types:
note
link
file
deviceParams
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_iden attribute. If the object is empty, {}, then the push is sent to all devices.
Async/Await
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());
API
new PushBullet(apiKey)
Creates a new PushBullet object.
The apiKey parameter is the string API key provided by PushBullet.
PushBullet.me();
Get the current user's information.
await pusher.me();
PushBullet.devices([options])
Retrieves a list of pushable devices.
The options parameter can use two attributes cursor andlimit
to control the data returned.
active is used to restrict the results to only active devices.
cursor is used to select the page if the results have been paginated.
limit is used to limit the number of objects in the reponse.
let options = { limit: 10};await pusher.devices(options);
PushBullet.createDevice(deviceOptions)
Creates a new device.
let deviceOptions = { nickname: 'node-app'};await pusher.createDevice(deviceOptions);
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', {});
PushBullet.deleteText(textIden)
Delete a text.
await pusher.deleteText('udprOsjAsLtNTRAG');
PushBullet.sendSMS(options)
Send an SMS through a device.
let options = { source_user_iden: 'ujpah72o0', // The user iden of the user sending this message target_device_iden: 'ujpah72o0sjAoRtnM0jc', // The iden of the device corresponding to the phone that should send the SMS conversation_iden: '+1 303 555 1212', // Phone number to send the SMS to message: 'Hello!' // The SMS message to send};await pusher.sendSMS(options);
PushBullet.sendClipboard(options)
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);
PushBullet.dismissEphemeral(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);
PushBullet.stream()
Returns a new stream listener which will emit events from the stream.
let stream = pusher.stream();
connect()
Connects to the stream.
stream.connect();
close()
Disconnects from the stream.
stream.close();
Events
connect
Emitted when the stream has connected.
stream.on('connect', function() { // stream has connected});
close
Emitted when the stream has disconnected.
stream.on('close', function() { // stream has disconnected});
error
Emitted when there is a connection or streaming 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.