discordance

package module

v0.3.1 Latest Latest Go to latest Published: Feb 17, 2022 License: MIT Imports: 8 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

bitbucket.org/idomdavis/discordance

Links

Open Source Insights

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)
type User
- func (u *User) Author() *discordgo.MessageEmbedAuthor
- func (u *User) Populate(s *discordgo.Session) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.0.7

type User struct {
	ID     string
	Name   string
	Avatar string
}

User defines basic details on a user.

func (*User) Author ¶ added in v0.0.8

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

Author returns the user as a message embed author.

func (*User) Populate ¶ added in v0.0.7

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
command Package command defines application commands and handlers for the bot.	Package command defines application commands and handlers for the bot.
config Package config provides goconfigure compatible configuration blocks for a discordance bot.	Package config provides goconfigure compatible configuration blocks for a discordance bot.
example
message Package message handles replies and message events.	Package message handles replies and message events.
snowflake Package snowflake provides functions for acting on Discord snowflakes.	Package snowflake provides functions for acting on Discord snowflakes.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL