plugins

Documentation

Overview

Package plugins provides a collection of example (and usable) plugins for instances of slackscot

Package plugins provides a collection of example (and usable) plugins for instances of slackscot

Index

• Constants
• func NewEmojiBannerMaker(c *config.PluginConfig) (toClose io.Closer, emojiBannerPlugin *slackscot.Plugin, err error)
• func NewFingerQuoter(config *config.PluginConfig) (p *slackscot.Plugin, err error)
• func NewKarma(storer store.GlobalSiloStringStorer) (karma *slackscot.Plugin)
• func NewOhMonday(c *config.PluginConfig) (p *slackscot.Plugin, err error)
• func NewTriggerer(storer store.GlobalSiloStringStorer) (p *slackscot.Plugin)
• func NewVersionner(name string, version string) (p *slackscot.Plugin)
• type EmojiBannerMaker
  • func (e *EmojiBannerMaker) Close() (err error)
• type FingerQuoter
• type Karma
• type OhMonday
• type Triggerer

Constants

const (
	// EmojiBannerPluginName holds identifying name for the emoji banner plugin
	EmojiBannerPluginName = "emojiBanner"
)

const (
	// FingerQuoterPluginName holds identifying name for the finger quoter plugin
	FingerQuoterPluginName = "fingerQuoter"
)

const (
	// KarmaPluginName holds identifying name for the karma plugin
	KarmaPluginName = "karma"
)

const (
	// OhMondayPluginName holds identifying name for the karma plugin
	OhMondayPluginName = "ohMonday"
)

const (
	// TriggererPluginName holds identifying name for the triggerer plugin
	TriggererPluginName = "triggerer"
)

Functions

func NewEmojiBannerMaker

func NewEmojiBannerMaker(c *config.PluginConfig) (toClose io.Closer, emojiBannerPlugin *slackscot.Plugin, err error)

NewEmojiBannerMaker creates a new instance of the plugin. Note that since it creates a temporary directory to store fonts, the caller should make sure to defer Close on shutdown

func NewFingerQuoter

func NewFingerQuoter(config *config.PluginConfig) (p *slackscot.Plugin, err error)

NewFingerQuoter creates a new instance of the plugin

func NewKarma

func NewKarma(storer store.GlobalSiloStringStorer) (karma *slackscot.Plugin)

NewKarma creates a new instance of the Karma plugin

func NewOhMonday

func NewOhMonday(c *config.PluginConfig) (p *slackscot.Plugin, err error)

NewOhMonday creates a new instance of the OhMonday plugin

func NewTriggerer

func NewTriggerer(storer store.GlobalSiloStringStorer) (p *slackscot.Plugin)

NewTriggerer creates a new instance of the Triggerer plugin

func NewVersionner

func NewVersionner(name string, version string) (p *slackscot.Plugin)

NewVersionner creates a new instance of the versionner plugin

Types

type EmojiBannerMaker

type EmojiBannerMaker struct {
	*slackscot.Plugin
	// contains filtered or unexported fields
}

EmojiBannerMaker holds the plugin data for the emoji banner maker plugin

func (*EmojiBannerMaker) Close

func (e *EmojiBannerMaker) Close() (err error)

Close cleans up resources (temp font directory) used by the plugin

type FingerQuoter

type FingerQuoter struct {
	*slackscot.Plugin
	// contains filtered or unexported fields
}

FingerQuoter holds the plugin data for the finger quoter plugin

type Karma

type Karma struct {
	*slackscot.Plugin
	// contains filtered or unexported fields
}

Karma holds the plugin data for the karma plugin

type OhMonday

type OhMonday struct {
	*slackscot.Plugin
	// contains filtered or unexported fields
}

OhMonday holds the plugin data for the Oh Monday plugin

type Triggerer

type Triggerer struct {
	*slackscot.Plugin
	// contains filtered or unexported fields
}

Triggerer holds the plugin data for the triggerer plugin The triggerer plugin consists of a command to register a new trigger with its answer along with a hear action that will listen and react if one of the registered triggers is said