listener

Documentation

Overview

Package listener defines chat listeners for the bot.

Index

• Variables
• func ConsoleClient(dispatcher Dispatcher, _ config.Settings) message.Sender
• func DiscordClient(dispatcher Dispatcher, settings config.Settings) (message.Sender, error)
• func Start(dispatcher Dispatcher, settings config.Settings) (message.Sender, error)
• type Console
  • func (c Console) Send(message message.Outbound) error
  • func (c Console) SendString(channel, msg string) error
• type Discord
  • func (d *Discord) Connect(token string) (*discordgo.Session, error)
• type DiscordSender
  • func (d DiscordSender) Send(msg message.Outbound) error
  • func (d DiscordSender) SendString(channel, msg string) error
• type Dispatcher
  • func (d Dispatcher) Dispatch(m message.Inbound, s message.Sender)

Examples

• Dispatcher.Dispatch

Variables

var ErrConnectionFailure = errors.New("failed to connect to server")

ErrConnectionFailure is returned if there was an error connecting to the server for any reason.

var ErrInvalidClientConfig = errors.New("invalid client config")

ErrInvalidClientConfig is returned if the bot is started with a client config name it doesn't recognise.

var ErrNoDiscordToken = errors.New("no discord token set")

ErrNoDiscordToken is returned if there is no Discord token set in the config.

Functions

func ConsoleClient

func ConsoleClient(dispatcher Dispatcher, _ config.Settings) message.Sender

ConsoleClient starts a new client listening on the console.

func DiscordClient

func DiscordClient(dispatcher Dispatcher, settings config.Settings) (message.Sender, error)

DiscordClient creates a new connection to Discord using the given Dispatcher and Settings. If the connection fails an error is returned. If there is no Discord Token set then the program will exit.

func Start

func Start(dispatcher Dispatcher, settings config.Settings) (message.Sender, error)

Start the client using the Dispatcher to handle incoming messages.

Types

type Console

type Console struct {
	Dispatcher
}

Console client.

func (Console) Send

func (c Console) Send(message message.Outbound) error

Send will output the message component of the Outbound to STDOUT.

func (Console) SendString

func (c Console) SendString(channel, msg string) error

SendString will build an Outbound and Send that.

type Discord

type Discord struct {
	Dispatcher
}

Discord listener. The set of Actions are used to handle the messages.

func (*Discord) Connect

func (d *Discord) Connect(token string) (*discordgo.Session, error)

Connect to the Discord server using the given token. The Actions set on the Discord type will be used to handle the message.

type DiscordSender

type DiscordSender struct {
	// contains filtered or unexported fields
}

DiscordSender sends messages to Discord.

func (DiscordSender) Send

func (d DiscordSender) Send(msg message.Outbound) error

Send a message to Discord.

func (DiscordSender) SendString

func (d DiscordSender) SendString(channel, msg string) error

SendString builds an Outbound message and sends it.

type Dispatcher

type Dispatcher struct {
	config.Settings

	Actions []actions.Handler
}

A Dispatcher dispatches incoming messages to each of the Actions which can handle them and reply via the Author if needed.

func (Dispatcher) Dispatch

func (d Dispatcher) Dispatch(m message.Inbound, s message.Sender)

Dispatch an incoming Message to the registered Actions allowing them to respond if relevant on the Sender.

Example

d := listener.Dispatcher{
	Actions:  []actions.Handler{&actions.Echo{}},
	Settings: config.Settings{Discord: config.Discord{Prefix: "!"}},
}

c := &MockClient{
	Dispatcher: d,
}

c.Receive(message.Inbound{
	Channel: "chan",
	Content: d.Settings.Discord.Prefix + "Some amusing message",
	Author: message.User{
		ID:  "sender",
		Bot: false,
	},
})

if len(c.Messages) == 1 {
	fmt.Println(c.Messages[0].Message)
}

Output:

[chan] sender: Some amusing message