plugin

package
v5.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 14, 2019 License: AGPL-3.0, Apache-2.0 Imports: 29 Imported by: 0

Documentation

Overview

The plugin package is used by Mattermost server plugins written in go. It also enables the Mattermost server to manage and interact with the running plugin environment.

Note that this package exports a large number of types prefixed with Z_. These are public only to allow their use with Hashicorp's go-plugin (and net/rpc). Do not use these directly.

Example (HelloWorld)

This example demonstrates a plugin that handles HTTP requests which respond by greeting the world. 

package main

import (
	"fmt"
	"net/http"

	"github.com/mattermost/mattermost-server/plugin"
)

type HelloWorldPlugin struct {
	plugin.MattermostPlugin
}

func (p *HelloWorldPlugin) ServeHTTP(c *plugin.Context, w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "Hello, world!")
}

// This example demonstrates a plugin that handles HTTP requests which respond by greeting the
// world.
func main() {
	plugin.ClientMain(&HelloWorldPlugin{})
}

Output:
Example (HelpPlugin) 
package main

import (
	"strings"
	"sync"

	"github.com/pkg/errors"

	"github.com/mattermost/mattermost-server/model"
	"github.com/mattermost/mattermost-server/plugin"
)

// configuration represents the configuration for this plugin as exposed via the Mattermost
// server configuration.
type configuration struct {
	TeamName    string
	ChannelName string

	// channelId is resolved when the public configuration fields above change
	channelId string
}

type HelpPlugin struct {
	plugin.MattermostPlugin

	// configurationLock synchronizes access to the configuration.
	configurationLock sync.RWMutex

	// configuration is the active plugin configuration. Consult getConfiguration and
	// setConfiguration for usage.
	configuration *configuration
}

// getConfiguration retrieves the active configuration under lock, making it safe to use
// concurrently. The active configuration may change underneath the client of this method, but
// the struct returned by this API call is considered immutable.
func (p *HelpPlugin) getConfiguration() *configuration {
	p.configurationLock.RLock()
	defer p.configurationLock.RUnlock()

	if p.configuration == nil {
		return &configuration{}
	}

	return p.configuration
}

// setConfiguration replaces the active configuration under lock.
//
// Do not call setConfiguration while holding the configurationLock, as sync.Mutex is not
// reentrant.
func (p *HelpPlugin) setConfiguration(configuration *configuration) {
	// Replace the active configuration under lock.
	p.configurationLock.Lock()
	defer p.configurationLock.Unlock()
	p.configuration = configuration
}

// OnConfigurationChange updates the active configuration for this plugin under lock.
func (p *HelpPlugin) OnConfigurationChange() error {
	var configuration = new(configuration)

	// Load the public configuration fields from the Mattermost server configuration.
	if err := p.API.LoadPluginConfiguration(configuration); err != nil {
		return errors.Wrap(err, "failed to load plugin configuration")
	}

	team, err := p.API.GetTeamByName(configuration.TeamName)
	if err != nil {
		return errors.Wrapf(err, "failed to find team %s", configuration.TeamName)
	}

	channel, err := p.API.GetChannelByName(configuration.ChannelName, team.Id, false)
	if err != nil {
		return errors.Wrapf(err, "failed to find channel %s", configuration.ChannelName)
	}

	configuration.channelId = channel.Id

	p.setConfiguration(configuration)

	return nil
}

func (p *HelpPlugin) MessageHasBeenPosted(c *plugin.Context, post *model.Post) {
	configuration := p.getConfiguration()

	// Ignore posts not in the configured channel
	if post.ChannelId != configuration.channelId {
		return
	}

	// Ignore posts this plugin made.
	if sentByPlugin, _ := post.Props["sent_by_plugin"].(bool); sentByPlugin {
		return
	}

	// Ignore posts without a plea for help.
	if !strings.Contains(post.Message, "help") {
		return
	}

	p.API.SendEphemeralPost(post.UserId, &model.Post{
		ChannelId: configuration.channelId,
		Message:   "You asked for help? Checkout https://about.mattermost.com/help/",
		Props: map[string]interface{}{
			"sent_by_plugin": true,
		},
	})
}

func main() {
	plugin.ClientMain(&HelpPlugin{})
}

Output:

Index

Examples

Constants

View Source 
const (
	OnActivateId            = 0
	OnDeactivateId          = 1
	ServeHTTPId             = 2
	OnConfigurationChangeId = 3
	ExecuteCommandId        = 4
	MessageWillBePostedId   = 5
	MessageWillBeUpdatedId  = 6
	MessageHasBeenPostedId  = 7
	MessageHasBeenUpdatedId = 8
	UserHasJoinedChannelId  = 9
	UserHasLeftChannelId    = 10
	UserHasJoinedTeamId     = 11
	UserHasLeftTeamId       = 12
	ChannelHasBeenCreatedId = 13
	FileWillBeUploadedId    = 14
	UserWillLogInId         = 15
	UserHasLoggedInId       = 16
	TotalHooksId            = iota
)

These assignments are part of the wire protocol used to trigger hook events in plugins.

Feel free to add more, but do not change existing assignments. Follow the naming convention of <HookName>Id as the autogenerated glue code depends on that.

View Source 
const (
	MinIdLength  = 3
	MaxIdLength  = 190
	ValidIdRegex = `^[a-zA-Z0-9-_\.]+$`
)

Variables

This section is empty.

Functions

func ClientMain added in v5.2.0 

func ClientMain(pluginImplementation interface{})

Starts the serving of a Mattermost plugin over net/rpc. gRPC is not yet supported.

Call this when your plugin is ready to start.

func IsValidId 

func IsValidId(id string) bool

IsValidId verifies that the plugin id has a minimum length of 3, maximum length of 190, and contains only alphanumeric characters, dashes, underscores and periods.

These constraints are necessary since the plugin id is used as part of a filesystem path.

Types

type API 

