bot

Documentation

Index

• type Admin
• type Bot
  • func GetBot(api plugin.API, botUserID string) Bot
• type BotConfig
• type LogContext
• type Logger
• type NilLogger
  • func (l *NilLogger) Debugf(format string, args ...interface{})
  • func (l *NilLogger) Errorf(format string, args ...interface{})
  • func (l *NilLogger) Infof(format string, args ...interface{})
  • func (l *NilLogger) Warnf(format string, args ...interface{})
  • func (l *NilLogger) With(logContext LogContext) Logger
• type Poster

Types

type Admin

type Admin interface {
	IsUserAdmin(mattermostUserID string) bool
}

type Bot

type Bot interface {
	Poster
	Logger
	Admin

	WithConfig(BotConfig) Bot
}

func GetBot

func GetBot(api plugin.API, botUserID string) Bot

GetBot creates a new bot API instance.

type BotConfig

type BotConfig struct {
	// AdminUserIDs contains a comma-separated list of user IDs that are allowed
	// to administer plugin functions, even if not Mattermost sysadmins.
	AdminUserIDs string

	// AdminLogLevel is "debug", "info", "warn", or "error".
	AdminLogLevel string

	// AdminLogVerbose: set to include full context with admin log messages.
	AdminLogVerbose bool
}

type LogContext

type LogContext map[string]interface{}

type Logger

type Logger interface {
	With(LogContext) Logger
	Debugf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warnf(format string, args ...interface{})
}

type NilLogger

type NilLogger struct{}

func (*NilLogger) Debugf

func (l *NilLogger) Debugf(format string, args ...interface{})

func (*NilLogger) Errorf

func (l *NilLogger) Errorf(format string, args ...interface{})

func (*NilLogger) Infof

func (l *NilLogger) Infof(format string, args ...interface{})

func (*NilLogger) Warnf

func (l *NilLogger) Warnf(format string, args ...interface{})

func (*NilLogger) With

func (l *NilLogger) With(logContext LogContext) Logger

type Poster

type Poster interface {
	// DM posts a simple Direct Message to the specified user
	DM(userID, format string, args ...interface{}) error

	// DMWithAttachments posts a Direct Message that contains Slack attachments.
	// Often used to include post actions.
	DMWithAttachments(userID string, attachments ...*model.SlackAttachment) error

	// Ephemeral sends an ephemeral message to a user
	Ephemeral(userID, channelID, format string, args ...interface{})
}