banter

package module

Go to main page

Versions in this module

v0

v0.1.13

May 22, 2026

v0.1.12

May 21, 2026

v0.1.11

May 21, 2026

Changes in this version

type BotOpts

+ DisableReconnect bool

v0.1.10

May 21, 2026

Changes in this version

type SendFileOpts

+ Embed *Embed

v0.1.9

May 21, 2026

Changes in this version

type Bot

+ func (b *Bot) AutoNotFoundReply()

type CommandNotFound

+ Message *Message

+ Name string

type Embed

+ func DefaultNotFoundEmbed(name, prefix string) *Embed

v0.1.8

May 21, 2026

Changes in this version

+ var ErrBotAlreadyRunning = errors.New("banter: bot already running")

+ var ErrBotNotRunning = errors.New(...)

+ var ErrDownloadNilAttachment = errors.New("banter: DownloadAttachment called with nil attachment")

+ var ErrSendFileNilFile = errors.New("banter: SendFile called with nil file")

v0.1.7

May 21, 2026

v0.1.6

May 21, 2026

v0.1.5

May 21, 2026

Changes in this version

type Bot

+ func (b *Bot) Done() <-chan struct{}

v0.1.4

May 21, 2026

v0.1.3

May 20, 2026

Changes in this version

type Bot

+ func (b *Bot) DeleteCategory(ctx context.Context, categoryID string) error

+ func (b *Bot) DeleteChannel(ctx context.Context, channelID string) error

v0.1.2

May 20, 2026

Changes in this version

type Bot

+ func (b *Bot) DownloadAttachment(ctx context.Context, att *Attachment) (*File, error)

+ func (b *Bot) SendFile(ctx context.Context, channelID string, file *File, opts SendFileOpts) (*Message, error)

type Context

+ func (c *Context) ReplyFile(ctx context.Context, file *File, content string) error

+ type SendFileOpts struct

+ Content string

+ ReplyTo string

v0.1.1

May 20, 2026

Changes in this version

+ const ChannelTypeText

+ const ChannelTypeVoice

type Bot

+ func (b *Bot) EnsureCategory(ctx context.Context, guildID, name string) (*Category, error)

+ func (b *Bot) EnsureChannel(ctx context.Context, guildID, name string, opts ChannelOpts) (*Channel, error)

+ func (b *Bot) ListCategories(ctx context.Context, guildID string) ([]*Category, error)

+ type ChannelOpts struct

+ CategoryID string

+ Type string

v0.1.0

May 19, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultCommandPrefix

+ const DefaultGatewayPath

+ const DefaultHelpColorInt

+ const IntentBotEvents

+ const IntentDirectMessages

+ const IntentDirectReactions

+ const IntentDirectTyping

+ const IntentGuildMembers

+ const IntentGuildMessages

+ const IntentGuildModeration

+ const IntentGuildPresences

+ const IntentGuildReactions

+ const IntentGuildTyping

+ const IntentGuildVoiceStates

+ const IntentGuilds

+ const IntentMessageContent

+ const MsgCommandSyncDup

+ const MsgDupButtonHandler

+ const MsgDupPrefixCommand

+ const MsgDupSlashCommand

+ const MsgEmptyButtonID

+ const MsgSlashHandlerFailed

+ const OptionBoolean

+ const OptionChannel

+ const OptionInteger

+ const OptionRole

+ const OptionString

+ const OptionUser

+ const PermAdministrator

+ const PermAttachFiles

+ const PermBanMembers

+ const PermKickMembers

+ const PermManageChannels

+ const PermManageGuild

+ const PermManageMessages

+ const PermManageRoles

+ const PermMentionEveryone

+ const PermSendMessages

+ const PermUseSlashCommands

+ const PermViewChannels

+ const Version

+ var ErrContextDetached = errors.New("context detached from bot")

+ var ErrEveryoneNotFound = errors.New("@everyone role not found in guild")

+ var ErrFileNeedsFilename = errors.New("file constructors require a filename")

+ var ErrFollowupEmpty = errors.New("followup requires non-empty content or an embed")

+ var ErrHTTPRetriesExhausted = errors.New("http: exhausted retries without returning")