type API interface {
	// LoadPluginConfiguration loads the plugin's configuration. dest should be a pointer to a
	// struct that the configuration JSON can be unmarshalled to.
	LoadPluginConfiguration(dest interface{}) error

	// RegisterCommand registers a custom slash command. When the command is triggered, your plugin
	// can fulfill it via the ExecuteCommand hook.
	RegisterCommand(command *model.Command) error

	// UnregisterCommand unregisters a command previously registered via RegisterCommand.
	UnregisterCommand(teamId, trigger string) error

	// GetSession returns the session object for the Session ID
	GetSession(sessionId string) (*model.Session, *model.AppError)

	// GetConfig fetches the currently persisted config
	GetConfig() *model.Config

	// SaveConfig sets the given config and persists the changes
	SaveConfig(config *model.Config) *model.AppError

	// GetPluginConfig fetches the currently persisted config of plugin
	//
	// Minimum server version: 5.6
	GetPluginConfig() map[string]interface{}

	// SavePluginConfig sets the given config for plugin and persists the changes
	//
	// Minimum server version: 5.6
	SavePluginConfig(config map[string]interface{}) *model.AppError

	// GetServerVersion return the current Mattermost server version
	//
	// Minimum server version: 5.4
	GetServerVersion() string

	// CreateUser creates a user.
	CreateUser(user *model.User) (*model.User, *model.AppError)

	// DeleteUser deletes a user.
	DeleteUser(userId string) *model.AppError

	// GetUser gets a user.
	GetUser(userId string) (*model.User, *model.AppError)

	// GetUserByEmail gets a user by their email address.
	GetUserByEmail(email string) (*model.User, *model.AppError)

	// GetUserByUsername gets a user by their username.
	GetUserByUsername(name string) (*model.User, *model.AppError)

	// GetUsersByUsernames gets users by their usernames.
	//
	// Minimum server version: 5.6
	GetUsersByUsernames(usernames []string) ([]*model.User, *model.AppError)

	// GetUsersInTeam gets users in team.
	//
	// Minimum server version: 5.6
	GetUsersInTeam(teamId string, page int, perPage int) ([]*model.User, *model.AppError)

	// GetTeamIcon gets the team icon.
	//
	// Minimum server version: 5.6
	GetTeamIcon(teamId string) ([]byte, *model.AppError)

	// SetTeamIcon sets the team icon.
	//
	// Minimum server version: 5.6
	SetTeamIcon(teamId string, data []byte) *model.AppError

	// RemoveTeamIcon removes the team icon.
	//
	// Minimum server version: 5.6
	RemoveTeamIcon(teamId string) *model.AppError

	// UpdateUser updates a user.
	UpdateUser(user *model.User) (*model.User, *model.AppError)

	// GetUserStatus will get a user's status.
	GetUserStatus(userId string) (*model.Status, *model.AppError)

	// GetUserStatusesByIds will return a list of user statuses based on the provided slice of user IDs.
	GetUserStatusesByIds(userIds []string) ([]*model.Status, *model.AppError)

	// UpdateUserStatus will set a user's status until the user, or another integration/plugin, sets it back to online.
	// The status parameter can be: "online", "away", "dnd", or "offline".
	UpdateUserStatus(userId, status string) (*model.Status, *model.AppError)

	// UpdateUserActive deactivates or reactivates an user.
	//
	// Minimum server version: 5.8
	UpdateUserActive(userId string, active bool) *model.AppError

	// GetUsersInChannel returns a page of users in a channel. Page counting starts at 0.
	// The sortBy parameter can be: "username" or "status".
	//
	// Minimum server version: 5.6
	GetUsersInChannel(channelId, sortBy string, page, perPage int) ([]*model.User, *model.AppError)

	// GetLDAPUserAttributes will return LDAP attributes for a user.
	// The attributes parameter should be a list of attributes to pull.
	// Returns a map with attribute names as keys and the user's attributes as values.
	// Requires an enterprise license, LDAP to be configured and for the user to use LDAP as an authentication method.
	//
	// Minimum server version: 5.3
	GetLDAPUserAttributes(userId string, attributes []string) (map[string]string, *model.AppError)

	// CreateTeam creates a team.
	CreateTeam(team *model.Team) (*model.Team, *model.AppError)

	// DeleteTeam deletes a team.
	DeleteTeam(teamId string) *model.AppError

	// GetTeam gets all teams.
	GetTeams() ([]*model.Team, *model.AppError)

	// GetTeam gets a team.
	GetTeam(teamId string) (*model.Team, *model.AppError)

	// GetTeamByName gets a team by its name.
	GetTeamByName(name string) (*model.Team, *model.AppError)

	// GetTeamsUnreadForUser gets the unread message and mention counts for each team to which the given user belongs.
	//
	// Minimum server version: 5.6
	GetTeamsUnreadForUser(userId string) ([]*model.TeamUnread, *model.AppError)

	// UpdateTeam updates a team.
	UpdateTeam(team *model.Team) (*model.Team, *model.AppError)

	// SearchTeams search a team.
	//
	// Minimum server version: 5.8
	SearchTeams(term string) ([]*model.Team, *model.AppError)

	// GetTeamsForUser returns list of teams of given user ID.
	//
	// Minimum server version: 5.6
	GetTeamsForUser(userId string) ([]*model.Team, *model.AppError)

	// CreateTeamMember creates a team membership.
	CreateTeamMember(teamId, userId string) (*model.TeamMember, *model.AppError)

	// CreateTeamMember creates a team membership for all provided user ids.
	CreateTeamMembers(teamId string, userIds []string, requestorId string) ([]*model.TeamMember, *model.AppError)

	// DeleteTeamMember deletes a team membership.
	DeleteTeamMember(teamId, userId, requestorId string) *model.AppError

	// GetTeamMembers returns the memberships of a specific team.
	GetTeamMembers(teamId string, page, perPage int) ([]*model.TeamMember, *model.AppError)

	// GetTeamMember returns a specific membership.
	GetTeamMember(teamId, userId string) (*model.TeamMember, *model.AppError)

	// UpdateTeamMemberRoles updates the role for a team membership.
	UpdateTeamMemberRoles(teamId, userId, newRoles string) (*model.TeamMember, *model.AppError)

	// CreateChannel creates a channel.
	CreateChannel(channel *model.Channel) (*model.Channel, *model.AppError)

	// DeleteChannel deletes a channel.
	DeleteChannel(channelId string) *model.AppError

	// GetPublicChannelsForTeam gets a list of all channels.
	GetPublicChannelsForTeam(teamId string, page, perPage int) ([]*model.Channel, *model.AppError)

	// GetChannel gets a channel.
	GetChannel(channelId string) (*model.Channel, *model.AppError)

	// GetChannelByName gets a channel by its name, given a team id.
	GetChannelByName(teamId, name string, includeDeleted bool) (*model.Channel, *model.AppError)

	// GetChannelByNameForTeamName gets a channel by its name, given a team name.
	GetChannelByNameForTeamName(teamName, channelName string, includeDeleted bool) (*model.Channel, *model.AppError)

	// GetChannelsForTeamForUser gets a list of channels for given user ID in given team ID.
	//
	// Minimum server version: 5.6
	GetChannelsForTeamForUser(teamId, userId string, includeDeleted bool) ([]*model.Channel, *model.AppError)

	// GetChannelStats gets statistics for a channel.
	//
	// Minimum server version: 5.6
	GetChannelStats(channelId string) (*model.ChannelStats, *model.AppError)

	// GetDirectChannel gets a direct message channel.
	// If the channel does not exist it will create it.
	GetDirectChannel(userId1, userId2 string) (*model.Channel, *model.AppError)

	// GetGroupChannel gets a group message channel.
	// If the channel does not exist it will create it.
	GetGroupChannel(userIds []string) (*model.Channel, *model.AppError)

	// UpdateChannel updates a channel.
	UpdateChannel(channel *model.Channel) (*model.Channel, *model.AppError)

	// SearchChannels returns the channels on a team matching the provided search term.
	//
	// Minimum server version: 5.6
	SearchChannels(teamId string, term string) ([]*model.Channel, *model.AppError)

	// SearchUsers returns a list of users based on some search criteria.
	//
	// Minimum server version: 5.6
	SearchUsers(search *model.UserSearch) ([]*model.User, *model.AppError)

	// AddChannelMember creates a channel membership for a user.
	AddChannelMember(channelId, userId string) (*model.ChannelMember, *model.AppError)

	// GetChannelMember gets a channel membership for a user.
	GetChannelMember(channelId, userId string) (*model.ChannelMember, *model.AppError)

	// GetChannelMembers gets a channel membership for all users.
	//
	// Minimum server version: 5.6
	GetChannelMembers(channelId string, page, perPage int) (*model.ChannelMembers, *model.AppError)

	// GetChannelMembersByIds gets a channel membership for a particular User
	//
	// Minimum server version: 5.6
	GetChannelMembersByIds(channelId string, userIds []string) (*model.ChannelMembers, *model.AppError)

	// UpdateChannelMemberRoles updates a user's roles for a channel.
	UpdateChannelMemberRoles(channelId, userId, newRoles string) (*model.ChannelMember, *model.AppError)

	// UpdateChannelMemberNotifications updates a user's notification properties for a channel.
	UpdateChannelMemberNotifications(channelId, userId string, notifications map[string]string) (*model.ChannelMember, *model.AppError)

	// DeleteChannelMember deletes a channel membership for a user.
	DeleteChannelMember(channelId, userId string) *model.AppError

	// CreatePost creates a post.
	CreatePost(post *model.Post) (*model.Post, *model.AppError)

	// AddReaction add a reaction to a post.
	//
	// Minimum server version: 5.3
	AddReaction(reaction *model.Reaction) (*model.Reaction, *model.AppError)

	// RemoveReaction remove a reaction from a post.
	//
	// Minimum server version: 5.3
	RemoveReaction(reaction *model.Reaction) *model.AppError

	// GetReaction get the reactions of a post.
	//
	// Minimum server version: 5.3
	GetReactions(postId string) ([]*model.Reaction, *model.AppError)

	// SendEphemeralPost creates an ephemeral post.
	SendEphemeralPost(userId string, post *model.Post) *model.Post

	// DeletePost deletes a post.
	DeletePost(postId string) *model.AppError

	// GetPostThread gets a post with all the other posts in the same thread.
	//
	// Minimum server version: 5.6
	GetPostThread(postId string) (*model.PostList, *model.AppError)

	// GetPost gets a post.
	GetPost(postId string) (*model.Post, *model.AppError)

	// GetPostsSince gets posts created after a specified time as Unix time in milliseconds.
	//
	// Minimum server version: 5.6
	GetPostsSince(channelId string, time int64) (*model.PostList, *model.AppError)

	// GetPostsAfter gets a page of posts that were posted after the post provided.
	//
	// Minimum server version: 5.6
	GetPostsAfter(channelId, postId string, page, perPage int) (*model.PostList, *model.AppError)

	// GetPostsBefore gets a page of posts that were posted before the post provided.
	//
	// Minimum server version: 5.6
	GetPostsBefore(channelId, postId string, page, perPage int) (*model.PostList, *model.AppError)

	// GetPostsForChannel gets a list of posts for a channel.
	//
	// Minimum server version: 5.6
	GetPostsForChannel(channelId string, page, perPage int) (*model.PostList, *model.AppError)

	// GetTeamStats gets a team's statistics
	//
	// Minimum server version: 5.8
	GetTeamStats(teamId string) (*model.TeamStats, *model.AppError)

	// UpdatePost updates a post.
	UpdatePost(post *model.Post) (*model.Post, *model.AppError)

	// GetProfileImage gets user's profile image.
	//
	// Minimum server version: 5.6
	GetProfileImage(userId string) ([]byte, *model.AppError)

	// SetProfileImage sets a user's profile image.
	//
	// Minimum server version: 5.6
	SetProfileImage(userId string, data []byte) *model.AppError

	// GetEmojiList returns a page of custom emoji on the system.
	//
	// The sortBy parameter can be: "name".
	//
	// Minimum server version: 5.6
	GetEmojiList(sortBy string, page, perPage int) ([]*model.Emoji, *model.AppError)

	// GetEmojiByName gets an emoji by it's name.
	//
	// Minimum server version: 5.6
	GetEmojiByName(name string) (*model.Emoji, *model.AppError)

	// GetEmoji returns a custom emoji based on the emojiId string.
	//
	// Minimum server version: 5.6
	GetEmoji(emojiId string) (*model.Emoji, *model.AppError)

	// CopyFileInfos duplicates the FileInfo objects referenced by the given file ids,
	// recording the given user id as the new creator and returning the new set of file ids.
	//
	// The duplicate FileInfo objects are not initially linked to a post, but may now be passed
	// to CreatePost. Use this API to duplicate a post and its file attachments without
	// actually duplicating the uploaded files.
	CopyFileInfos(userId string, fileIds []string) ([]string, *model.AppError)

	// GetFileInfo gets a File Info for a specific fileId
	//
	// Minimum server version: 5.3
	GetFileInfo(fileId string) (*model.FileInfo, *model.AppError)

	// GetFile gets content of a file by it's ID
	//
	// Minimum Server version: 5.8
	GetFile(fileId string) ([]byte, *model.AppError)

	// GetFileLink gets the public link to a file by fileId.
	//
	// Minimum server version: 5.6
	GetFileLink(fileId string) (string, *model.AppError)

	// ReadFileAtPath reads the file from the backend for a specific path
	//
	// Minimum server version: 5.3
	ReadFile(path string) ([]byte, *model.AppError)

	// GetEmojiImage returns the emoji image.
	//
	// Minimum server version: 5.6
	GetEmojiImage(emojiId string) ([]byte, string, *model.AppError)

	// UploadFile will upload a file to a channel using a multipart request, to be later attached to a post.
	//
	// Minimum server version: 5.6
	UploadFile(data []byte, channelId string, filename string) (*model.FileInfo, *model.AppError)

	// OpenInteractiveDialog will open an interactive dialog on a user's client that
	// generated the trigger ID. Used with interactive message buttons, menus
	// and slash commands.
	//
	// Minimum server version: 5.6
	OpenInteractiveDialog(dialog model.OpenDialogRequest) *model.AppError

	// GetPlugins will return a list of plugin manifests for currently active plugins.
	//
	// Minimum server version: 5.6
	GetPlugins() ([]*model.Manifest, *model.AppError)

	// EnablePlugin will enable an plugin installed.
	//
	// Minimum server version: 5.6
	EnablePlugin(id string) *model.AppError

	// DisablePlugin will disable an enabled plugin.
	//
	// Minimum server version: 5.6
	DisablePlugin(id string) *model.AppError

	// RemovePlugin will disable and delete a plugin.
	//
	// Minimum server version: 5.6
	RemovePlugin(id string) *model.AppError

	// GetPluginStatus will return the status of a plugin.
	//
	// Minimum server version: 5.6
	GetPluginStatus(id string) (*model.PluginStatus, *model.AppError)

	// KVSet will store a key-value pair, unique per plugin.
	KVSet(key string, value []byte) *model.AppError

	// KVSet will store a key-value pair, unique per plugin with an expiry time
	//
	// Minimum server version: 5.6
	KVSetWithExpiry(key string, value []byte, expireInSeconds int64) *model.AppError

	// KVGet will retrieve a value based on the key. Returns nil for non-existent keys.
	KVGet(key string) ([]byte, *model.AppError)

	// KVDelete will remove a key-value pair. Returns nil for non-existent keys.
	KVDelete(key string) *model.AppError

	// KVDeleteAll will remove all key-value pairs for a plugin.
	//
	// Minimum server version: 5.6
	KVDeleteAll() *model.AppError

	// KVList will list all keys for a plugin.
	//
	// Minimum server version: 5.6
	KVList(page, perPage int) ([]string, *model.AppError)

	// PublishWebSocketEvent sends an event to WebSocket connections.
	// event is the type and will be prepended with "custom_<pluginid>_".
	// payload is the data sent with the event. Interface values must be primitive Go types or mattermost-server/model types.
	// broadcast determines to which users to send the event.
	PublishWebSocketEvent(event string, payload map[string]interface{}, broadcast *model.WebsocketBroadcast)

	// HasPermissionTo check if the user has the permission at system scope.
	//
	// Minimum server version: 5.3
	HasPermissionTo(userId string, permission *model.Permission) bool

	// HasPermissionToTeam check if the user has the permission at team scope.
	//
	// Minimum server version: 5.3
	HasPermissionToTeam(userId, teamId string, permission *model.Permission) bool

	// HasPermissionToChannel check if the user has the permission at channel scope.
	//
	// Minimum server version: 5.3
	HasPermissionToChannel(userId, channelId string, permission *model.Permission) bool

	// LogDebug writes a log message to the Mattermost server log file.
	// Appropriate context such as the plugin name will already be added as fields so plugins
	// do not need to add that info.
	// keyValuePairs should be primitive go types or other values that can be encoded by encoding/gob
	LogDebug(msg string, keyValuePairs ...interface{})

	// LogInfo writes a log message to the Mattermost server log file.
	// Appropriate context such as the plugin name will already be added as fields so plugins
	// do not need to add that info.
	// keyValuePairs should be primitive go types or other values that can be encoded by encoding/gob
	LogInfo(msg string, keyValuePairs ...interface{})

	// LogError writes a log message to the Mattermost server log file.
	// Appropriate context such as the plugin name will already be added as fields so plugins
	// do not need to add that info.
	// keyValuePairs should be primitive go types or other values that can be encoded by encoding/gob
	LogError(msg string, keyValuePairs ...interface{})

	// LogWarn writes a log message to the Mattermost server log file.
	// Appropriate context such as the plugin name will already be added as fields so plugins
	// do not need to add that info.
	// keyValuePairs should be primitive go types or other values that can be encoded by encoding/gob
	LogWarn(msg string, keyValuePairs ...interface{})

	// SendMail sends an email to a specific address
	//
	// Minimum server version: 5.7
	SendMail(to, subject, htmlBody string) *model.AppError
}

