discord

Documentation

Overview

Package discord implements the ChatBot interface using discord as the underlying chat service

Index

• func New(executor action.Executor, s store.Store) (*discord, error)
• func RespErr(r *botResponse, m string)
• func RespOk(r *botResponse, title string) *discordgo.MessageEmbed
• type ChatBot

Functions

func New

func New(executor action.Executor, s store.Store) (*discord, error)

New instantiates a new, unconnected, discord instance

func RespErr

func RespErr(r *botResponse, m string)

RespErr creates a common error message embed

func RespOk

func RespOk(r *botResponse, title string) *discordgo.MessageEmbed

RespOk will set up and allocate a base successful response embed that can be further customized

Types

type ChatBot

type ChatBot interface {
	Start(ctx context.Context, token string, eventChan chan model.ServerEvent) error
	Send(channelId string, message string, wrap bool) error
	SendEmbed(channelId string, message *discordgo.MessageEmbed) error
}

ChatBot defines a interface for communication with 3rd party service bots Currently this is only used for discord, but other providers such as Guilded, Matrix, IRC, etc. are planned. TODO decouple embed's from discordgo