mumblebee

Documentation

Overview

Package mumblebee is a Bee that can connect to a Mumble/XMPP server.

Index

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

Types

type MumbleBee

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

MumbleBee is a Bee that can connect to a Mumble server.

func (*MumbleBee) Action

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

Action triggers the action passed to it.

func (*MumbleBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*MumbleBee) Run

func (mod *MumbleBee) Run(eventChan chan bees.Event)

Run executes the Bee's event loop.

type MumbleBeeFactory

type MumbleBeeFactory struct {
	bees.BeeFactory
}

MumbleBeeFactory is a factory for MumbleBees.

func (*MumbleBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*MumbleBeeFactory) Description

func (factory *MumbleBeeFactory) Description() string

Description returns the description of this Bee.

func (*MumbleBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*MumbleBeeFactory) ID

func (factory *MumbleBeeFactory) ID() string

ID returns the ID of this Bee.

func (*MumbleBeeFactory) Image

func (factory *MumbleBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*MumbleBeeFactory) LogoColor

func (factory *MumbleBeeFactory) LogoColor() string

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

func (*MumbleBeeFactory) Name

func (factory *MumbleBeeFactory) Name() string

Name returns the name of this Bee.

func (*MumbleBeeFactory) New

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

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

func (*MumbleBeeFactory) Options

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

Options returns the options available to configure this Bee.