command

Documentation

Index

• func RegisterCommands(registerFunc Register, addTestCommands bool) error
• type Register
• type Runner
  • func NewCommandRunner(ctx *plugin.Context, args *model.CommandArgs, api *pluginapi.Client, ...) *Runner
  • func (r *Runner) Execute() error

Functions

func RegisterCommands

func RegisterCommands(registerFunc Register, addTestCommands bool) error

RegisterCommands should be called by the plugin to register all necessary commands

Types

type Register

type Register func(*model.Command) error

Register is a function that allows the runner to register commands with the mattermost server.

type Runner

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

Runner handles commands.

func NewCommandRunner

func NewCommandRunner(ctx *plugin.Context,
	args *model.CommandArgs,
	api *pluginapi.Client,
	logger bot.Logger,
	poster bot.Poster,
	ps app.PruneService,
) *Runner

NewCommandRunner creates a command runner.

func (*Runner) Execute

func (r *Runner) Execute() error

Execute should be called by the plugin when a command invocation is received from the Mattermost server.