The API can be used to retrieve data or perform actions on behalf of the plugin. Most methods have direct counterparts in the REST API and very similar behavior.

Plugins obtain access to the API by embedding MattermostPlugin and accessing the API member directly.

type Context added in v5.2.0 

type Context struct {
	SessionId      string
	RequestId      string
	IpAddress      string
	AcceptLanguage string
	UserAgent      string
}

Context passes through metadata about the request or hook event. For requests this is built in app/plugin_requests.go For hooks, app.PluginContext() is called.

type Environment added in v5.2.0 

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

Environment represents the execution environment of active plugins.

It is meant for use by the Mattermost server to manipulate, interact with and report on the set of active plugins.

func NewEnvironment added in v5.2.0 

func NewEnvironment(newAPIImpl apiImplCreatorFunc, pluginDir string, webappPluginDir string, logger *mlog.Logger) (*Environment, error)

func (*Environment) Activate added in v5.2.0 

func (env *Environment) Activate(id string) (manifest *model.Manifest, activated bool, reterr error)

func (*Environment) Active added in v5.2.0 

func (env *Environment) Active() []*model.BundleInfo

Returns a list of all currently active plugins within the environment.

func (*Environment) Available added in v5.2.0 

func (env *Environment) Available() ([]*model.BundleInfo, error)

Returns a list of all plugins within the environment.

func (*Environment) Deactivate added in v5.2.0 

func (env *Environment) Deactivate(id string) bool

Deactivates the plugin with the given id.

func (*Environment) HooksForPlugin added in v5.2.0 

