package discordbee

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

Package discordbee is a bee for sending and receiving messages with Discord servers.

Index ¶

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

Package Files ¶

discordbee.go discordbeefactory.go

type DiscordBee ¶ Uses

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

DiscordBee is a bee for sending and receiving messages with Discord servers.

func (*DiscordBee) Action ¶ Uses

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

Action triggers the action passed to it.

func (*DiscordBee) ReloadOptions ¶ Uses

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

ReloadOptions parses the config options and initializes the Bee.

func (*DiscordBee) Run ¶ Uses

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

Run executes the Bee's event loop.

type DiscordBeeFactory ¶ Uses

type DiscordBeeFactory struct {
    bees.BeeFactory
}

DiscordBeeFactory is a factory for DiscordBees.

func (*DiscordBeeFactory) Actions ¶ Uses

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

Actions describes the available actions provided by this Bee.

func (*DiscordBeeFactory) Description ¶ Uses

func (factory *DiscordBeeFactory) Description() string

Description returns the description of this Bee.

func (*DiscordBeeFactory) Events ¶ Uses

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

Events describes the available events provided by this Bee.

func (*DiscordBeeFactory) ID ¶ Uses

func (factory *DiscordBeeFactory) ID() string

ID returns the ID of this Bee.

func (*DiscordBeeFactory) Image ¶ Uses

func (factory *DiscordBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*DiscordBeeFactory) LogoColor ¶ Uses

func (factory *DiscordBeeFactory) LogoColor() string

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

func (*DiscordBeeFactory) Name ¶ Uses

func (factory *DiscordBeeFactory) Name() string

Name returns the name of this Bee.

func (*DiscordBeeFactory) New ¶ Uses

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

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

func (*DiscordBeeFactory) Options ¶ Uses

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

Options returns the options available to configure this Bee.