ircbee

Documentation

Overview

Package ircbee is a Bee that can connect to an IRC server.

Index

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

Types

type IrcBee

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

IrcBee is a Bee that can connect to an IRC server.

func (*IrcBee) Action

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

Action triggers the action passed to it.

func (*IrcBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*IrcBee) Run

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

Run executes the Bee's event loop.

type IrcBeeFactory

type IrcBeeFactory struct {
	bees.BeeFactory
}

IrcBeeFactory is a factory for IrcBees.

func (*IrcBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*IrcBeeFactory) Description

func (factory *IrcBeeFactory) Description() string

Description returns the description of this Bee.

func (*IrcBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*IrcBeeFactory) ID

func (factory *IrcBeeFactory) ID() string

ID returns the ID of this Bee.

func (*IrcBeeFactory) Image

func (factory *IrcBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*IrcBeeFactory) LogoColor

func (factory *IrcBeeFactory) LogoColor() string

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

func (*IrcBeeFactory) Name

func (factory *IrcBeeFactory) Name() string

Name returns the name of this Bee.

func (*IrcBeeFactory) New

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

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

func (*IrcBeeFactory) Options

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

Options returns the options available to configure this Bee.