pushoverbee

Documentation

Overview

Package pushoverbee is a Bee that can send pushover notifications.

Package pushoverbee is a Bee that can send pushover notifications.

Index

• type PushoverBee
  • func (mod *PushoverBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *PushoverBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *PushoverBee) Run(cin chan bees.Event)
• type PushoverBeeFactory
  • func (factory *PushoverBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *PushoverBeeFactory) Description() string
  • func (factory *PushoverBeeFactory) Events() []bees.EventDescriptor
  • func (factory *PushoverBeeFactory) ID() string
  • func (factory *PushoverBeeFactory) Image() string
  • func (factory *PushoverBeeFactory) LogoColor() string
  • func (factory *PushoverBeeFactory) Name() string
  • func (factory *PushoverBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *PushoverBeeFactory) Options() []bees.BeeOptionDescriptor

Types

type PushoverBee

type PushoverBee struct {
	bees.Bee
	// contains filtered or unexported fields
}

PushoverBee is a Bee that sends Pushover notifications

func (*PushoverBee) Action

func (mod *PushoverBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*PushoverBee) ReloadOptions

func (mod *PushoverBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

func (*PushoverBee) Run

func (mod *PushoverBee) Run(cin chan bees.Event)

Run executes the Bee's event loop.

type PushoverBeeFactory

type PushoverBeeFactory struct {
	bees.BeeFactory
}

PushoverBeeFactory is a factory for PushoverBees.

func (*PushoverBeeFactory) Actions

func (factory *PushoverBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*PushoverBeeFactory) Description

func (factory *PushoverBeeFactory) Description() string

Description returns the description of this Bee.

func (*PushoverBeeFactory) Events

func (factory *PushoverBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*PushoverBeeFactory) ID

func (factory *PushoverBeeFactory) ID() string

ID returns the ID of this Bee.

func (*PushoverBeeFactory) Image

func (factory *PushoverBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*PushoverBeeFactory) LogoColor

func (factory *PushoverBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*PushoverBeeFactory) Name

func (factory *PushoverBeeFactory) Name() string

Name returns the name of this Bee.

func (*PushoverBeeFactory) New

func (factory *PushoverBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.

func (*PushoverBeeFactory) Options

func (factory *PushoverBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.