godiscordroute

README

godiscourdrote

A basic wrapper for godiscord. Adds gorilla mux like syntax for godiscord application commands. The goal of the project is to mimic the gorilla mux syntax. If you are familiar with the gorilla mux syntax, this project should feel instantly familiar to you.

Early Alpha

Example

import(
    discord "github.com/wheelbarrow777/godiscordroute"
)

func loggingMiddlewareTwo(next discord.Handler) discord.Handler {
	return discord.HandlerFunc(func(s *discordgo.Session, i *discordgo.InteractionCreate) {
        // Do stuff here
        log.Println(r.RequestURI)
        // Call the next handler, which can be another middleware in the cain, or the final handler.
		next.Respond(s, i)
	})
}


cmd := discord.NewCommand().SetHandler(
		discord.HandlerFunc(func(s *discordgo.Session, i *discordgo.InteractionCreate) {
			s.InteractionRespond(i.Interaction, &discordgo.InteractionResponse{
				Type: discordgo.InteractionResponseChannelMessageWithSource,
				Data: &discordgo.InteractionResponseData{
					Content: "hey there, binding works. Emoji? :smiley:",
				},
			})
		}),
	    ).AddMiddleware(loggingMiddlewareTwo).
		SetApplicationCmd(discordgo.ApplicationCommand{
			Name:        "binding-command",
			Description: "A basic binding command",
		}).Build()

binding, err := discord.NewBinding("guildid", "bottoken")
if err != nil {
    panic(err)
}
binding.AddCommand(cmd)

Documentation

Index

• Variables
• func Error(s *discordgo.Session, i *discordgo.InteractionCreate, errorMsg string)
• func ErrorUpdate(s *discordgo.Session, i *discordgo.InteractionCreate, errorMsg string)
• func SimpleMessage(s *discordgo.Session, i *discordgo.InteractionCreate, msg string)
• func SimpleUpdateMessage(s *discordgo.Session, i *discordgo.InteractionCreate, msg string)
• type AppCmdOptions
• type CommandBuilder
  • func NewCommand() CommandBuilder
• type DiscordBinding
  • func NewBinding(guild string, token string) (*DiscordBinding, error)
  • func (b *DiscordBinding) AddCommand(cmd DiscordCommad) error
  • func (b *DiscordBinding) DeleteAllCommands() error
• type DiscordCommad
  • func (dc *DiscordCommad) AddMiddleware(middleware MiddlewareFunc) CommandBuilder
  • func (dc *DiscordCommad) AddPermission(permission discordgo.ApplicationCommandPermissions) CommandBuilder
  • func (dc *DiscordCommad) AddSubcommand(cmd DiscordCommad) CommandBuilder
  • func (dc *DiscordCommad) Build() DiscordCommad
  • func (dc *DiscordCommad) SetApplicationCmd(cmd discordgo.ApplicationCommand) CommandBuilder
  • func (dc *DiscordCommad) SetHandler(handler Handler) CommandBuilder
  • func (dc *DiscordCommad) SetOptions(opts DiscordCommandOptions) CommandBuilder
• type DiscordCommandOptions
• type Handler
  • func AckMiddleware(next Handler) Handler
• type HandlerFunc
  • func (f HandlerFunc) Respond(s *discordgo.Session, i *discordgo.InteractionCreate, opts AppCmdOptions)
• type MiddlewareFunc
  • func (mw MiddlewareFunc) Middleware(handler Handler) Handler

Variables

var (
	ErrCommandAlreadyExist = errors.New("command already exist")
	ErrCommandDoesNotExist = errors.New("command doesn't exist")
)

Functions

func Error

func Error(s *discordgo.Session, i *discordgo.InteractionCreate, errorMsg string)

func ErrorUpdate

func ErrorUpdate(s *discordgo.Session, i *discordgo.InteractionCreate, errorMsg string)

func SimpleMessage

func SimpleMessage(s *discordgo.Session, i *discordgo.InteractionCreate, msg string)

func SimpleUpdateMessage

func SimpleUpdateMessage(s *discordgo.Session, i *discordgo.InteractionCreate, msg string)

Types

type AppCmdOptions

type AppCmdOptions []*discordgo.ApplicationCommandInteractionDataOption

type CommandBuilder

type CommandBuilder interface {
	SetHandler(Handler) CommandBuilder
	SetApplicationCmd(cmd discordgo.ApplicationCommand) CommandBuilder
	AddMiddleware(MiddlewareFunc) CommandBuilder
	AddPermission(permission discordgo.ApplicationCommandPermissions) CommandBuilder
	SetOptions(opts DiscordCommandOptions) CommandBuilder
	AddSubcommand(cmd DiscordCommad) CommandBuilder
	Build() DiscordCommad
}

func NewCommand

func NewCommand() CommandBuilder

type DiscordBinding

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

func NewBinding

func NewBinding(guild string, token string) (*DiscordBinding, error)

func (*DiscordBinding) AddCommand

func (b *DiscordBinding) AddCommand(cmd DiscordCommad) error

func (*DiscordBinding) DeleteAllCommands

func (b *DiscordBinding) DeleteAllCommands() error

type DiscordCommad

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

func (*DiscordCommad) AddMiddleware

func (dc *DiscordCommad) AddMiddleware(middleware MiddlewareFunc) CommandBuilder

func (*DiscordCommad) AddPermission

func (dc *DiscordCommad) AddPermission(permission discordgo.ApplicationCommandPermissions) CommandBuilder

func (*DiscordCommad) AddSubcommand

func (dc *DiscordCommad) AddSubcommand(cmd DiscordCommad) CommandBuilder

func (*DiscordCommad) Build

func (dc *DiscordCommad) Build() DiscordCommad

func (*DiscordCommad) SetApplicationCmd

func (dc *DiscordCommad) SetApplicationCmd(cmd discordgo.ApplicationCommand) CommandBuilder

func (*DiscordCommad) SetHandler

func (dc *DiscordCommad) SetHandler(handler Handler) CommandBuilder

func (*DiscordCommad) SetOptions

func (dc *DiscordCommad) SetOptions(opts DiscordCommandOptions) CommandBuilder

type DiscordCommandOptions

type DiscordCommandOptions struct {
	KeepExistingPermissions bool
}

type Handler

type Handler interface {
	Respond(s *discordgo.Session, i *discordgo.InteractionCreate, opts AppCmdOptions)
}

func AckMiddleware

func AckMiddleware(next Handler) Handler

type HandlerFunc

type HandlerFunc func(s *discordgo.Session, i *discordgo.InteractionCreate, opts AppCmdOptions)

func (HandlerFunc) Respond

func (f HandlerFunc) Respond(s *discordgo.Session, i *discordgo.InteractionCreate, opts AppCmdOptions)

type MiddlewareFunc

type MiddlewareFunc func(Handler) Handler

func (MiddlewareFunc) Middleware

func (mw MiddlewareFunc) Middleware(handler Handler) Handler