+ var ErrInteractionDetached = errors.New("interaction has no attached client")

+ var ErrInteractionHTTPMissing = errors.New("interaction has no attached HTTP client")

+ var ErrInteractionResponded = errors.New("interaction already responded to")

+ var ErrRespondEmpty = errors.New("respond requires non-empty content or an embed")

+ var ErrUpdateNotButton = errors.New(...)

+ var ErrUploadRetriesExhausted = errors.New("upload: exhausted retries")

+ var NoHelpCommand = &HelpCommand

+ func DescribePerms(bitmask int64) []string

+ func HasPerm(bitmask, required int64) bool

+ func IntentsAll() int64

+ func IntentsDefault() int64

+ func IntentsNone() int64

+ func PermsAll() int64

+ type Attachment struct

+ Filename string

+ ID string

+ Size int64

+ URL string

+ type BadArgument struct

+ Expected string

+ Name string

+ Value string

+ type BanterError struct

+ Msg string

+ func (e *BanterError) Error() string

+ type Bot struct

+ Guilds map[string]*Guild

+ HTTP *HTTPClient

+ SessionID string

+ User *User

+ func NewBot(opts BotOpts) *Bot

+ func (b *Bot) CreateCategory(ctx context.Context, guildID, name string) (*Category, error)

+ func (b *Bot) CreateChannel(ctx context.Context, guildID, name string) (*Channel, error)

+ func (b *Bot) EveryoneRole(ctx context.Context, guildID string) (*Role, error)

+ func (b *Bot) GetChannel(ctx context.Context, channelID string) (*Channel, error)

+ func (b *Bot) GetGuild(ctx context.Context, guildID string) (*Guild, error)

+ func (b *Bot) ListChannels(ctx context.Context, guildID string) ([]*Channel, error)

+ func (b *Bot) OnButton(customID string, handler ButtonHandler)

+ func (b *Bot) OnError(h ErrorHandler)

+ func (b *Bot) OnMemberJoin(h MemberJoinHandler)

+ func (b *Bot) OnMessage(h MessageHandler)

+ func (b *Bot) OnMessageDelete(h MessageDeleteHandler)

+ func (b *Bot) OnMessageEdit(h MessageEditHandler)

+ func (b *Bot) OnReactionAdd(h ReactionAddHandler)

+ func (b *Bot) OnReactionRemove(h ReactionRemoveHandler)

+ func (b *Bot) OnReady(h ReadyHandler)

+ func (b *Bot) OnResumed(h ResumedHandler)

+ func (b *Bot) PrefixCommand(name, help, category string, handler PrefixHandler, aliases ...string)

+ func (b *Bot) Run(ctx context.Context, token string) error

+ func (b *Bot) SendEmbed(ctx context.Context, channelID string, embed *Embed) (*Message, error)

+ func (b *Bot) SendMessage(ctx context.Context, channelID, content string) (*Message, error)

+ func (b *Bot) SlashCommand(name, description string, options []SlashOption, handler SlashHandler)

+ type BotOpts struct

+ ApplicationID string

+ BaseURL string

+ CommandPrefix string

+ Debug bool

+ HelpColor int

+ HelpCommand *HelpCommand

+ Intents int64

+ Reconnect bool

+ WSURL string

+ type BuildEmbedFn func(items []any, page, total int) *Embed

+ type ButtonHandler func(ctx context.Context, i *Interaction) error

+ type ButtonOpts struct

+ CustomID string

+ Disabled bool

+ Emoji string

+ Style string

+ URL string

+ type Category struct

+ GuildID string

+ ID string

+ Name string

+ Position int

+ type Channel struct

+ CategoryID string

+ Description string

+ GuildID string

+ ID string

+ Name string

+ Position int

+ Type string

+ type CommandError struct

+ Msg string

+ func (e *CommandError) Error() string

+ type CommandNotFound struct

+ type Context struct

+ Bot *Bot

+ Message *Message

+ Name string

+ RawArgs string

+ func (c *Context) Reply(ctx context.Context, content string) error

+ func (c *Context) ReplyEmbed(ctx context.Context, embed *Embed) error

+ type CreateCategoryBody struct

+ Name string

+ PermissionOverrides []PermissionOverride