func (env *Environment) HooksForPlugin(id string) (Hooks, error)

HooksForPlugin returns the hooks API for the plugin with the given id.

Consider using RunMultiPluginHook instead.

func (*Environment) IsActive added in v5.2.0 

func (env *Environment) IsActive(id string) bool

IsActive returns true if the plugin with the given id is active.

func (*Environment) RunMultiPluginHook added in v5.2.0 

func (env *Environment) RunMultiPluginHook(hookRunnerFunc func(hooks Hooks) bool, hookId int)

RunMultiPluginHook invokes hookRunnerFunc for each plugin that implements the given hookId.

If hookRunnerFunc returns false, iteration will not continue. The iteration order among active plugins is not specified.

func (*Environment) Shutdown added in v5.2.0 

func (env *Environment) Shutdown()

Shutdown deactivates all plugins and gracefully shuts down the environment.

func (*Environment) Statuses added in v5.2.0 

func (env *Environment) Statuses() (model.PluginStatuses, error)

Statuses returns a list of plugin statuses representing the state of every plugin

type ErrorString added in v5.4.0 

type ErrorString struct {
	Err string
}

ErrorString is a fallback for sending unregistered implementations of the error interface across rpc. For example, the errorString type from the github.com/pkg/errors package cannot be registered since it is not exported, but this precludes common error handling paradigms. ErrorString merely preserves the string description of the error, while satisfying the error interface itself to allow other registered types (such as model.AppError) to be sent unmodified.

func (ErrorString) Error added in v5.4.0 

func (e ErrorString) Error() string

type Hooks 

type Hooks interface {
	// OnActivate is invoked when the plugin is activated. If an error is returned, the plugin
	// will be terminated. The plugin will not receive hooks until after OnActivate returns
	// without error.
	OnActivate() error

	// Implemented returns a list of hooks that are implemented by the plugin.
	// Plugins do not need to provide an implementation. Any given will be ignored.
	Implemented() ([]string, error)

	// OnDeactivate is invoked when the plugin is deactivated. This is the plugin's last chance to
	// use the API, and the plugin will be terminated shortly after this invocation. The plugin
	// will stop receiving hooks just prior to this method being called.
	OnDeactivate() error

	// OnConfigurationChange is invoked when configuration changes may have been made. Any
	// returned error is logged, but does not stop the plugin. You must be prepared to handle
	// a configuration failure gracefully.
	OnConfigurationChange() error

	// ServeHTTP allows the plugin to implement the http.Handler interface. Requests destined for
	// the /plugins/{id} path will be routed to the plugin.
	//
	// The Mattermost-User-Id header will be present if (and only if) the request is by an
	// authenticated user.
	ServeHTTP(c *Context, w http.ResponseWriter, r *http.Request)

	// ExecuteCommand executes a command that has been previously registered via the RegisterCommand
	// API.
	ExecuteCommand(c *Context, args *model.CommandArgs) (*model.CommandResponse, *model.AppError)

	// MessageWillBePosted is invoked when a message is posted by a user before it is committed
	// to the database. If you also want to act on edited posts, see MessageWillBeUpdated.
	//
	// To reject a post, return an non-empty string describing why the post was rejected.
	// To modify the post, return the replacement, non-nil *model.Post and an empty string.
	// To allow the post without modification, return a nil *model.Post and an empty string.
	//
	// If you don't need to modify or reject posts, use MessageHasBeenPosted instead.
	//
	// Note that this method will be called for posts created by plugins, including the plugin that
	// created the post.
	MessageWillBePosted(c *Context, post *model.Post) (*model.Post, string)

	// MessageWillBeUpdated is invoked when a message is updated by a user before it is committed
	// to the database. If you also want to act on new posts, see MessageWillBePosted.
	// Return values should be the modified post or nil if rejected and an explanation for the user.
	// On rejection, the post will be kept in its previous state.
	//
	// If you don't need to modify or rejected updated posts, use MessageHasBeenUpdated instead.
	//
	// Note that this method will be called for posts updated by plugins, including the plugin that
	// updated the post.
	MessageWillBeUpdated(c *Context, newPost, oldPost *model.Post) (*model.Post, string)

	// MessageHasBeenPosted is invoked after the message has been committed to the database.
	// If you need to modify or reject the post, see MessageWillBePosted
	// Note that this method will be called for posts created by plugins, including the plugin that
	// created the post.
	MessageHasBeenPosted(c *Context, post *model.Post)

	// MessageHasBeenUpdated is invoked after a message is updated and has been updated in the database.
	// If you need to modify or reject the post, see MessageWillBeUpdated
	// Note that this method will be called for posts created by plugins, including the plugin that
	// created the post.
	MessageHasBeenUpdated(c *Context, newPost, oldPost *model.Post)

	// ChannelHasBeenCreated is invoked after the channel has been committed to the database.
	ChannelHasBeenCreated(c *Context, channel *model.Channel)

	// UserHasJoinedChannel is invoked after the membership has been committed to the database.
	// If actor is not nil, the user was invited to the channel by the actor.
	UserHasJoinedChannel(c *Context, channelMember *model.ChannelMember, actor *model.User)

	// UserHasLeftChannel is invoked after the membership has been removed from the database.
	// If actor is not nil, the user was removed from the channel by the actor.
	UserHasLeftChannel(c *Context, channelMember *model.ChannelMember, actor *model.User)

	// UserHasJoinedTeam is invoked after the membership has been committed to the database.
	// If actor is not nil, the user was added to the team by the actor.
	UserHasJoinedTeam(c *Context, teamMember *model.TeamMember, actor *model.User)

	// UserHasLeftTeam is invoked after the membership has been removed from the database.
	// If actor is not nil, the user was removed from the team by the actor.
	UserHasLeftTeam(c *Context, teamMember *model.TeamMember, actor *model.User)

	// UserWillLogIn before the login of the user is returned. Returning a non empty string will reject the login event.
	// If you don't need to reject the login event, see UserHasLoggedIn
	UserWillLogIn(c *Context, user *model.User) string

	// UserHasLoggedIn is invoked after a user has logged in.
	UserHasLoggedIn(c *Context, user *model.User)

	// FileWillBeUploaded is invoked when a file is uploaded, but before it is committed to backing store.
	// Read from file to retrieve the body of the uploaded file.
	//
	// To reject a file upload, return an non-empty string describing why the file was rejected.
	// To modify the file, write to the output and/or return a non-nil *model.FileInfo, as well as an empty string.
	// To allow the file without modification, do not write to the output and return a nil *model.FileInfo and an empty string.
	//
	// Note that this method will be called for files uploaded by plugins, including the plugin that uploaded the post.
	// FileInfo.Size will be automatically set properly if you modify the file.
	FileWillBeUploaded(c *Context, info *model.FileInfo, file io.Reader, output io.Writer) (*model.FileInfo, string)
}

Hooks describes the methods a plugin may implement to automatically receive the corresponding event.

A plugin only need implement the hooks it cares about. The MattermostPlugin provides some default implementations for convenience but may be overridden.

type MattermostPlugin added in v5.2.0 

type MattermostPlugin struct {
	// API exposes the plugin api, and becomes available just prior to the OnActive hook.
	API API
}

func (*MattermostPlugin) SetAPI added in v5.2.0 

func (p *MattermostPlugin) SetAPI(api API)

SetAPI persists the given API interface to the plugin. It is invoked just prior to the OnActivate hook, exposing the API for use by the plugin.

type Z_AddChannelMemberArgs added in v5.2.0 

type Z_AddChannelMemberArgs struct {
	A string
	B string
}

type Z_AddChannelMemberReturns added in v5.2.0 

type Z_AddChannelMemberReturns struct {
	A *model.ChannelMember
	B *model.AppError
}

type Z_AddReactionArgs added in v5.3.0 

type Z_AddReactionArgs struct {
	A *model.Reaction
}

type Z_AddReactionReturns added in v5.3.0 

type Z_AddReactionReturns struct {
	A *model.Reaction
	B *model.AppError
}

type Z_ChannelHasBeenCreatedArgs added in v5.2.0 

type Z_ChannelHasBeenCreatedArgs struct {
	A *Context
	B *model.Channel
}

type Z_ChannelHasBeenCreatedReturns added in v5.2.0 

type Z_ChannelHasBeenCreatedReturns struct {
}

type Z_CopyFileInfosArgs added in v5.2.0 

type Z_CopyFileInfosArgs struct {
	A string
	B []string
}

type Z_CopyFileInfosReturns added in v5.2.0 

