discordance

README

Discordance

A wrapper around discordgo for bots.

Documentation

Overview

Package discordance allows connection to discord and registration of various handlers for a bot interface.

Index

• type Connection
  • func Connect(settings config.Discord) (*Connection, error)
  • func (c *Connection) Commands(server string, commands ...*command.Definition)
  • func (c *Connection) Listen()
  • func (c *Connection) Message(handlers ...message.Handler)
  • func (c *Connection) Unregister(server string)
• type User
  • func (u *User) Author() *discordgo.MessageEmbedAuthor
  • func (u *User) Populate(s *discordgo.Session) error

Types

type Connection

type Connection struct {
	*discordgo.Session
	// contains filtered or unexported fields
}

Connection to a discord server.

func Connect

func Connect(settings config.Discord) (*Connection, error)

Connect to discord using the given config.

func (*Connection) Commands

func (c *Connection) Commands(server string, commands ...*command.Definition)

Commands to register on the given server.

func (*Connection) Listen

func (c *Connection) Listen()

Listen for events. Listen blocks until SIGINT is received.

func (*Connection) Message

func (c *Connection) Message(handlers ...message.Handler)

Message handlers to register on the connection.

func (*Connection) Unregister

func (c *Connection) Unregister(server string)

Unregister commands on this server.

type User

type User struct {
	ID     string
	Name   string
	Avatar string
}

User defines basic details on a user.

func (*User) Author

func (u *User) Author() *discordgo.MessageEmbedAuthor

Author returns the user as a message embed author.

func (*User) Populate

func (u *User) Populate(s *discordgo.Session) error

Populate a User from the given session. The User ID must be set as this is used to retrieve the user data. If an error is returned the User struct remains unmodified.