dcroute

package module

v1.0.2 Latest Latest Go to latest Published: Jul 7, 2023 License: MIT Imports: 11 Imported by: 0

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

github.com/Lexographics/dcroute

Links

Open Source Insights

README ¶

dcroute

Discord router for quick bot development

Documentation ¶

Constants ¶

View Source

const MessageAny = "_*"

View Source

const MessageNotFound = "_?"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ChannelType ¶

type ChannelType int

const (
	ChannelTypeGuildText          ChannelType = 0
	ChannelTypeDM                 ChannelType = 1
	ChannelTypeGuildVoice         ChannelType = 2
	ChannelTypeGroupDM            ChannelType = 3
	ChannelTypeGuildCategory      ChannelType = 4
	ChannelTypeGuildNews          ChannelType = 5
	ChannelTypeGuildStore         ChannelType = 6
	ChannelTypeGuildNewsThread    ChannelType = 10
	ChannelTypeGuildPublicThread  ChannelType = 11
	ChannelTypeGuildPrivateThread ChannelType = 12
	ChannelTypeGuildStageVoice    ChannelType = 13
	ChannelTypeGuildForum         ChannelType = 15
)

type Command ¶

type Command struct {
	Description string
	GuildID     string
}

type Context ¶

type Context struct {
	Sender    *User
	MessageID string
	ChannelID string
	GuildID   string

	MessageCreate     *discordgo.MessageCreate
	InteractionCreate *discordgo.InteractionCreate
	// contains filtered or unexported fields
}

func (*Context) CommandRespond ¶

func (c *Context) CommandRespond(response string)

func (*Context) RemoveReaction ¶

func (c *Context) RemoveReaction(channelID string, messageID string, reaction string) error

func (*Context) Router ¶

func (c *Context) Router() *Router

func (*Context) SendFile ¶

func (c *Context) SendFile(channelID string, name string, filepath string) error

func (*Context) SendMessage ¶

func (c *Context) SendMessage(channelID string, m string) error

func (*Context) SendReaction ¶

func (c *Context) SendReaction(channelID string, messageID string, reaction string) error

func (*Context) SendReply ¶

func (c *Context) SendReply(channelID string, messageID string, guildID string, m string) error

type CreateChannelArgs ¶

type CreateChannelArgs struct {
	GuildID    string
	Name       string
	Topic      string
	CategoryID string
	Type       ChannelType
}

type Group ¶

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

func (*Group) Command ¶

func (g *Group) Command(name string, command Command, f HandlerFunc)

func (*Group) Message ¶

func (g *Group) Message(name string, f HandlerFunc)

func (*Group) SetErrorFunc ¶

func (g *Group) SetErrorFunc(f HandlerFunc)

func (*Group) Use ¶

func (g *Group) Use(f MiddlewareFunc)

type HandlerFunc ¶

type HandlerFunc func(ctx *Context) error

type MiddlewareFunc ¶

type MiddlewareFunc func(ctx *Context) error

type Router ¶

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

func New ¶

func New(token string) *Router

func (*Router) CreateChannel ¶

func (r *Router) CreateChannel(args CreateChannelArgs) (*discordgo.Channel, error)

func (*Router) CreateEmoji ¶

func (r *Router) CreateEmoji(guildID string, name string, path string) (*discordgo.Emoji, error)

func (*Router) Group ¶

func (r *Router) Group() *Group

func (*Router) Session ¶

func (r *Router) Session() *discordgo.Session

func (*Router) SetErrorFunc ¶

func (r *Router) SetErrorFunc(f HandlerFunc)

func (*Router) SetPrefix ¶

func (r *Router) SetPrefix(prefix string)

func (*Router) Start ¶

func (r *Router) Start() error

func (*Router) Wait ¶

func (r *Router) Wait()

type User ¶

type User struct {
	Username string
	ID       string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example
utils

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