type Z_CopyFileInfosReturns struct {
	A []string
	B *model.AppError
}

type Z_CreateChannelArgs added in v5.2.0 

type Z_CreateChannelArgs struct {
	A *model.Channel
}

type Z_CreateChannelReturns added in v5.2.0 

type Z_CreateChannelReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_CreatePostArgs added in v5.2.0 

type Z_CreatePostArgs struct {
	A *model.Post
}

type Z_CreatePostReturns added in v5.2.0 

type Z_CreatePostReturns struct {
	A *model.Post
	B *model.AppError
}

type Z_CreateTeamArgs added in v5.2.0 

type Z_CreateTeamArgs struct {
	A *model.Team
}

type Z_CreateTeamMemberArgs added in v5.2.0 

type Z_CreateTeamMemberArgs struct {
	A string
	B string
}

type Z_CreateTeamMemberReturns added in v5.2.0 

type Z_CreateTeamMemberReturns struct {
	A *model.TeamMember
	B *model.AppError
}

type Z_CreateTeamMembersArgs added in v5.2.0 

type Z_CreateTeamMembersArgs struct {
	A string
	B []string
	C string
}

type Z_CreateTeamMembersReturns added in v5.2.0 

type Z_CreateTeamMembersReturns struct {
	A []*model.TeamMember
	B *model.AppError
}

type Z_CreateTeamReturns added in v5.2.0 

type Z_CreateTeamReturns struct {
	A *model.Team
	B *model.AppError
}

type Z_CreateUserArgs added in v5.2.0 

type Z_CreateUserArgs struct {
	A *model.User
}

type Z_CreateUserReturns added in v5.2.0 

type Z_CreateUserReturns struct {
	A *model.User
	B *model.AppError
}

type Z_DeleteChannelArgs added in v5.2.0 

type Z_DeleteChannelArgs struct {
	A string
}

type Z_DeleteChannelMemberArgs added in v5.2.0 

type Z_DeleteChannelMemberArgs struct {
	A string
	B string
}

type Z_DeleteChannelMemberReturns added in v5.2.0 

type Z_DeleteChannelMemberReturns struct {
	A *model.AppError
}

type Z_DeleteChannelReturns added in v5.2.0 

type Z_DeleteChannelReturns struct {
	A *model.AppError
}

type Z_DeletePostArgs added in v5.2.0 

type Z_DeletePostArgs struct {
	A string
}

type Z_DeletePostReturns added in v5.2.0 

type Z_DeletePostReturns struct {
	A *model.AppError
}

type Z_DeleteTeamArgs added in v5.2.0 

type Z_DeleteTeamArgs struct {
	A string
}

type Z_DeleteTeamMemberArgs added in v5.2.0 

type Z_DeleteTeamMemberArgs struct {
	A string
	B string
	C string
}

type Z_DeleteTeamMemberReturns added in v5.2.0 

type Z_DeleteTeamMemberReturns struct {
	A *model.AppError
}

type Z_DeleteTeamReturns added in v5.2.0 

type Z_DeleteTeamReturns struct {
	A *model.AppError
}

type Z_DeleteUserArgs added in v5.2.0 

type Z_DeleteUserArgs struct {
	A string
}

type Z_DeleteUserReturns added in v5.2.0 

type Z_DeleteUserReturns struct {
	A *model.AppError
}

type Z_DisablePluginArgs added in v5.6.0 

type Z_DisablePluginArgs struct {
	A string
}

type Z_DisablePluginReturns added in v5.6.0 

type Z_DisablePluginReturns struct {
	A *model.AppError
}

type Z_EnablePluginArgs added in v5.6.0 

type Z_EnablePluginArgs struct {
	A string
}

type Z_EnablePluginReturns added in v5.6.0 

type Z_EnablePluginReturns struct {
	A *model.AppError
}

type Z_ExecuteCommandArgs added in v5.2.0 

type Z_ExecuteCommandArgs struct {
	A *Context
	B *model.CommandArgs
}

type Z_ExecuteCommandReturns added in v5.2.0 

type Z_ExecuteCommandReturns struct {
	A *model.CommandResponse
	B *model.AppError
}

type Z_FileWillBeUploadedArgs added in v5.2.0 

type Z_FileWillBeUploadedArgs struct {
	A                     *Context
	B                     *model.FileInfo
	UploadedFileStream    uint32
	ReplacementFileStream uint32
}

type Z_FileWillBeUploadedReturns added in v5.2.0 

type Z_FileWillBeUploadedReturns struct {
	A *model.FileInfo
	B string
}

type Z_GetChannelArgs added in v5.2.0 

type Z_GetChannelArgs struct {
	A string
}

type Z_GetChannelByNameArgs added in v5.2.0 

type Z_GetChannelByNameArgs struct {
	A string
	B string
	C bool
}

type Z_GetChannelByNameForTeamNameArgs added in v5.2.0 

type Z_GetChannelByNameForTeamNameArgs struct {
	A string
	B string
	C bool
}

type Z_GetChannelByNameForTeamNameReturns added in v5.2.0 

type Z_GetChannelByNameForTeamNameReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_GetChannelByNameReturns added in v5.2.0 

type Z_GetChannelByNameReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_GetChannelMemberArgs added in v5.2.0 

type Z_GetChannelMemberArgs struct {
	A string
	B string
}

type Z_GetChannelMemberReturns added in v5.2.0 

type Z_GetChannelMemberReturns struct {
	A *model.ChannelMember
	B *model.AppError
}

type Z_GetChannelMembersArgs added in v5.6.0 

type Z_GetChannelMembersArgs struct {
	A string
	B int
	C int
}

type Z_GetChannelMembersByIdsArgs added in v5.6.0 

type Z_GetChannelMembersByIdsArgs struct {
	A string
	B []string
}

type Z_GetChannelMembersByIdsReturns added in v5.6.0 

type Z_GetChannelMembersByIdsReturns struct {
	A *model.ChannelMembers
	B *model.AppError
}

type Z_GetChannelMembersReturns added in v5.6.0 

type Z_GetChannelMembersReturns struct {
	A *model.ChannelMembers
	B *model.AppError
}

type Z_GetChannelReturns added in v5.2.0 

type Z_GetChannelReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_GetChannelStatsArgs added in v5.6.0 

type Z_GetChannelStatsArgs struct {
	A string
}

type Z_GetChannelStatsReturns added in v5.6.0 

type Z_GetChannelStatsReturns struct {
	A *model.ChannelStats
	B *model.AppError
}

type Z_GetChannelsForTeamForUserArgs added in v5.6.0 

type Z_GetChannelsForTeamForUserArgs struct {
	A string
	B string
	C bool
}

type Z_GetChannelsForTeamForUserReturns added in v5.6.0 

type Z_GetChannelsForTeamForUserReturns struct {
	A []*model.Channel
	B *model.AppError
}

type Z_GetConfigArgs added in v5.2.0 

type Z_GetConfigArgs struct {
}

type Z_GetConfigReturns added in v5.2.0 

type Z_GetConfigReturns struct {
	A *model.Config
}

type Z_GetDirectChannelArgs added in v5.2.0 

type Z_GetDirectChannelArgs struct {
	A string
	B string
}

type Z_GetDirectChannelReturns added in v5.2.0 

type Z_GetDirectChannelReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_GetEmojiArgs added in v5.6.0 

type Z_GetEmojiArgs struct {
	A string
}

type Z_GetEmojiByNameArgs added in v5.6.0 

type Z_GetEmojiByNameArgs struct {
	A string
}

type Z_GetEmojiByNameReturns added in v5.6.0 

type Z_GetEmojiByNameReturns struct {
	A *model.Emoji
	B *model.AppError
}

type Z_GetEmojiImageArgs added in v5.6.0 

type Z_GetEmojiImageArgs struct {
	A string
}

type Z_GetEmojiImageReturns added in v5.6.0 

type Z_GetEmojiImageReturns struct {
	A []byte
	B string
	C *model.AppError
}

type Z_GetEmojiListArgs added in v5.6.0 

type Z_GetEmojiListArgs struct {
	A string
	B int
	C int
}

type Z_GetEmojiListReturns added in v5.6.0 

type Z_GetEmojiListReturns struct {
	A []*model.Emoji
	B *model.AppError
}

type Z_GetEmojiReturns added in v5.6.0 

type Z_GetEmojiReturns struct {
	A *model.Emoji
	B *model.AppError
}

type Z_GetFileArgs added in v5.8.0 

type Z_GetFileArgs struct {
	A string
}

type Z_GetFileInfoArgs added in v5.3.0 

