cats

Documentation

Overview

Package cats is a plugin that queries some cat API's and returns responses. It queries a cat fact API and a cat image/gif API

Index

• type Plugin
  • func (p Plugin) Command() []string
  • func (p Plugin) HandleMessage(in message.Basic) (out message.Basic)
  • func (p Plugin) Name() string
  • func (p Plugin) OnInit() error
  • func (p Plugin) Regexp() *regexp.Regexp
  • func (p Plugin) Usage() string

Examples

• Plugin.HandleMessage

Types

type Plugin

type Plugin struct{}

Plugin ...

func (Plugin) Command

func (p Plugin) Command() []string

Command returns a list of commands the plugin provides

func (Plugin) HandleMessage

func (p Plugin) HandleMessage(in message.Basic) (out message.Basic)

HandleMessage is responsible for handling the incoming message and returning a response based on the message provides

Example

fmt.Printf("%q\n", reCats.FindStringSubmatch("!cat"))
fmt.Printf("%q\n", reCatsType.FindStringSubmatch("!cat fact")[1])
fmt.Printf("%q\n", reCatsType.FindStringSubmatch("!cat gif"))
fmt.Printf("%q\n", reCats.FindStringSubmatch("cat"))

Output:

["!cat"]
"fact"
["!cat gif" "gif"]
[]

func (Plugin) Name

func (p Plugin) Name() string

Name is the name of the plugin

func (Plugin) OnInit

func (p Plugin) OnInit() error

OnInit returns an error if the plugin could not be started

func (Plugin) Regexp

func (p Plugin) Regexp() *regexp.Regexp

Regexp returns the regexp of a message that should be handled by this plugin

func (Plugin) Usage

func (p Plugin) Usage() string

Usage prints detailed usage instructions for the plugin