About

This plugin sends messages through the pushbullet api

Usage

• You must install pushbullet.py
• Enter your api key with the apikey command

pb

apikey

usage: #bp.pb.apikey [-h] [value]

set the Pushbullet API key

positional arguments:
  value       Pushbullet API key

optional arguments:
  -h, --help  show help (default: False)

channels

usage: #bp.pb.channels [-h]

show channels associated with pb

optional arguments:
  -h, --help  show help (default: False)

link

usage: #bp.pb.link [-c CHANNEL] [-h] [title] [url]

send a link

positional arguments:
  title                 the title of the link (default: Pushbullet link from
                        bastproxy)
  url                   the url of the link (default:
                        https://github.com/endavis/bastproxy)

optional arguments:
  -c CHANNEL, --channel CHANNEL
                        the pushbullet channel to send to
  -h, --help            show help (default: False)

note

usage: #bp.pb.note [-c CHANNEL] [-h] [title] [body]

send a note

positional arguments:
  title                 the title of the note (default: Pushbullet note from
                        bastproxy)
  body                  the body of the note (default: A Pushbullet note sent
                        through bastproxy)

optional arguments:
  -c CHANNEL, --channel CHANNEL
                        the pushbullet channel to send to
  -h, --help            show help (default: False)

Base

api

usage: #bp.pb.api [-h] [api]

list functions in the api

positional arguments:
  api         api to get details of

optional arguments:
  -h, --help  show help (default: False)

help

usage: #bp.pb.help [-a] [-c] [-h]

show help info for this plugin

optional arguments:
  -a, --api       show functions this plugin has in the api (default: False)
  -c, --commands  show commands in this plugin (default: False)
  -h, --help      show help (default: False)

inspect

usage: #bp.pb.inspect [-m METHOD] [-o OBJECT] [-s] [-h]

inspect a plugin

optional arguments:
  -m METHOD, --method METHOD
                        get code for a method
  -o OBJECT, --object OBJECT
                        show an object of the plugin, can be method or
                        variable
  -s, --simple          show a simple output (default: False)
  -h, --help            show help (default: False)

reset

usage: #bp.pb.reset [-h]

reset the plugin

optional arguments:
  -h, --help  show help (default: False)

save

usage: #bp.pb.save [-h]

save the plugin state

optional arguments:
  -h, --help  show help (default: False)

set

usage: #bp.pb.set [-h] [name] [value]

change a setting in the plugin

if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin

positional arguments:
  name        the setting name (default: list)
  value       the new value of the setting

optional arguments:
  -h, --help  show help (default: False)

stats

usage: #bp.pb.stats [-h]

show plugin stats

optional arguments:
  -h, --help  show help (default: False)

channel

the channel to send to

note

pb.note(title, body, channel=None)
 send a note through pushbullet

    title     = the title of the note
    body      = the body of the note
    channel   = the pushbullet channel to send to

    this function returns True if sent, False otherwise

original defined in plugins/utils/pb.py

apikey

pb.apikey()

    read the secret from a file


original defined in plugins/core/ssc.py

link

pb.link(title, url, channel=None)
 send a link through pushbullet

    title  = the title of the note
    url      = the body of the note
    channel   = the pushbullet channel to send to

    this function returns True if sent, False otherwise

original defined in plugins/utils/pb.py