Documentation
¶
Index ¶
- Constants
- type MatterpollPlugin
- func (p *MatterpollPlugin) ConvertCreatorIDToDisplayName(creatorID string) (string, *model.AppError)
- func (p *MatterpollPlugin) ConvertUserIDToDisplayName(userID string) (string, *model.AppError)
- func (p *MatterpollPlugin) ExecuteCommand(c *plugin.Context, args *model.CommandArgs) (*model.CommandResponse, *model.AppError)
- func (p *MatterpollPlugin) HasPermission(poll *poll.Poll, issuerID string) (bool, *model.AppError)
- func (p *MatterpollPlugin) InitAPI() *mux.Router
- func (p *MatterpollPlugin) LocalizeDefaultMessage(l *i18n.Localizer, m *i18n.Message) string
- func (p *MatterpollPlugin) LocalizeWithConfig(l *i18n.Localizer, lc *i18n.LocalizeConfig) string
- func (p *MatterpollPlugin) OnActivate() error
- func (p *MatterpollPlugin) OnConfigurationChange() error
- func (p *MatterpollPlugin) OnDeactivate() error
- func (p *MatterpollPlugin) SendEphemeralPost(channelID, userID, message string)
- func (p *MatterpollPlugin) ServeHTTP(c *plugin.Context, w http.ResponseWriter, r *http.Request)
Constants ¶
const PluginId = "com.github.matterpoll.matterpoll"
const PluginVersion = "1.1.0"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MatterpollPlugin ¶
type MatterpollPlugin struct {
plugin.MattermostPlugin
Store store.Store
ServerConfig *model.Config
// contains filtered or unexported fields
}
MatterpollPlugin is the object to run the plugin
func (*MatterpollPlugin) ConvertCreatorIDToDisplayName ¶
func (p *MatterpollPlugin) ConvertCreatorIDToDisplayName(creatorID string) (string, *model.AppError)
ConvertCreatorIDToDisplayName returns the display name to a given user ID of a poll creator
func (*MatterpollPlugin) ConvertUserIDToDisplayName ¶
func (p *MatterpollPlugin) ConvertUserIDToDisplayName(userID string) (string, *model.AppError)
ConvertUserIDToDisplayName returns the display name to a given user ID
func (*MatterpollPlugin) ExecuteCommand ¶
func (p *MatterpollPlugin) ExecuteCommand(c *plugin.Context, args *model.CommandArgs) (*model.CommandResponse, *model.AppError)
ExecuteCommand parses a given input and creates a poll if the input is correct
func (*MatterpollPlugin) HasPermission ¶
HasPermission checks if a given user has the permission to end or delete a given poll
func (*MatterpollPlugin) InitAPI ¶
func (p *MatterpollPlugin) InitAPI() *mux.Router
InitAPI initializes the REST API
func (*MatterpollPlugin) LocalizeDefaultMessage ¶ added in v1.1.0
LocalizeDefaultMessage localizer the provided message
func (*MatterpollPlugin) LocalizeWithConfig ¶ added in v1.1.0
func (p *MatterpollPlugin) LocalizeWithConfig(l *i18n.Localizer, lc *i18n.LocalizeConfig) string
LocalizeWithConfig localizer the provided localize config
func (*MatterpollPlugin) OnActivate ¶
func (p *MatterpollPlugin) OnActivate() error
OnActivate ensures a configuration is set and initializes the API
func (*MatterpollPlugin) OnConfigurationChange ¶
func (p *MatterpollPlugin) OnConfigurationChange() error
OnConfigurationChange loads the plugin configuration, validates it and saves it.
func (*MatterpollPlugin) OnDeactivate ¶
func (p *MatterpollPlugin) OnDeactivate() error
OnDeactivate unregisters the command
func (*MatterpollPlugin) SendEphemeralPost ¶ added in v1.1.0
func (p *MatterpollPlugin) SendEphemeralPost(channelID, userID, message string)
func (*MatterpollPlugin) ServeHTTP ¶
func (p *MatterpollPlugin) ServeHTTP(c *plugin.Context, w http.ResponseWriter, r *http.Request)