notificationbee

Documentation

Overview

Package notificationbee is a Bee that can trigger desktop notifications.

Package notificationbee is a Bee that can trigger desktop notifications.

Index

• Constants
• type NotificationBee
  • func (mod *NotificationBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *NotificationBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *NotificationBee) Run(cin chan bees.Event)
• type NotificationBeeFactory
  • func (factory *NotificationBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *NotificationBeeFactory) Description() string
  • func (factory *NotificationBeeFactory) ID() string
  • func (factory *NotificationBeeFactory) Image() string
  • func (factory *NotificationBeeFactory) LogoColor() string
  • func (factory *NotificationBeeFactory) Name() string
  • func (factory *NotificationBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

Constants

const (
	UrgencyLow = uint32(iota)
	UrgencyNormal
	UrgencyCritical
)

Urgency level iota

Types

type NotificationBee

type NotificationBee struct {
	bees.Bee
}

NotificationBee is a Bee that can trigger freedesktop.org DBus notifications.

func (*NotificationBee) Action

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

Action triggers the action passed to it.

func (*NotificationBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*NotificationBee) Run

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

Run executes the Bee's event loop.

type NotificationBeeFactory

type NotificationBeeFactory struct {
	bees.BeeFactory
}

NotificationBeeFactory is a factory for NotificationBees.

func (*NotificationBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*NotificationBeeFactory) Description

func (factory *NotificationBeeFactory) Description() string

Description returns the description of this Bee.

func (*NotificationBeeFactory) ID

func (factory *NotificationBeeFactory) ID() string

ID returns the ID of this Bee.

func (*NotificationBeeFactory) Image

func (factory *NotificationBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*NotificationBeeFactory) LogoColor

func (factory *NotificationBeeFactory) LogoColor() string

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

func (*NotificationBeeFactory) Name

func (factory *NotificationBeeFactory) Name() string

Name returns the name of this Bee.

func (*NotificationBeeFactory) New

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

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