type Z_GetFileInfoArgs struct {
	A string
}

type Z_GetFileInfoReturns added in v5.3.0 

type Z_GetFileInfoReturns struct {
	A *model.FileInfo
	B *model.AppError
}

type Z_GetFileLinkArgs added in v5.6.0 

type Z_GetFileLinkArgs struct {
	A string
}

type Z_GetFileLinkReturns added in v5.6.0 

type Z_GetFileLinkReturns struct {
	A string
	B *model.AppError
}

type Z_GetFileReturns added in v5.8.0 

type Z_GetFileReturns struct {
	A []byte
	B *model.AppError
}

type Z_GetGroupChannelArgs added in v5.2.0 

type Z_GetGroupChannelArgs struct {
	A []string
}

type Z_GetGroupChannelReturns added in v5.2.0 

type Z_GetGroupChannelReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_GetLDAPUserAttributesArgs added in v5.3.0 

type Z_GetLDAPUserAttributesArgs struct {
	A string
	B []string
}

type Z_GetLDAPUserAttributesReturns added in v5.3.0 

type Z_GetLDAPUserAttributesReturns struct {
	A map[string]string
	B *model.AppError
}

type Z_GetPluginConfigArgs added in v5.6.0 

type Z_GetPluginConfigArgs struct {
}

type Z_GetPluginConfigReturns added in v5.6.0 

type Z_GetPluginConfigReturns struct {
	A map[string]interface{}
}

type Z_GetPluginStatusArgs added in v5.6.0 

type Z_GetPluginStatusArgs struct {
	A string
}

type Z_GetPluginStatusReturns added in v5.6.0 

type Z_GetPluginStatusReturns struct {
	A *model.PluginStatus
	B *model.AppError
}

type Z_GetPluginsArgs added in v5.6.0 

type Z_GetPluginsArgs struct {
}

type Z_GetPluginsReturns added in v5.6.0 

type Z_GetPluginsReturns struct {
	A []*model.Manifest
	B *model.AppError
}

type Z_GetPostArgs added in v5.2.0 

type Z_GetPostArgs struct {
	A string
}

type Z_GetPostReturns added in v5.2.0 

type Z_GetPostReturns struct {
	A *model.Post
	B *model.AppError
}

type Z_GetPostThreadArgs added in v5.6.0 

type Z_GetPostThreadArgs struct {
	A string
}

type Z_GetPostThreadReturns added in v5.6.0 

type Z_GetPostThreadReturns struct {
	A *model.PostList
	B *model.AppError
}

type Z_GetPostsAfterArgs added in v5.6.0 

type Z_GetPostsAfterArgs struct {
	A string
	B string
	C int
	D int
}

type Z_GetPostsAfterReturns added in v5.6.0 

type Z_GetPostsAfterReturns struct {
	A *model.PostList
	B *model.AppError
}

type Z_GetPostsBeforeArgs added in v5.6.0 

type Z_GetPostsBeforeArgs struct {
	A string
	B string
	C int
	D int
}

type Z_GetPostsBeforeReturns added in v5.6.0 

type Z_GetPostsBeforeReturns struct {
	A *model.PostList
	B *model.AppError
}

type Z_GetPostsForChannelArgs added in v5.6.0 

type Z_GetPostsForChannelArgs struct {
	A string
	B int
	C int
}

type Z_GetPostsForChannelReturns added in v5.6.0 

type Z_GetPostsForChannelReturns struct {
	A *model.PostList
	B *model.AppError
}

type Z_GetPostsSinceArgs added in v5.6.0 

type Z_GetPostsSinceArgs struct {
	A string
	B int64
}

type Z_GetPostsSinceReturns added in v5.6.0 

type Z_GetPostsSinceReturns struct {
	A *model.PostList
	B *model.AppError
}

type Z_GetProfileImageArgs added in v5.6.0 

type Z_GetProfileImageArgs struct {
	A string
}

type Z_GetProfileImageReturns added in v5.6.0 

type Z_GetProfileImageReturns struct {
	A []byte
	B *model.AppError
}

type Z_GetPublicChannelsForTeamArgs added in v5.2.0 

type Z_GetPublicChannelsForTeamArgs struct {
	A string
	B int
	C int
}

type Z_GetPublicChannelsForTeamReturns added in v5.2.0 

type Z_GetPublicChannelsForTeamReturns struct {
	A []*model.Channel
	B *model.AppError
}

type Z_GetReactionsArgs added in v5.3.0 

type Z_GetReactionsArgs struct {
	A string
}

type Z_GetReactionsReturns added in v5.3.0 

type Z_GetReactionsReturns struct {
	A []*model.Reaction
	B *model.AppError
}

type Z_GetServerVersionArgs added in v5.4.0 

type Z_GetServerVersionArgs struct {
}

type Z_GetServerVersionReturns added in v5.4.0 

type Z_GetServerVersionReturns struct {
	A string
}

type Z_GetSessionArgs added in v5.2.0 

type Z_GetSessionArgs struct {
	A string
}

type Z_GetSessionReturns added in v5.2.0 

type Z_GetSessionReturns struct {
	A *model.Session
	B *model.AppError
}

type Z_GetTeamArgs added in v5.2.0 

type Z_GetTeamArgs struct {
	A string
}

type Z_GetTeamByNameArgs added in v5.2.0 

type Z_GetTeamByNameArgs struct {
	A string
}

type Z_GetTeamByNameReturns added in v5.2.0 

type Z_GetTeamByNameReturns struct {
	A *model.Team
	B *model.AppError
}

type Z_GetTeamIconArgs added in v5.6.0 

type Z_GetTeamIconArgs struct {
	A string
}

type Z_GetTeamIconReturns added in v5.6.0 

type Z_GetTeamIconReturns struct {
	A []byte
	B *model.AppError
}

type Z_GetTeamMemberArgs added in v5.2.0 

type Z_GetTeamMemberArgs struct {
	A string
	B string
}

type Z_GetTeamMemberReturns added in v5.2.0 

type Z_GetTeamMemberReturns struct {
	A *model.TeamMember
	B *model.AppError
}

type Z_GetTeamMembersArgs added in v5.2.0 

type Z_GetTeamMembersArgs struct {
	A string
	B int
	C int
}

type Z_GetTeamMembersReturns added in v5.2.0 

type Z_GetTeamMembersReturns struct {
	A []*model.TeamMember
	B *model.AppError
}

type Z_GetTeamReturns added in v5.2.0 

type Z_GetTeamReturns struct {
	A *model.Team
	B *model.AppError
}

type Z_GetTeamStatsArgs added in v5.8.0 

type Z_GetTeamStatsArgs struct {
	A string
}

type Z_GetTeamStatsReturns added in v5.8.0 

type Z_GetTeamStatsReturns struct {
	A *model.TeamStats
	B *model.AppError
}

type Z_GetTeamsArgs added in v5.2.0 

type Z_GetTeamsArgs struct {
}

type Z_GetTeamsForUserArgs added in v5.6.0 

type Z_GetTeamsForUserArgs struct {
	A string
}

type Z_GetTeamsForUserReturns added in v5.6.0 

type Z_GetTeamsForUserReturns struct {
	A []*model.Team
	B *model.AppError
}

type Z_GetTeamsReturns added in v5.2.0 

type Z_GetTeamsReturns struct {
	A []*model.Team
	B *model.AppError
}

type Z_GetTeamsUnreadForUserArgs added in v5.6.0 

type Z_GetTeamsUnreadForUserArgs struct {
	A string
}

type Z_GetTeamsUnreadForUserReturns added in v5.6.0 

type Z_GetTeamsUnreadForUserReturns struct {
	A []*model.TeamUnread
	B *model.AppError
}

type Z_GetUserArgs added in v5.2.0 

type Z_GetUserArgs struct {
	A string
}

type Z_GetUserByEmailArgs added in v5.2.0 

type Z_GetUserByEmailArgs struct {
	A string
}

type Z_GetUserByEmailReturns added in v5.2.0 

type Z_GetUserByEmailReturns struct {
	A *model.User
	B *model.AppError
}

type Z_GetUserByUsernameArgs added in v5.2.0 

type Z_GetUserByUsernameArgs struct {
	A string
}

type Z_GetUserByUsernameReturns added in v5.2.0 

type Z_GetUserByUsernameReturns struct {
	A *model.User
	B *model.AppError
}

type Z_GetUserReturns added in v5.2.0 

type Z_GetUserReturns struct {
	A *model.User
	B *model.AppError
}

type Z_GetUserStatusArgs added in v5.2.0 