+ type CreateChannelBody struct

+ CategoryID string

+ Description string

+ Name string

+ PermissionOverrides []PermissionOverride

+ Type string

+ type CreateRoleBody struct

+ Color string

+ Deny int64

+ Description string

+ Mentionable bool

+ Name string

+ Permissions int64

+ Position int

+ type Dispatcher func(ctx context.Context, eventType string, payload json.RawMessage)

+ type DuplicateCommand struct

+ HTTPExc *HTTPException

+ Name string

+ Source string

+ type EditCategoryPatch struct

+ Name *string

+ Position *int

+ type EditChannelPatch struct

+ CategoryID *string

+ Description *string

+ Name *string

+ Position *int

+ type EditGuildPatch struct

+ Description *string

+ Name *string

+ WelcomeChannelID *string

+ type Embed struct

+ func NewEmbed() *Embed

+ func (e *Embed) AddButton(label string, opts ButtonOpts) *Embed

+ func (e *Embed) AddField(name, value string, inline bool) *Embed

+ func (e *Embed) Author(name, url, iconURL string) *Embed

+ func (e *Embed) ColorHex(s string) *Embed

+ func (e *Embed) ColorInt(c int) *Embed

+ func (e *Embed) Description(s string) *Embed

+ func (e *Embed) Footer(text, iconURL string) *Embed

+ func (e *Embed) Image(url string) *Embed

+ func (e *Embed) PendingComponents() []map[string]any

+ func (e *Embed) Thumbnail(url string) *Embed

+ func (e *Embed) Title(s string) *Embed

+ func (e *Embed) ToDict() map[string]any

+ func (e *Embed) URL(s string) *Embed

+ type ErrorHandler func(ctx context.Context, err error)

+ type FetchFn func() []any

+ type File struct

+ Data []byte

+ Filename string

+ func NewFileFromBytes(data []byte, filename string) (*File, error)

+ func NewFileFromPath(path string) (*File, error)

+ func NewFileFromReader(r io.Reader, filename string) (*File, error)

+ func (f *File) String() string

+ type Forbidden struct

+ type Gateway struct

+ func NewGateway(token string, intents int64, wsURL string, dispatcher Dispatcher) *Gateway

+ func (g *Gateway) Close() error

+ func (g *Gateway) CloseInfo() (int, string)

+ func (g *Gateway) Connect(ctx context.Context) error

+ func (g *Gateway) InvalidSession() bool

+ func (g *Gateway) LastSeq() int

+ func (g *Gateway) Run(ctx context.Context) error

+ func (g *Gateway) SetResume(sessionID string, seq int)

+ type GatewayError struct

+ type Guild struct

+ Description string

+ ID string

+ Name string

+ OwnerID string

+ WelcomeChannelID string

+ type HTTPClient struct

+ func NewHTTPClient(token, baseURL string) *HTTPClient

+ func (h *HTTPClient) AddReaction(ctx context.Context, channelID, messageID, emoji string) ([]byte, error)

+ func (h *HTTPClient) AddRole(ctx context.Context, guildID, userID, roleID string) ([]byte, error)

+ func (h *HTTPClient) BanMember(ctx context.Context, guildID, userID, reason string) ([]byte, error)

+ func (h *HTTPClient) Close() error

+ func (h *HTTPClient) CreateCategory(ctx context.Context, guildID string, body CreateCategoryBody) ([]byte, error)

+ func (h *HTTPClient) CreateChannel(ctx context.Context, guildID string, body CreateChannelBody) ([]byte, error)

+ func (h *HTTPClient) CreateRole(ctx context.Context, guildID string, body CreateRoleBody) ([]byte, error)

+ func (h *HTTPClient) DeleteCategory(ctx context.Context, categoryID string) ([]byte, error)

+ func (h *HTTPClient) DeleteChannel(ctx context.Context, channelID string) ([]byte, error)

+ func (h *HTTPClient) DeleteMessage(ctx context.Context, messageID string) ([]byte, error)

+ func (h *HTTPClient) DeleteRole(ctx context.Context, roleID string) ([]byte, error)

+ func (h *HTTPClient) DownloadAttachment(ctx context.Context, attachmentID string) ([]byte, error)

