write

Documentation

Overview

Package write renders a PNG using the Handwriting.io API.

To use this plugin, you will need to create an account at Handwriting.io, create a token, and then add the following when initializing the plugin:

HandwritingioAPIURL=https://token:secret@api.handwriting.io
S3Bucket=s3 bucket to store and link to rendered images

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

Types

type Plugin

type Plugin struct {
	HandwritingioAPIURL string
	S3Bucket            string
}

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

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