type Z_GetUserStatusArgs struct {
	A string
}

type Z_GetUserStatusReturns added in v5.2.0 

type Z_GetUserStatusReturns struct {
	A *model.Status
	B *model.AppError
}

type Z_GetUserStatusesByIdsArgs added in v5.2.0 

type Z_GetUserStatusesByIdsArgs struct {
	A []string
}

type Z_GetUserStatusesByIdsReturns added in v5.2.0 

type Z_GetUserStatusesByIdsReturns struct {
	A []*model.Status
	B *model.AppError
}

type Z_GetUsersByUsernamesArgs added in v5.6.0 

type Z_GetUsersByUsernamesArgs struct {
	A []string
}

type Z_GetUsersByUsernamesReturns added in v5.6.0 

type Z_GetUsersByUsernamesReturns struct {
	A []*model.User
	B *model.AppError
}

type Z_GetUsersInChannelArgs added in v5.6.0 

type Z_GetUsersInChannelArgs struct {
	A string
	B string
	C int
	D int
}

type Z_GetUsersInChannelReturns added in v5.6.0 

type Z_GetUsersInChannelReturns struct {
	A []*model.User
	B *model.AppError
}

type Z_GetUsersInTeamArgs added in v5.6.0 

type Z_GetUsersInTeamArgs struct {
	A string
	B int
	C int
}

type Z_GetUsersInTeamReturns added in v5.6.0 

type Z_GetUsersInTeamReturns struct {
	A []*model.User
	B *model.AppError
}

type Z_HasPermissionToArgs added in v5.3.0 

type Z_HasPermissionToArgs struct {
	A string
	B *model.Permission
}

type Z_HasPermissionToChannelArgs added in v5.3.0 

type Z_HasPermissionToChannelArgs struct {
	A string
	B string
	C *model.Permission
}

type Z_HasPermissionToChannelReturns added in v5.3.0 

type Z_HasPermissionToChannelReturns struct {
	A bool
}

type Z_HasPermissionToReturns added in v5.3.0 

type Z_HasPermissionToReturns struct {
	A bool
}

type Z_HasPermissionToTeamArgs added in v5.3.0 

type Z_HasPermissionToTeamArgs struct {
	A string
	B string
	C *model.Permission
}

type Z_HasPermissionToTeamReturns added in v5.3.0 

type Z_HasPermissionToTeamReturns struct {
	A bool
}

type Z_KVDeleteAllArgs added in v5.6.0 

type Z_KVDeleteAllArgs struct {
}

type Z_KVDeleteAllReturns added in v5.6.0 

type Z_KVDeleteAllReturns struct {
	A *model.AppError
}

type Z_KVDeleteArgs added in v5.2.0 

type Z_KVDeleteArgs struct {
	A string
}

type Z_KVDeleteReturns added in v5.2.0 

type Z_KVDeleteReturns struct {
	A *model.AppError
}

type Z_KVGetArgs added in v5.2.0 

type Z_KVGetArgs struct {
	A string
}

type Z_KVGetReturns added in v5.2.0 

type Z_KVGetReturns struct {
	A []byte
	B *model.AppError
}

type Z_KVListArgs added in v5.6.0 

type Z_KVListArgs struct {
	A int
	B int
}

type Z_KVListReturns added in v5.6.0 

type Z_KVListReturns struct {
	A []string
	B *model.AppError
}

type Z_KVSetArgs added in v5.2.0 

type Z_KVSetArgs struct {
	A string
	B []byte
}

type Z_KVSetReturns added in v5.2.0 

type Z_KVSetReturns struct {
	A *model.AppError
}

type Z_KVSetWithExpiryArgs added in v5.6.0 

type Z_KVSetWithExpiryArgs struct {
	A string
	B []byte
	C int64
}

type Z_KVSetWithExpiryReturns added in v5.6.0 

type Z_KVSetWithExpiryReturns struct {
	A *model.AppError
}

type Z_LoadPluginConfigurationArgsArgs added in v5.2.0 

type Z_LoadPluginConfigurationArgsArgs struct {
}

type Z_LoadPluginConfigurationArgsReturns added in v5.2.0 

type Z_LoadPluginConfigurationArgsReturns struct {
	A []byte
}

type Z_LogDebugArgs added in v5.2.0 

type Z_LogDebugArgs struct {
	A string
	B []interface{}
}

type Z_LogDebugReturns added in v5.2.0 

type Z_LogDebugReturns struct {
}

type Z_LogErrorArgs added in v5.2.0 

type Z_LogErrorArgs struct {
	A string
	B []interface{}
}

type Z_LogErrorReturns added in v5.2.0 

type Z_LogErrorReturns struct {
}

type Z_LogInfoArgs added in v5.2.0 

type Z_LogInfoArgs struct {
	A string
	B []interface{}
}

type Z_LogInfoReturns added in v5.2.0 

type Z_LogInfoReturns struct {
}

type Z_LogWarnArgs added in v5.2.0 

type Z_LogWarnArgs struct {
	A string
	B []interface{}
}

type Z_LogWarnReturns added in v5.2.0 

type Z_LogWarnReturns struct {
}

type Z_MessageHasBeenPostedArgs added in v5.2.0 

type Z_MessageHasBeenPostedArgs struct {
	A *Context
	B *model.Post
}

type Z_MessageHasBeenPostedReturns added in v5.2.0 

type Z_MessageHasBeenPostedReturns struct {
}

type Z_MessageHasBeenUpdatedArgs added in v5.2.0 

type Z_MessageHasBeenUpdatedArgs struct {
	A *Context
	B *model.Post
	C *model.Post
}

type Z_MessageHasBeenUpdatedReturns added in v5.2.0 

type Z_MessageHasBeenUpdatedReturns struct {
}

type Z_MessageWillBePostedArgs added in v5.2.0 

type Z_MessageWillBePostedArgs struct {
	A *Context
	B *model.Post
}

type Z_MessageWillBePostedReturns added in v5.2.0 

type Z_MessageWillBePostedReturns struct {
	A *model.Post
	B string
}

type Z_MessageWillBeUpdatedArgs added in v5.2.0 

type Z_MessageWillBeUpdatedArgs struct {
	A *Context
	B *model.Post
	C *model.Post
}

type Z_MessageWillBeUpdatedReturns added in v5.2.0 

type Z_MessageWillBeUpdatedReturns struct {
	A *model.Post
	B string
}

type Z_OnActivateArgs added in v5.2.0 

type Z_OnActivateArgs struct {
	APIMuxId uint32
}

type Z_OnActivateReturns added in v5.2.0 

type Z_OnActivateReturns struct {
	A error
}

type Z_OnConfigurationChangeArgs added in v5.2.0 

type Z_OnConfigurationChangeArgs struct {
}

type Z_OnConfigurationChangeReturns added in v5.2.0 

type Z_OnConfigurationChangeReturns struct {
	A error
}

type Z_OnDeactivateArgs added in v5.2.0 

type Z_OnDeactivateArgs struct {
}

type Z_OnDeactivateReturns added in v5.2.0 

type Z_OnDeactivateReturns struct {
	A error
}

type Z_OpenInteractiveDialogArgs added in v5.6.0 

type Z_OpenInteractiveDialogArgs struct {
	A model.OpenDialogRequest
}

type Z_OpenInteractiveDialogReturns added in v5.6.0 

type Z_OpenInteractiveDialogReturns struct {
	A *model.AppError
}

type Z_PublishWebSocketEventArgs added in v5.2.0 

type Z_PublishWebSocketEventArgs struct {
	A string
	B map[string]interface{}
	C *model.WebsocketBroadcast
}

type Z_PublishWebSocketEventReturns added in v5.2.0 

type Z_PublishWebSocketEventReturns struct {
}

type Z_ReadFileArgs added in v5.3.0 

type Z_ReadFileArgs struct {
	A string
}

type Z_ReadFileReturns added in v5.3.0 

type Z_ReadFileReturns struct {
	A []byte
	B *model.AppError
}

type Z_RegisterCommandArgs added in v5.2.0 

type Z_RegisterCommandArgs struct {
	A *model.Command
}

type Z_RegisterCommandReturns added in v5.2.0 

type Z_RegisterCommandReturns struct {
	A error
}

type Z_RemovePluginArgs added in v5.6.0 

type Z_RemovePluginArgs struct {
	A string
}

type Z_RemovePluginReturns added in v5.6.0 

type Z_RemovePluginReturns struct {
	A *model.AppError
}

type Z_RemoveReactionArgs added in v5.3.0 

