twitterbee

Documentation

Overview

Package twitterbee is a Bee that can interface with Twitter.

Index

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

Types

type TwitterBee

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

TwitterBee is a Bee that can interface with Twitter.

func (*TwitterBee) Action

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

Action triggers the action passed to it.

func (*TwitterBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*TwitterBee) Run

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

Run executes the Bee's event loop.

type TwitterBeeFactory

type TwitterBeeFactory struct {
	bees.BeeFactory
}

TwitterBeeFactory is a factory for TwitterBees.

func (*TwitterBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*TwitterBeeFactory) Description

func (factory *TwitterBeeFactory) Description() string

Description returns the description of this Bee.

func (*TwitterBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*TwitterBeeFactory) ID

func (factory *TwitterBeeFactory) ID() string

ID returns the ID of this Bee.

func (*TwitterBeeFactory) Image

func (factory *TwitterBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*TwitterBeeFactory) LogoColor

func (factory *TwitterBeeFactory) LogoColor() string

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

func (*TwitterBeeFactory) Name

func (factory *TwitterBeeFactory) Name() string

Name returns the name of this Bee.

func (*TwitterBeeFactory) New

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

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

func (*TwitterBeeFactory) Options

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

Options returns the options available to configure this Bee.