pluginapi

Documentation

Index

• type API
  • func New(api plugin.API) *API
  • func (a *API) CleanKVStore() error
  • func (a *API) GetMattermostUser(mattermostUserID string) (*model.User, error)
  • func (a *API) GetMattermostUserByUsername(mattermostUsername string) (*model.User, error)
  • func (a *API) GetMattermostUserStatus(mattermostUserID string) (*model.Status, error)
  • func (a *API) GetMattermostUserStatusesByIds(mattermostUserIDs []string) ([]*model.Status, error)
  • func (a *API) GetPost(postID string) (*model.Post, error)
  • func (a *API) IsSysAdmin(mattermostUserID string) (bool, error)
  • func (a *API) SendEphemeralPost(channelID, mattermostUserID, message string)
  • func (a *API) UpdateMattermostUserStatus(mattermostUserID, status string) (*model.Status, error)

Types

type API

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

func New

func New(api plugin.API) *API

func (*API) CleanKVStore

func (a *API) CleanKVStore() error

func (*API) GetMattermostUser

func (a *API) GetMattermostUser(mattermostUserID string) (*model.User, error)

func (*API) GetMattermostUserByUsername

func (a *API) GetMattermostUserByUsername(mattermostUsername string) (*model.User, error)

func (*API) GetMattermostUserStatus

func (a *API) GetMattermostUserStatus(mattermostUserID string) (*model.Status, error)

func (*API) GetMattermostUserStatusesByIds

func (a *API) GetMattermostUserStatusesByIds(mattermostUserIDs []string) ([]*model.Status, error)

func (*API) GetPost

func (a *API) GetPost(postID string) (*model.Post, error)

func (*API) IsSysAdmin

func (a *API) IsSysAdmin(mattermostUserID string) (bool, error)

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

func (*API) SendEphemeralPost

func (a *API) SendEphemeralPost(channelID, mattermostUserID, message string)

func (*API) UpdateMattermostUserStatus

func (a *API) UpdateMattermostUserStatus(mattermostUserID, status string) (*model.Status, error)