+ func (h *HTTPClient) EditCategory(ctx context.Context, categoryID string, patch EditCategoryPatch) ([]byte, error)

+ func (h *HTTPClient) EditChannel(ctx context.Context, channelID string, patch EditChannelPatch) ([]byte, error)

+ func (h *HTTPClient) EditGuild(ctx context.Context, guildID string, patch EditGuildPatch) ([]byte, error)

+ func (h *HTTPClient) EditMessage(ctx context.Context, messageID, content string) ([]byte, error)

+ func (h *HTTPClient) EditRole(ctx context.Context, roleID string, patch map[string]any) ([]byte, error)

+ func (h *HTTPClient) GetChannel(ctx context.Context, channelID string) ([]byte, error)

+ func (h *HTTPClient) GetGuild(ctx context.Context, guildID string) ([]byte, error)

+ func (h *HTTPClient) GetMember(ctx context.Context, guildID, userID string) ([]byte, error)

+ func (h *HTTPClient) GetRole(ctx context.Context, roleID string) ([]byte, error)

+ func (h *HTTPClient) GetUser(ctx context.Context, userID string) ([]byte, error)

+ func (h *HTTPClient) KickMember(ctx context.Context, guildID, userID string) ([]byte, error)

+ func (h *HTTPClient) ListCategories(ctx context.Context, guildID string) ([]byte, error)

+ func (h *HTTPClient) ListChannelMembers(ctx context.Context, channelID string, limit, offset int, search string) ([]byte, error)

+ func (h *HTTPClient) ListChannels(ctx context.Context, guildID string) ([]byte, error)

+ func (h *HTTPClient) ListCommands(ctx context.Context) ([]byte, error)

+ func (h *HTTPClient) ListGuildBans(ctx context.Context, guildID string) ([]byte, error)

+ func (h *HTTPClient) ListMessages(ctx context.Context, channelID, before string, limit int) ([]byte, error)

+ func (h *HTTPClient) ListRoles(ctx context.Context, guildID string) ([]byte, error)

+ func (h *HTTPClient) Me(ctx context.Context) ([]byte, error)

+ func (h *HTTPClient) PurgeChannel(ctx context.Context, channelID string, limit int) ([]byte, error)

+ func (h *HTTPClient) RegisterCommands(ctx context.Context, commands []map[string]any) ([]byte, error)

+ func (h *HTTPClient) RemoveReaction(ctx context.Context, channelID, messageID, emoji string) ([]byte, error)

+ func (h *HTTPClient) RemoveRole(ctx context.Context, guildID, userID, roleID string) ([]byte, error)

+ func (h *HTTPClient) ReorderCategories(ctx context.Context, guildID string, items []ReorderItem) ([]byte, error)

+ func (h *HTTPClient) ReorderChannels(ctx context.Context, guildID string, items []ReorderItem) ([]byte, error)

+ func (h *HTTPClient) Request(ctx context.Context, method, path string, body any, params map[string]string, ...) ([]byte, error)

+ func (h *HTTPClient) RespondInteraction(ctx context.Context, interactionID, token string, body map[string]any) error

+ func (h *HTTPClient) SendMessage(ctx context.Context, channelID string, body SendMessageBody) ([]byte, error)

+ func (h *HTTPClient) SetCategoryPermissions(ctx context.Context, categoryID, roleID string, allow, deny int64) ([]byte, error)

+ func (h *HTTPClient) SetChannelPermissions(ctx context.Context, channelID, roleID string, allow, deny int64) ([]byte, error)

+ func (h *HTTPClient) TriggerTyping(ctx context.Context, channelID string) ([]byte, error)

+ func (h *HTTPClient) UnbanMember(ctx context.Context, guildID, userID string) ([]byte, error)

+ func (h *HTTPClient) UploadAttachment(ctx context.Context, channelID string, f *File) ([]byte, error)

+ type HTTPException struct

+ Code int

+ Message string

+ Method string

+ Path string

+ Status int

+ type HelpCommand struct

+ func CustomHelpCommand(handler PrefixHandler) *HelpCommand

+ func DefaultHelpCommand() *HelpCommand

+ type Interaction struct

