githubbee

Documentation

Overview

Package githubbee is a Bee that can interface with GitHub

Package githubbee is a Bee that can interface with GitHub

Package githubbee is a Bee that can interface with GitHub

Index

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

Types

type GitHubBee

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

GitHubBee is a Bee that can interface with GitHub

func (*GitHubBee) Action

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

Action triggers the actions passed to it.

func (*GitHubBee) ReloadOptions

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

ReloadOptions parses the config options and initializes the Bee.

func (*GitHubBee) Run

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

Run executes the Bee's event loop.

type GitHubBeeFactory

type GitHubBeeFactory struct {
	bees.BeeFactory
}

GitHubBeeFactory is a factory for GitHubBees

func (*GitHubBeeFactory) Actions

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

Actions describes the available actions provided by this Bee.

func (*GitHubBeeFactory) Description

func (factory *GitHubBeeFactory) Description() string

Description returns the desciption of this Bee.

func (*GitHubBeeFactory) Events

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

Events describes the available events provided by this Bee.

func (*GitHubBeeFactory) ID

func (factory *GitHubBeeFactory) ID() string

ID returns the ID of this Bee.

func (*GitHubBeeFactory) Image

func (factory *GitHubBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*GitHubBeeFactory) LogoColor

func (factory *GitHubBeeFactory) LogoColor() string

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

func (*GitHubBeeFactory) Name

func (factory *GitHubBeeFactory) Name() string

Name returns the name of this Bee.

func (*GitHubBeeFactory) New

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

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

func (*GitHubBeeFactory) Options

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

Options returns the options available to configure this Bee.