mmbot

package module

Go to main page

Versions in this module

v0

v0.1.2

Jun 7, 2026

Changes in this version

type CommandInfo

+ MentionRequired bool

type CommandOption

+ func RequireMention() CommandOption

v0.1.1

Jun 7, 2026

Changes in this version

type Config

+ WebSocketURL string

v0.1.0

Jun 7, 2026

Changes in this version

+ var ErrAlreadyRun = errors.New("mmbot: bot has already been run")

+ var ErrHandlerQueueFull = errors.New("mmbot: handler queue is full")

+ var ErrInvalidCommandSyntax = errors.New("mmbot: invalid command syntax")

+ var ErrRoutesFrozen = errors.New("mmbot: routes cannot be changed after Run")

+ var ErrShutdownTimeout = errors.New("mmbot: shutdown timeout")

+ var ErrUnauthorized = errors.New("mmbot: unauthorized")

+ type Bot struct

+ func New(config Config, options ...Option) (*Bot, error)

+ func (b *Bot) Commands() []CommandInfo

+ func (b *Bot) HandleCommand(name string, handler Handler, options ...CommandOption) error

+ func (b *Bot) HandleMention(handler Handler, options ...RouteOption) error

+ func (b *Bot) HandleMessage(handler Handler, options ...RouteOption) error

+ func (b *Bot) Help() string

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

+ func (b *Bot) Use(middleware ...Middleware) error

+ type Client interface

+ CreatePost func(context.Context, Post) (*Post, error)

+ Mattermost func() *model.Client4

+ User func(context.Context, string) (*User, error)

+ type CommandInfo struct

+ Aliases []string

+ Description string

+ Hidden bool

+ Name string

+ Usage string

+ type CommandOption interface

+ func Aliases(values ...string) CommandOption

+ func CommandGuards(values ...Guard) CommandOption

+ func CommandMiddleware(values ...Middleware) CommandOption

+ func Description(value string) CommandOption

+ func Hidden() CommandOption

+ func Usage(value string) CommandOption

+ type CommandParseError struct

+ Offset int

+ Reason string

+ func (e *CommandParseError) Error() string

+ func (e *CommandParseError) Unwrap() error

+ type CommandParseErrorHandler func(*Context, *CommandParseError) error

+ type Config struct

+ ChannelIDs []string

+ HandlerConcurrency int

+ HandlerQueueSize int

+ Prefix string

+ QueuePolicy QueuePolicy

+ ReconnectMax time.Duration

+ ReconnectMin time.Duration

+ ServerURL string

+ ShutdownTimeout time.Duration

+ TeamIDs []string

+ Token string

+ type Context struct

+ func NewContext(ctx context.Context, client Client, input ContextInput) *Context

+ func (c *Context) Args() []string

+ func (c *Context) Client() Client

+ func (c *Context) Command() string

+ func (c *Context) Context() context.Context

+ func (c *Context) Message() Message

+ func (c *Context) Post(text string) error

+ func (c *Context) RawArgs() string

+ func (c *Context) Reply(text string) error

+ func (c *Context) Replyf(format string, args ...any) error

+ type ContextInput struct

+ Args []string

+ Command string

+ Message Message

+ RawArgs string

+ type ErrorHandler func(*Context, error)

+ type Guard func(*Context) error

+ func AllGuards(guards ...Guard) Guard

+ func AllowChannelIDs(ids ...string) Guard

+ func AllowTeamIDs(ids ...string) Guard

+ func AllowUserIDs(ids ...string) Guard

+ func AllowUsernames(names ...string) Guard

+ func AnyGuard(guards ...Guard) Guard

+ type Handler func(*Context) error

+ type Message struct

+ ChannelID string

+ CreateAt time.Time

+ ID string

+ RootID string

+ TeamID string

+ Text string

+ UserID string

+ Username string

+ type Middleware func(Handler) Handler

+ func Logger(logger *slog.Logger) Middleware

+ type Option interface

+ func WithCommandParseErrorHandler(handler CommandParseErrorHandler) Option

+ func WithErrorHandler(handler ErrorHandler) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithOverflowHandler(handler OverflowHandler) Option

+ func WithUnauthorizedHandler(handler UnauthorizedHandler) Option

+ func WithUnknownCommandHandler(handler Handler) Option

+ type OverflowHandler func(*Context, error)

+ type Post struct

+ ChannelID string

+ CreateAt time.Time

+ ID string

+ Message string

+ RootID string

+ UserID string

+ type QueuePolicy uint8

+ const QueuePolicyBlock

+ const QueuePolicyDropNewest

+ type RouteOption interface

+ func RouteGuards(values ...Guard) RouteOption

+ func RouteMiddleware(values ...Middleware) RouteOption

+ type UnauthorizedHandler func(*Context, error) error

+ type User struct

+ Email string

+ FirstName string

+ ID string

+ IsBot bool

+ LastName string

+ Nickname string

+ Username string

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