efabee

Documentation

Overview

Package efabee is a Bee that interfaces with the public EVA API.

Index

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

Types

type EFABee

type EFABee struct {
	bees.Bee

	Provider string
	// contains filtered or unexported fields
}

EFABee is a Bee that interfaces with the public EVA API.

func (*EFABee) Action

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

Action triggers the action passed to it.

func (*EFABee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*EFABee) Run

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

Run executes the Bee's event loop.

type EFABeeFactory

type EFABeeFactory struct {
	bees.BeeFactory
}

EFABeeFactory is a factory for EFABees.

func (*EFABeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*EFABeeFactory) Description

func (factory *EFABeeFactory) Description() string

Description returns the description of this Bee.

func (*EFABeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*EFABeeFactory) ID

func (factory *EFABeeFactory) ID() string

ID returns the ID of this Bee.

func (*EFABeeFactory) Image

func (factory *EFABeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*EFABeeFactory) LogoColor

func (factory *EFABeeFactory) LogoColor() string

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

func (*EFABeeFactory) Name

func (factory *EFABeeFactory) Name() string

Name returns the name of this Bee.

func (*EFABeeFactory) New

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

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

func (*EFABeeFactory) Options

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

Options returns the options available to configure this Bee.