hellobee

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 12, 2020 License: AGPL-3.0 Imports: 1 Imported by: 0

Documentation

Overview

Package hellobee is an example for a Bee skeleton, designed to help you get started with writing your own Bees.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HelloBee

type HelloBee struct {
	bees.Bee
}

HelloBee is an example for a Bee skeleton, designed to help you get started with writing your own Bees.

func (*HelloBee) Action

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

Action triggers the action passed to it.

func (*HelloBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*HelloBee) Run

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

Run executes the Bee's event loop.

type HelloBeeFactory

type HelloBeeFactory struct {
	bees.BeeFactory
}

HelloBeeFactory is a factory for HelloBees.

func (*HelloBeeFactory) Description

func (factory *HelloBeeFactory) Description() string

Description returns the description of this Bee.

func (*HelloBeeFactory) ID

func (factory *HelloBeeFactory) ID() string

ID returns the ID of this Bee.

func (*HelloBeeFactory) Name

func (factory *HelloBeeFactory) Name() string

Name returns the name of this Bee.

func (*HelloBeeFactory) New

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

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

Jump to

Keyboard shortcuts

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