plugin

Documentation

Index

• type Plugin
  • func New(build *config.BuildConfig) *Plugin
  • func (p *Plugin) Clean() error
  • func (p *Plugin) ExecuteCommand(c *plugin.Context, args *model.CommandArgs) (*model.CommandResponse, *model.AppError)
  • func (p *Plugin) GetBotUserID() string
  • func (p *Plugin) GetConfig(ref interface{}) error
  • func (p *Plugin) GetMattermostConfig() *model.Config
  • func (p *Plugin) GetMattermostUser(mattermostUserID string) (*model.User, error)
  • func (p *Plugin) GetMattermostUserByUsername(mattermostUsername string) (*model.User, error)
  • func (p *Plugin) IsPluginAdmin(mattermostUserID string) (bool, error)
  • func (p *Plugin) OnActivate() error
  • func (p *Plugin) OnConfigurationChange() error
  • func (p *Plugin) SaveConfig(conf config.Mapper)
  • func (p *Plugin) SendEphemeralPost(channelID, userID, message string)
  • func (p *Plugin) ServeHTTP(pc *plugin.Context, w http.ResponseWriter, req *http.Request)

Types

type Plugin

type Plugin struct {
	plugin.MattermostPlugin
	// contains filtered or unexported fields
}

func New

func New(build *config.BuildConfig) *Plugin

func (*Plugin) Clean

func (p *Plugin) Clean() error

func (*Plugin) ExecuteCommand

func (p *Plugin) ExecuteCommand(c *plugin.Context, args *model.CommandArgs) (*model.CommandResponse, *model.AppError)

func (*Plugin) GetBotUserID

func (p *Plugin) GetBotUserID() string

func (*Plugin) GetConfig

func (p *Plugin) GetConfig(ref interface{}) error

func (*Plugin) GetMattermostConfig

func (p *Plugin) GetMattermostConfig() *model.Config

func (*Plugin) GetMattermostUser

func (p *Plugin) GetMattermostUser(mattermostUserID string) (*model.User, error)

func (*Plugin) GetMattermostUserByUsername

func (p *Plugin) GetMattermostUserByUsername(mattermostUsername string) (*model.User, error)

func (*Plugin) IsPluginAdmin

func (p *Plugin) IsPluginAdmin(mattermostUserID string) (bool, error)

IsPluginAdmin returns true if the user is authorized to use the plugin's admin-level APIs/commands.

func (*Plugin) OnActivate

func (p *Plugin) OnActivate() error

func (*Plugin) OnConfigurationChange

func (p *Plugin) OnConfigurationChange() error

func (*Plugin) SaveConfig

func (p *Plugin) SaveConfig(conf config.Mapper)

func (*Plugin) SendEphemeralPost

func (p *Plugin) SendEphemeralPost(channelID, userID, message string)

func (*Plugin) ServeHTTP

func (p *Plugin) ServeHTTP(pc *plugin.Context, w http.ResponseWriter, req *http.Request)