switchboard

README

switchboard

Utility library for Discordgo providing streamlined interaction support

Documentation

Index

• Variables
• type Command
  • func (c *Command) ToDiscordCommand() (*discordgo.ApplicationCommand, error)
• type CommandType
• type Switchboard
  • func (s *Switchboard) AddCommand(command *Command) error
  • func (s *Switchboard) HandleInteractionCreate(session *discordgo.Session, interaction *discordgo.InteractionCreate)
  • func (s *Switchboard) SyncCommands(session *discordgo.Session, appId string) error

Variables

var ErrHandlerInvalidFirstParameterType = errors.New(
	"incorrect first parameter type for handler - first parameter must be of type *discordgo.Session",
)

var ErrHandlerInvalidParameterCount = errors.New(
	"invalid number of handler arguments",
)

var ErrHandlerInvalidSecondParameterType = errors.New(
	"incorrect second parameter type for handler - second parameter must be of type *discordgo.InteractionCreate",
)

var ErrHandlerInvalidThirdParameterType = errors.New(
	"incorrect third parameter type for handler - third parameter must be of type struct",
)

var ErrHandlerNotFunction = errors.New(
	"provided command handler is not a function",
)

var ErrInvalidArgumentType = errors.New(
	"struct field type is not a supported option type",
)

var ErrMessageHandlerInvalidThirdParameterType = errors.New(
	"incorrect third parameter type for handler - third parameter must be of type *discordgo.Message",
)

var ErrUnknownCommand = errors.New("unknown command")

var ErrUnsupportedDefaultArgType = errors.New(
	"attempted to use default value for option type which does not currently support default values",
)

var ErrUnsupportedInteractionType = errors.New("unsupported interaction type")

Types

type Command

type Command struct {
	Name        string
	Description string
	Handler     any
	GuildID     string

	Type CommandType
}

func (*Command) ToDiscordCommand

func (c *Command) ToDiscordCommand() (*discordgo.ApplicationCommand, error)

type CommandType

type CommandType int

const (
	SlashCommand CommandType = iota
	MessageCommand
)

type Switchboard

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

func (*Switchboard) AddCommand

func (s *Switchboard) AddCommand(command *Command) error

func (*Switchboard) HandleInteractionCreate

func (s *Switchboard) HandleInteractionCreate(session *discordgo.Session, interaction *discordgo.InteractionCreate)

func (*Switchboard) SyncCommands

func (s *Switchboard) SyncCommands(session *discordgo.Session, appId string) error