gitterbee

README

Rooms

A rooms name is always the the last part of the uri. For example: the_beehive/Lobby

Documentation

Overview

Package gitterbee is a Bee that can interface with Gitter

Package gitterbee is a Bee that can interface with Gitter

Index

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

Types

type GitterBee

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

GitterBee is a Bee that can interface with Gitter

func (*GitterBee) Action

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

Action triggers the actions passed to it.

func (*GitterBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*GitterBee) Run

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

Run executes the Bee's event loop.

type GitterBeeFactory

type GitterBeeFactory struct {
	bees.BeeFactory
}

GitterBeeFactory is a factory for GitterBees

func (*GitterBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*GitterBeeFactory) Description

func (factory *GitterBeeFactory) Description() string

Description returns the desciption of this Bee.

func (*GitterBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*GitterBeeFactory) ID

func (factory *GitterBeeFactory) ID() string

ID returns the ID of this Bee.

func (*GitterBeeFactory) Image

func (factory *GitterBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*GitterBeeFactory) LogoColor

func (factory *GitterBeeFactory) LogoColor() string

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

func (*GitterBeeFactory) Name

func (factory *GitterBeeFactory) Name() string

Name returns the name of this Bee.

func (*GitterBeeFactory) New

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

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

func (*GitterBeeFactory) Options

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

Options returns the options available to configure this Bee.