package ircbee

import "github.com/muesli/beehive/bees/ircbee"

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
• func (factory *IrcBeeFactory) States() []bees.StateDescriptor

Package Files ¶

ircbee.go ircbeefactory.go

type IrcBee ¶ Uses

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

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

func (*IrcBee) Action ¶ Uses

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

Action triggers the action passed to it.

func (*IrcBee) ReloadOptions ¶ Uses

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

ReloadOptions parses the config options and initializes the Bee.

func (*IrcBee) Run ¶ Uses

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

Run executes the Bee's event loop.

type IrcBeeFactory ¶ Uses

type IrcBeeFactory struct {
    bees.BeeFactory
}

IrcBeeFactory is a factory for IrcBees.

func (*IrcBeeFactory) Actions ¶ Uses

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

Actions describes the available actions provided by this Bee.

func (*IrcBeeFactory) Description ¶ Uses

func (factory *IrcBeeFactory) Description() string

Description returns the description of this Bee.

func (*IrcBeeFactory) Events ¶ Uses

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

Events describes the available events provided by this Bee.

func (*IrcBeeFactory) ID ¶ Uses

func (factory *IrcBeeFactory) ID() string

ID returns the ID of this Bee.

func (*IrcBeeFactory) Image ¶ Uses

func (factory *IrcBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*IrcBeeFactory) LogoColor ¶ Uses

func (factory *IrcBeeFactory) LogoColor() string

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

func (*IrcBeeFactory) Name ¶ Uses

func (factory *IrcBeeFactory) Name() string

Name returns the name of this Bee.

func (*IrcBeeFactory) New ¶ Uses

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 ¶ Uses

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

Options returns the options available to configure this Bee.

func (*IrcBeeFactory) States ¶ Uses

func (factory *IrcBeeFactory) States() []bees.StateDescriptor

States returns the state values provided by this Bee.

Directories ¶