+ AppID string

+ ChannelID string

+ CommandName string

+ CustomID string

+ GuildID string

+ ID string

+ MessageID string

+ Options map[string]any

+ Token string

+ Type string

+ UserID string

+ func (i *Interaction) Defer(ctx context.Context, ephemeral bool) error

+ func (i *Interaction) Followup(ctx context.Context, content string, opts RespondOpts) error

+ func (i *Interaction) IsButton() bool

+ func (i *Interaction) IsSlash() bool

+ func (i *Interaction) OptBool(name string, fallback bool) bool

+ func (i *Interaction) OptInt(name string, fallback int) int

+ func (i *Interaction) OptString(name, fallback string) string

+ func (i *Interaction) Respond(ctx context.Context, content string, opts RespondOpts) error

+ func (i *Interaction) Update(ctx context.Context, content string, opts RespondOpts) error

+ type Logger struct

+ func NewLogger(name string) *Logger

+ func (l *Logger) Debug(format string, args ...any)

+ func (l *Logger) Error(format string, args ...any)

+ func (l *Logger) Info(format string, args ...any)

+ func (l *Logger) Panic(format string, args ...any)

+ func (l *Logger) Warn(format string, args ...any)

+ type LoginFailure struct

+ type Member struct

+ GuildID string

+ JoinedAt string

+ Nickname string

+ RoleIDs []string

+ UserID string

+ type MemberJoinHandler func(ctx context.Context, m *Member)

+ type Message struct

+ Attachments []Attachment

+ ChannelID string

+ Content string

+ CreatedAt string

+ EditedAt string

+ GuildID string

+ ID string

+ IsBot bool

+ ReplyTo string

+ UserID string

+ type MessageDeleteHandler func(ctx context.Context, payload json.RawMessage)

+ type MessageEditHandler func(ctx context.Context, payload json.RawMessage)

+ type MessageHandler func(ctx context.Context, m *Message)

+ type MissingArgument struct

+ Name string

+ type MissingPermissions struct

+ Missing []string

+ type NotFound struct

+ type Paginator struct

+ BuildEmbed BuildEmbedFn

+ EmptyMessage string

+ Fetch FetchFn

+ PerPage int

+ Prefix string

+ func NewPaginator(fetch FetchFn, perPage int, build BuildEmbedFn) *Paginator

+ func (p *Paginator) Respond(ctx context.Context, i *Interaction, page int, ephemeral bool) error

+ func (p *Paginator) Update(ctx context.Context, i *Interaction) error

+ type PermissionOverride struct

+ Allow int64

+ Deny int64

+ RoleID string

+ func AllowingOverride(roleID string, bits int64) PermissionOverride

+ func DenyingOverride(roleID string, bits int64) PermissionOverride

+ type PrefixHandler func(ctx context.Context, c *Context) error

+ type RateLimited struct

+ RetryAfter float64

+ type ReactionAddHandler func(ctx context.Context, payload json.RawMessage)

+ type ReactionRemoveHandler func(ctx context.Context, payload json.RawMessage)

+ type ReadyHandler func(ctx context.Context)

+ type ReorderItem struct

+ ID string

+ Position int

+ type RespondOpts struct

+ Components []map[string]any

+ Embed *Embed

+ Ephemeral bool

+ ReplyTo string

+ type ResumedHandler func(ctx context.Context)

+ type Role struct

+ Color string

+ ID string

+ Name string

+ Permissions int64

+ Position int

+ type SendMessageBody struct

+ AttachmentIDs []string

+ Components []map[string]any

+ Content string

+ Embed map[string]any

+ ReplyTo string

+ type SlashHandler func(ctx context.Context, i *Interaction) error

+ func HasPermissions(required int64, handler SlashHandler) SlashHandler

+ type SlashOption struct

+ Description string

+ Name string

+ Required bool

+ Type string

+ func NewSlashOption(name, optType string) SlashOption

+ func (o SlashOption) Describe(s string) SlashOption

+ func (o SlashOption) Optional() SlashOption

+ type User struct

+ AvatarID string

+ Bot bool

+ DisplayName string

+ ID string

+ Username string

+ func (u *User) UnmarshalJSON(data []byte) error

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