discordbot

README

discordbot

A minimal Discord bot programming library

Documentation

Index

• type DiscordBot
  • func New(apiKey string, ui UserInterface) (DiscordBot, error)
• type Message
• type MessageHandler
• type User
• type UserInterface

Types

type DiscordBot

type DiscordBot interface {
	User() User
	Close()
	OnMessage(MessageHandler)
	SendMessage(channelID string, content string) error
}

/ Represents a Discord bot user.

func New

func New(apiKey string, ui UserInterface) (DiscordBot, error)

/ Creates a new DiscordBot using the specific UserInterface

type Message

type Message struct {
	User        User
	Content     string
	ChannelID   string
	ChannelName string
	IsDM        bool
}

type MessageHandler

type MessageHandler func(DiscordBot, *Message)

/ Adapter for message handler fns.

type User

type User struct {
	ID string
}

type UserInterface

type UserInterface int

/ Specifies how the bot interacts with users. / / Terminal: Messages are sent and recieved on stdout/stdin. / Client: Messages are sent and recieved through the discord client.

const (
	Terminal UserInterface = iota
	Client
)