listener

Documentation

Overview

Package listener defines chat listeners for the bot.

Index

• Constants
• type Discord
  • func (d *Discord) Connect(token string) error
  • func (d *Discord) Handle(m Message, s Sender)
• type DiscordSender
  • func (d DiscordSender) Send(channel string, message string) error
• type Message
• type Sender
• type User

Examples

• Discord.Handle

Constants

const Prefix = "!"

Prefix is used by the bot to denote a command.

Types

type Discord

type Discord struct {
	Actions []actions.Handler
}

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

func (*Discord) Connect

func (d *Discord) Connect(token string) error

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

func (*Discord) Handle

func (d *Discord) Handle(m Message, s Sender)

Handle an incoming Message responding via the Sender.

Example

d := listener.Discord{Actions: []actions.Handler{actions.Echo{}}}
s := &MockSender{}

m := listener.Message{
	Channel: "chan",
	Content: listener.Prefix + "Some amusing message",
	Sender: listener.User{
		ID:  "sender",
		Bot: false,
	},
}

d.Handle(m, s)

fmt.Println(s.Message)

Output:

[chan] sender: Some amusing message

type DiscordSender

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

DiscordSender sends messages to Discord.

func (DiscordSender) Send

func (d DiscordSender) Send(channel string, message string) error

Send a message to Discord.

type Message

type Message struct {
	Channel string
	Content string
	Sender  User
}

Message received from the chat platform.

type Sender

type Sender interface {
	// Send the message to the channel. If the message fails to send return an
	// error.
	Send(channel string, message string) error
}

A Sender is able to send a message to a chat platform.

type User

type User struct {
	ID  string
	Bot bool
}

User on the chat platform.