ircbee

package

v0.4.0 Latest Latest Go to latest Published: Apr 12, 2020 License: AGPL-3.0 Imports: 6 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/muesli/beehive

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

func (*IrcBeeFactory) States ¶ added in v0.3.2

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

States returns the state values provided by this Bee.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
irctools Package irctools is a collection of convenient IRC styling methods.	Package irctools is a collection of convenient IRC styling methods.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL