router

package module

Go to main page

Versions in this module

v0

v0.2.0

Jun 23, 2022

Changes in this version

type Command

+ DefaultPermissions *permissions.PermissionBit

+ UseInDMs *bool

type CommandBuilder

+ DefaultPermissions func(permissions.PermissionBit) CommandBuilder

+ GuildCommand func() CommandBuilder

type CommandGroup

+ DefaultPermissions *permissions.PermissionBit

+ UseInDMs *bool

+ type CommandGroupOptions struct

+ DefaultPermissions permissions.PermissionBit

+ UseInDMs bool

type MessageCommandBuilder

+ DefaultPermissions func(permissions.PermissionBit) MessageCommandBuilder

+ GuildCommand func() MessageCommandBuilder

type MiddlewareCtx

+ func (c MiddlewareCtx) AddComponentRow(row []*objects.Component) T

+ func (c MiddlewareCtx) AddEmbed(embed *objects.Embed) T

+ func (c MiddlewareCtx) AttachBytes(data []byte, filename, description string) T

+ func (c MiddlewareCtx) AttachFile(file *objects.DiscordFile) T

+ func (c MiddlewareCtx) ChannelMessageWithSource() T

+ func (c MiddlewareCtx) ClearComponents() T

+ func (c MiddlewareCtx) Ephemeral() T

+ func (c MiddlewareCtx) SetAllowedMentions(config *objects.AllowedMentions) T

+ func (c MiddlewareCtx) SetComponentRows(rows [][]*objects.Component) T

+ func (c MiddlewareCtx) SetContent(content string) T

+ func (c MiddlewareCtx) SetContentf(content string, args ...any) T

+ func (c MiddlewareCtx) SetEmbed(embed *objects.Embed) T

+ func (c MiddlewareCtx) SetTTS(tts bool) T

+ type Resolvable interface

+ MarshalJSON func() ([]byte, error)

+ RawData func() *objects.ApplicationCommandInteractionData

+ Resolve func() *T

+ Snowflake func() objects.Snowflake

+ String func() string

type ResolvableMentionable

+ RawData func() *objects.ApplicationCommandInteractionData

type TextCommandBuilder

+ DefaultPermissions func(permissions.PermissionBit) TextCommandBuilder

+ GuildCommand func() TextCommandBuilder

type UserCommandBuilder

+ DefaultPermissions func(permissions.PermissionBit) UserCommandBuilder

+ GuildCommand func() UserCommandBuilder

v0.1.4

Feb 9, 2022

Changes in this version

+ var ModalPathNotFound = errors.New("modal path not found")

+ var MultipleModalResponses = errors.New("multiple modal responses")

+ var UnknownContextType = errors.New("unknown context type")

+ var UnsetModalRouter = errors.New("modal router is unset")

type CommandRouterCtx

+ func (c *CommandRouterCtx) WithModalPath(path string) error

type ComponentRouterCtx

+ func (c *ComponentRouterCtx) WithModalPath(path string) error

type HandlerAccepter

+ ModalHandler func(handler interactions.HandlerFunc)

type LoaderBuilder

+ ModalRouter func(*ModalRouter) LoaderBuilder

+ type ModalContent struct

+ Contents func(*ModalGenerationCtx) (name string, contents []ModalContentItem)

+ Function func(*ModalRouterCtx) error

+ Path string

+ type ModalContentItem struct

+ Key string

+ Label string

+ MaxLength uint

+ MinLength uint

+ Placeholder string

+ Required bool

+ Short bool

+ Value string

+ type ModalGenerationCtx struct

+ Path string

+ type ModalRouter struct

+ func (f *ModalRouter) AddModal(modal *ModalContent)

+ func (f *ModalRouter) SendModalResponse(ctx ResponseDataBuilder, path string) error

+ type ModalRouterCtx struct

+ Context context.Context

+ ModalItems map[string]string

+ Params map[string]string

+ RESTClient rest.RESTClient

+ func (c *ModalRouterCtx) AddComponentRow(row []*objects.Component) *ModalRouterCtx

+ func (c *ModalRouterCtx) AddEmbed(embed *objects.Embed) *ModalRouterCtx

+ func (c *ModalRouterCtx) AttachBytes(data []byte, filename, description string) *ModalRouterCtx

+ func (c *ModalRouterCtx) AttachFile(file *objects.DiscordFile) *ModalRouterCtx

+ func (c *ModalRouterCtx) ChannelMessageWithSource() *ModalRouterCtx

+ func (c *ModalRouterCtx) ClearComponents() *ModalRouterCtx

+ func (c *ModalRouterCtx) DeferredChannelMessageWithSource(f func(*ModalRouterCtx) error)

+ func (c *ModalRouterCtx) Ephemeral() *ModalRouterCtx

+ func (c *ModalRouterCtx) SetAllowedMentions(config *objects.AllowedMentions) *ModalRouterCtx

+ func (c *ModalRouterCtx) SetComponentRows(rows [][]*objects.Component) *ModalRouterCtx

+ func (c *ModalRouterCtx) SetContent(content string) *ModalRouterCtx

+ func (c *ModalRouterCtx) SetContentf(content string, args ...interface{}) *ModalRouterCtx

+ func (c *ModalRouterCtx) SetEmbed(embed *objects.Embed) *ModalRouterCtx

+ func (c *ModalRouterCtx) SetTTS(tts bool) *ModalRouterCtx

+ func (c *ModalRouterCtx) UpdateLater(f func(*ModalRouterCtx) error) *ModalRouterCtx

+ func (g *ModalRouterCtx) VoidCustomID() string

+ func (r *ModalRouterCtx) ResponseData() *objects.InteractionApplicationCommandCallbackData

+ type ResolvableAttachment struct

+ func (r ResolvableAttachment) MarshalJSON() ([]byte, error)

+ func (r ResolvableAttachment) Resolve() *objects.Attachment

+ func (r ResolvableAttachment) Snowflake() objects.Snowflake

+ func (r ResolvableAttachment) String() string

+ type ResponseDataBuilder interface

+ ResponseData func() *objects.InteractionApplicationCommandCallbackData

v0.1.3

Feb 9, 2022

Changes in this version

type CommandRouterCtx

+ func (c *CommandRouterCtx) AttachBytes(data []byte, filename, description string) *CommandRouterCtx

+ func (c *CommandRouterCtx) AttachFile(file *objects.DiscordFile) *CommandRouterCtx

type ComponentRouterCtx

+ func (c *ComponentRouterCtx) AttachBytes(data []byte, filename, description string) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) AttachFile(file *objects.DiscordFile) *ComponentRouterCtx

v0.1.0

Feb 8, 2022

Changes in this version

+ func TestAutocomplete(t TestingT, b LoaderBuilder, commandRoute ...string)

+ func TestCommand(t TestingT, b LoaderBuilder, commandRoute ...string)

+ func TestComponent(t TestingT, b LoaderBuilder, path string)

type CommandRouterCtx

+ Context context.Context

+ func (c *CommandRouterCtx) SetContentf(content string, args ...interface{}) *CommandRouterCtx

type ComponentRouterCtx

+ Context context.Context

+ func (c *ComponentRouterCtx) SetContentf(content string, args ...interface{}) *ComponentRouterCtx

+ type ErrorHandler = func(error) *objects.InteractionResponse

type LoaderBuilder

+ CurrentChain func() (componentRouter *ComponentRouter, commandRouter *CommandRouter, ...)

+ type TestingT interface

+ Fatal func(args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Helper func()

+ Log func(args ...interface{})

v0.0.4

Oct 30, 2021

v0.0.3

Oct 2, 2021

v0.0.2

Sep 25, 2021

Changes in this version

+ var NoAutoCompleteFunc = errors.New("discord sent auto-complete for argument without auto-complete function")

+ type DoubleAutoCompleteFunc = func(*CommandRouterCtx) ([]DoubleChoice, error)

+ type DoubleChoiceBuilder = func(addStaticOptions func([]DoubleChoice), ...)

+ func DoubleAutoCompleteFuncBuilder(f DoubleAutoCompleteFunc) DoubleChoiceBuilder

+ func DoubleStaticChoicesBuilder(choices []DoubleChoice) DoubleChoiceBuilder

type HandlerAccepter

+ AutocompleteHandler func(handler interactions.HandlerFunc)

+ type IntAutoCompleteFunc = func(*CommandRouterCtx) ([]IntChoice, error)

+ type IntChoiceBuilder = func(addStaticOptions func([]IntChoice), addAutocomplete func(IntAutoCompleteFunc))

+ func IntAutoCompleteFuncBuilder(f IntAutoCompleteFunc) IntChoiceBuilder

+ func IntStaticChoicesBuilder(choices []IntChoice) IntChoiceBuilder

+ type StringAutoCompleteFunc = func(*CommandRouterCtx) ([]StringChoice, error)

+ type StringChoiceBuilder = func(addStaticOptions func([]StringChoice), ...)

+ func StringAutoCompleteFuncBuilder(f StringAutoCompleteFunc) StringChoiceBuilder

+ func StringStaticChoicesBuilder(choices []StringChoice) StringChoiceBuilder

v0.0.1

Sep 4, 2021

Changes in this version

+ var CommandDoesNotExist = errors.New("the command does not exist")

+ var CommandIsNotSubcommand = errors.New("expected *Command, found *CommandGroup")

+ var CommandIsSubcommand = errors.New("expected *CommandGroup, found *Command")

+ var GroupDoesNotExist = errors.New("the group does not exist")

+ var GroupNestedTooDeep = errors.New("sub-command group would be nested too deep")

+ var InvalidTarget = errors.New("wrong or no target specified")

+ var MiddlewareChainExhausted = errors.New("the middleware chain has been exhausted")

+ var MismatchedOption = errors.New("mismatched interaction option")

+ var NoCommandResponse = errors.New("expected data for command response")

+ var NonExistentOption = errors.New("interaction option doesn't exist on command")

+ var NotButton = errors.New("the data returned is not that of a button")

+ var NotSelectionMenu = errors.New("the data returned is not that of a selection menu")

+ type ButtonFunc func(ctx *ComponentRouterCtx) error

+ type CombinedRouter struct

+ type Command struct

+ AllowedMentions *objects.AllowedMentions

+ DefaultPermission bool

+ Description string

+ Function func(*CommandRouterCtx) error

+ Name string

+ Options []*objects.ApplicationCommandOption

+ func (c *Command) Groups() []*CommandGroup

+ type CommandBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) CommandBuilder

+ Build func() (*Command, error)

+ DefaultPermission func() CommandBuilder

+ Description func(string) CommandBuilder

+ Handler func(func(*CommandRouterCtx) error) CommandBuilder

+ MessageCommand func() MessageCommandBuilder

+ MustBuild func() *Command

+ TextCommand func() TextCommandBuilder

+ UserCommand func() UserCommandBuilder

+ type CommandGroup struct

+ AllowedMentions *objects.AllowedMentions

+ DefaultPermission bool

+ Description string

+ Middleware []MiddlewareFunc

+ Subcommands map[string]interface{}

+ func (c *CommandGroup) MustNewCommandGroup(name, description string, defaultPermission bool) *CommandGroup

+ func (c *CommandGroup) NewCommandBuilder(name string) SubCommandBuilder

+ func (c *CommandGroup) NewCommandGroup(name, description string, defaultPermission bool) (*CommandGroup, error)

+ func (c *CommandGroup) UnmarshalJSON(b []byte) error

+ func (c *CommandGroup) Use(f MiddlewareFunc)

+ type CommandRouter struct

+ func (c *CommandRouter) FormulateDiscordCommands() []*objects.ApplicationCommand

+ func (c *CommandRouter) MarshalJSON() ([]byte, error)

+ func (c *CommandRouter) MustNewCommandGroup(name, description string, defaultPermission bool) *CommandGroup

+ func (c *CommandRouter) NewCommandBuilder(name string) CommandBuilder

+ func (c *CommandRouter) NewCommandGroup(name, description string, defaultPermission bool) (*CommandGroup, error)

+ func (c *CommandRouter) UnmarshalJSON(b []byte) error

+ func (c *CommandRouter) Use(f MiddlewareFunc)

+ type CommandRouterCtx struct

+ Command *Command

+ Options map[string]interface{}

+ RESTClient *rest.Client

+ func (c *CommandRouterCtx) AddComponentRow(row []*objects.Component) *CommandRouterCtx

+ func (c *CommandRouterCtx) AddEmbed(embed *objects.Embed) *CommandRouterCtx

+ func (c *CommandRouterCtx) Bind(data interface{}) error

+ func (c *CommandRouterCtx) ChannelMessageWithSource() *CommandRouterCtx

+ func (c *CommandRouterCtx) ClearComponents() *CommandRouterCtx

+ func (c *CommandRouterCtx) DeferredChannelMessageWithSource(f func(*CommandRouterCtx) error)

+ func (c *CommandRouterCtx) Ephemeral() *CommandRouterCtx

+ func (c *CommandRouterCtx) SetAllowedMentions(config *objects.AllowedMentions) *CommandRouterCtx

+ func (c *CommandRouterCtx) SetComponentRows(rows [][]*objects.Component) *CommandRouterCtx

+ func (c *CommandRouterCtx) SetContent(content string) *CommandRouterCtx

+ func (c *CommandRouterCtx) SetEmbed(embed *objects.Embed) *CommandRouterCtx

+ func (c *CommandRouterCtx) SetTTS(tts bool) *CommandRouterCtx

+ func (c *CommandRouterCtx) TargetMember() *objects.GuildMember

+ func (c *CommandRouterCtx) TargetMessage() *objects.Message

+ func (c *CommandRouterCtx) UpdateLater(f func(*CommandRouterCtx) error) *CommandRouterCtx

+ func (g *CommandRouterCtx) VoidCustomID() string

+ func (r *CommandRouterCtx) ResponseData() *objects.InteractionApplicationCommandCallbackData

+ type ComponentRouter struct

+ func (c *ComponentRouter) RegisterButton(route string, cb ButtonFunc)

+ func (c *ComponentRouter) RegisterSelectMenu(route string, cb SelectMenuFunc)

+ type ComponentRouterCtx struct

+ Params map[string]string

+ RESTClient *rest.Client

+ func (c *ComponentRouterCtx) AddComponentRow(row []*objects.Component) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) AddEmbed(embed *objects.Embed) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) ChannelMessageWithSource() *ComponentRouterCtx

+ func (c *ComponentRouterCtx) ClearComponents() *ComponentRouterCtx

+ func (c *ComponentRouterCtx) DeferredChannelMessageWithSource(f func(*ComponentRouterCtx) error)

+ func (c *ComponentRouterCtx) DeferredMessageUpdate() *ComponentRouterCtx

+ func (c *ComponentRouterCtx) Ephemeral() *ComponentRouterCtx

+ func (c *ComponentRouterCtx) SetAllowedMentions(config *objects.AllowedMentions) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) SetComponentRows(rows [][]*objects.Component) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) SetContent(content string) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) SetEmbed(embed *objects.Embed) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) SetTTS(tts bool) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) UpdateLater(f func(*ComponentRouterCtx) error) *ComponentRouterCtx

+ func (c *ComponentRouterCtx) UpdateMessage() *ComponentRouterCtx

+ func (g *ComponentRouterCtx) VoidCustomID() string

+ func (r *ComponentRouterCtx) ResponseData() *objects.InteractionApplicationCommandCallbackData

+ type DoubleChoice struct

+ Name string

+ Value float64

+ type HandlerAccepter interface

+ CommandHandler func(handler interactions.HandlerFunc)

+ ComponentHandler func(handler interactions.HandlerFunc)

+ Rest func() *rest.Client

+ type IntChoice struct

+ Name string

+ Value int

+ type LoaderBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) LoaderBuilder

+ Build func(app HandlerAccepter)

+ CombinedRouter func(router *CombinedRouter) LoaderBuilder

+ CommandRouter func(*CommandRouter) LoaderBuilder

+ ComponentRouter func(*ComponentRouter) LoaderBuilder

+ ErrorHandler func(func(error) *objects.InteractionResponse) LoaderBuilder

+ func RouterLoader() LoaderBuilder

+ type MessageCommandBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) MessageCommandBuilder

+ Build func() (*Command, error)

+ DefaultPermission func() MessageCommandBuilder

+ Handler func(func(*CommandRouterCtx, *objects.Message) error) MessageCommandBuilder

+ MustBuild func() *Command

+ type MiddlewareCtx struct

+ func (g MiddlewareCtx) VoidCustomID() string

+ func (m MiddlewareCtx) Next() error

+ func (r MiddlewareCtx) ResponseData() *objects.InteractionApplicationCommandCallbackData

+ type MiddlewareFunc func(ctx MiddlewareCtx) error

+ type ResolvableChannel struct

+ func (r ResolvableChannel) MarshalJSON() ([]byte, error)

+ func (r ResolvableChannel) Resolve() *objects.Channel

+ func (r ResolvableChannel) Snowflake() objects.Snowflake

+ func (r ResolvableChannel) String() string

+ type ResolvableMentionable struct

+ func (r ResolvableMentionable) MarshalJSON() ([]byte, error)

+ func (r ResolvableMentionable) Resolve() interface{}

+ func (r ResolvableMentionable) Snowflake() objects.Snowflake

+ func (r ResolvableMentionable) String() string

+ type ResolvableMessage struct

+ func (r ResolvableMessage) MarshalJSON() ([]byte, error)

+ func (r ResolvableMessage) Resolve() *objects.Message

+ func (r ResolvableMessage) Snowflake() objects.Snowflake

+ func (r ResolvableMessage) String() string

+ type ResolvableRole struct

+ func (r ResolvableRole) MarshalJSON() ([]byte, error)

+ func (r ResolvableRole) Resolve() *objects.Role

+ func (r ResolvableRole) Snowflake() objects.Snowflake

+ func (r ResolvableRole) String() string

+ type ResolvableUser struct

+ func (r ResolvableUser) MarshalJSON() ([]byte, error)

+ func (r ResolvableUser) Resolve() *objects.User

+ func (r ResolvableUser) ResolveMember() *objects.GuildMember

+ func (r ResolvableUser) Snowflake() objects.Snowflake

+ func (r ResolvableUser) String() string

+ type SelectMenuFunc func(ctx *ComponentRouterCtx, values []string) error

+ type StringChoice struct

+ Name string

+ Value string

+ type SubCommandBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) SubCommandBuilder

+ Build func() (*Command, error)

+ Description func(string) SubCommandBuilder

+ Handler func(func(*CommandRouterCtx) error) SubCommandBuilder

+ MustBuild func() *Command

+ type TextCommandBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) TextCommandBuilder

+ Build func() (*Command, error)

+ DefaultPermission func() TextCommandBuilder

+ Description func(string) TextCommandBuilder

+ Handler func(func(*CommandRouterCtx) error) TextCommandBuilder

+ MustBuild func() *Command

+ type UserCommandBuilder interface

+ AllowedMentions func(*objects.AllowedMentions) UserCommandBuilder

+ Build func() (*Command, error)

+ DefaultPermission func() UserCommandBuilder

+ Handler func(func(*CommandRouterCtx, *objects.GuildMember) error) UserCommandBuilder

+ MustBuild func() *Command

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