type Z_RemoveReactionArgs struct {
	A *model.Reaction
}

type Z_RemoveReactionReturns added in v5.3.0 

type Z_RemoveReactionReturns struct {
	A *model.AppError
}

type Z_RemoveTeamIconArgs added in v5.6.0 

type Z_RemoveTeamIconArgs struct {
	A string
}

type Z_RemoveTeamIconReturns added in v5.6.0 

type Z_RemoveTeamIconReturns struct {
	A *model.AppError
}

type Z_SaveConfigArgs added in v5.2.0 

type Z_SaveConfigArgs struct {
	A *model.Config
}

type Z_SaveConfigReturns added in v5.2.0 

type Z_SaveConfigReturns struct {
	A *model.AppError
}

type Z_SavePluginConfigArgs added in v5.6.0 

type Z_SavePluginConfigArgs struct {
	A map[string]interface{}
}

type Z_SavePluginConfigReturns added in v5.6.0 

type Z_SavePluginConfigReturns struct {
	A *model.AppError
}

type Z_SearchChannelsArgs added in v5.6.0 

type Z_SearchChannelsArgs struct {
	A string
	B string
}

type Z_SearchChannelsReturns added in v5.6.0 

type Z_SearchChannelsReturns struct {
	A []*model.Channel
	B *model.AppError
}

type Z_SearchTeamsArgs added in v5.8.0 

type Z_SearchTeamsArgs struct {
	A string
}

type Z_SearchTeamsReturns added in v5.8.0 

type Z_SearchTeamsReturns struct {
	A []*model.Team
	B *model.AppError
}

type Z_SearchUsersArgs added in v5.8.0 

type Z_SearchUsersArgs struct {
	A *model.UserSearch
}

type Z_SearchUsersReturns added in v5.8.0 

type Z_SearchUsersReturns struct {
	A []*model.User
	B *model.AppError
}

type Z_SendEphemeralPostArgs added in v5.2.0 

type Z_SendEphemeralPostArgs struct {
	A string
	B *model.Post
}

type Z_SendEphemeralPostReturns added in v5.2.0 

type Z_SendEphemeralPostReturns struct {
	A *model.Post
}

type Z_SendMailArgs added in v5.7.0 

type Z_SendMailArgs struct {
	A string
	B string
	C string
}

type Z_SendMailReturns added in v5.7.0 

type Z_SendMailReturns struct {
	A *model.AppError
}

type Z_ServeHTTPArgs added in v5.2.0 

type Z_ServeHTTPArgs struct {
	ResponseWriterStream uint32
	Request              *http.Request
	Context              *Context
	RequestBodyStream    uint32
}

type Z_SetProfileImageArgs added in v5.6.0 

type Z_SetProfileImageArgs struct {
	A string
	B []byte
}

type Z_SetProfileImageReturns added in v5.6.0 

type Z_SetProfileImageReturns struct {
	A *model.AppError
}

type Z_SetTeamIconArgs added in v5.6.0 

type Z_SetTeamIconArgs struct {
	A string
	B []byte
}

type Z_SetTeamIconReturns added in v5.6.0 

type Z_SetTeamIconReturns struct {
	A *model.AppError
}

type Z_UnregisterCommandArgs added in v5.2.0 

type Z_UnregisterCommandArgs struct {
	A string
	B string
}

type Z_UnregisterCommandReturns added in v5.2.0 

type Z_UnregisterCommandReturns struct {
	A error
}

type Z_UpdateChannelArgs added in v5.2.0 

type Z_UpdateChannelArgs struct {
	A *model.Channel
}

type Z_UpdateChannelMemberNotificationsArgs added in v5.2.0 

type Z_UpdateChannelMemberNotificationsArgs struct {
	A string
	B string
	C map[string]string
}

type Z_UpdateChannelMemberNotificationsReturns added in v5.2.0 

type Z_UpdateChannelMemberNotificationsReturns struct {
	A *model.ChannelMember
	B *model.AppError
}

type Z_UpdateChannelMemberRolesArgs added in v5.2.0 

type Z_UpdateChannelMemberRolesArgs struct {
	A string
	B string
	C string
}

type Z_UpdateChannelMemberRolesReturns added in v5.2.0 

type Z_UpdateChannelMemberRolesReturns struct {
	A *model.ChannelMember
	B *model.AppError
}

type Z_UpdateChannelReturns added in v5.2.0 

type Z_UpdateChannelReturns struct {
	A *model.Channel
	B *model.AppError
}

type Z_UpdatePostArgs added in v5.2.0 

type Z_UpdatePostArgs struct {
	A *model.Post
}

type Z_UpdatePostReturns added in v5.2.0 

type Z_UpdatePostReturns struct {
	A *model.Post
	B *model.AppError
}

type Z_UpdateTeamArgs added in v5.2.0 

type Z_UpdateTeamArgs struct {
	A *model.Team
}

type Z_UpdateTeamMemberRolesArgs added in v5.2.0 

type Z_UpdateTeamMemberRolesArgs struct {
	A string
	B string
	C string
}

type Z_UpdateTeamMemberRolesReturns added in v5.2.0 

type Z_UpdateTeamMemberRolesReturns struct {
	A *model.TeamMember
	B *model.AppError
}

type Z_UpdateTeamReturns added in v5.2.0 

type Z_UpdateTeamReturns struct {
	A *model.Team
	B *model.AppError
}

type Z_UpdateUserActiveArgs added in v5.8.0 

type Z_UpdateUserActiveArgs struct {
	A string
	B bool
}

type Z_UpdateUserActiveReturns added in v5.8.0 

type Z_UpdateUserActiveReturns struct {
	A *model.AppError
}

type Z_UpdateUserArgs added in v5.2.0 

type Z_UpdateUserArgs struct {
	A *model.User
}

type Z_UpdateUserReturns added in v5.2.0 

type Z_UpdateUserReturns struct {
	A *model.User
	B *model.AppError
}

type Z_UpdateUserStatusArgs added in v5.2.0 

type Z_UpdateUserStatusArgs struct {
	A string
	B string
}

type Z_UpdateUserStatusReturns added in v5.2.0 

type Z_UpdateUserStatusReturns struct {
	A *model.Status
	B *model.AppError
}

type Z_UploadFileArgs added in v5.6.0 

type Z_UploadFileArgs struct {
	A []byte
	B string
	C string
}

type Z_UploadFileReturns added in v5.6.0 

type Z_UploadFileReturns struct {
	A *model.FileInfo
	B *model.AppError
}

type Z_UserHasJoinedChannelArgs added in v5.2.0 

type Z_UserHasJoinedChannelArgs struct {
	A *Context
	B *model.ChannelMember
	C *model.User
}

type Z_UserHasJoinedChannelReturns added in v5.2.0 

type Z_UserHasJoinedChannelReturns struct {
}

type Z_UserHasJoinedTeamArgs added in v5.2.0 

type Z_UserHasJoinedTeamArgs struct {
	A *Context
	B *model.TeamMember
	C *model.User
}

type Z_UserHasJoinedTeamReturns added in v5.2.0 

type Z_UserHasJoinedTeamReturns struct {
}

type Z_UserHasLeftChannelArgs added in v5.2.0 

type Z_UserHasLeftChannelArgs struct {
	A *Context
	B *model.ChannelMember
	C *model.User
}

type Z_UserHasLeftChannelReturns added in v5.2.0 

type Z_UserHasLeftChannelReturns struct {
}

type Z_UserHasLeftTeamArgs added in v5.2.0 

type Z_UserHasLeftTeamArgs struct {
	A *Context
	B *model.TeamMember
	C *model.User
}

type Z_UserHasLeftTeamReturns added in v5.2.0 

type Z_UserHasLeftTeamReturns struct {
}

type Z_UserHasLoggedInArgs added in v5.2.0 

type Z_UserHasLoggedInArgs struct {
	A *Context
	B *model.User
}

type Z_UserHasLoggedInReturns added in v5.2.0 

type Z_UserHasLoggedInReturns struct {
}

type Z_UserWillLogInArgs added in v5.2.0 

type Z_UserWillLogInArgs struct {
	A *Context
	B *model.User
}

type Z_UserWillLogInReturns added in v5.2.0 

type Z_UserWillLogInReturns struct {
	A string
}

Source Files

View all Source files

Directories

Path Synopsis
The plugintest package provides mocks that can be used to test plugins.
 The plugintest package provides mocks that can be used to test plugins.
mock
This package provides aliases for the contents of "github.com/stretchr/testify/mock".
 This package provides aliases for the contents of "github.com/stretchr/testify/mock".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.