ec1f89217a
Full Mattermost server source with integrated Community Enterprise features. Includes vendor directory for offline/air-gapped builds. Structure: - enterprise-impl/: Enterprise feature implementations - enterprise-community/: Init files that register implementations - enterprise/: Bridge imports (community_imports.go) - vendor/: All dependencies for offline builds Build (online): go build ./cmd/mattermost Build (offline/air-gapped): go build -mod=vendor ./cmd/mattermost 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1574 lines
52 KiB
Go
1574 lines
52 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"io"
|
|
"net/http"
|
|
|
|
plugin "github.com/hashicorp/go-plugin"
|
|
|
|
"github.com/mattermost/mattermost/server/public/model"
|
|
"github.com/mattermost/mattermost/server/public/shared/mlog"
|
|
)
|
|
|
|
// 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 API interface {
|
|
// LoadPluginConfiguration loads the plugin's configuration. dest should be a pointer to a
|
|
// struct that the configuration JSON can be unmarshalled to.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.2
|
|
LoadPluginConfiguration(dest any) error
|
|
|
|
// RegisterCommand registers a custom slash command. When the command is triggered, your plugin
|
|
// can fulfill it via the ExecuteCommand hook.
|
|
//
|
|
// @tag Command
|
|
// Minimum server version: 5.2
|
|
RegisterCommand(command *model.Command) error
|
|
|
|
// UnregisterCommand unregisters a command previously register via RegisterCommand.
|
|
//
|
|
// @tag Command
|
|
// Minimum server version: 5.2
|
|
UnregisterCommand(teamID, trigger string) error
|
|
|
|
// ExecuteSlashCommand executes a slash command with the given parameters.
|
|
//
|
|
// @tag Command
|
|
// Minimum server version: 5.26
|
|
ExecuteSlashCommand(commandArgs *model.CommandArgs) (*model.CommandResponse, error)
|
|
|
|
// GetConfig fetches the currently persisted config
|
|
//
|
|
// @tag Configuration
|
|
// Minimum server version: 5.2
|
|
GetConfig() *model.Config
|
|
|
|
// GetUnsanitizedConfig fetches the currently persisted config without removing secrets.
|
|
//
|
|
// @tag Configuration
|
|
// Minimum server version: 5.16
|
|
GetUnsanitizedConfig() *model.Config
|
|
|
|
// SaveConfig sets the given config and persists the changes
|
|
//
|
|
// @tag Configuration
|
|
// Minimum server version: 5.2
|
|
SaveConfig(config *model.Config) *model.AppError
|
|
|
|
// GetPluginConfig fetches the currently persisted config of plugin
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
GetPluginConfig() map[string]any
|
|
|
|
// SavePluginConfig sets the given config for plugin and persists the changes
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
SavePluginConfig(config map[string]any) *model.AppError
|
|
|
|
// GetBundlePath returns the absolute path where the plugin's bundle was unpacked.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.10
|
|
GetBundlePath() (string, error)
|
|
|
|
// GetLicense returns the current license used by the Mattermost server. Returns nil if
|
|
// the server does not have a license.
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.10
|
|
GetLicense() *model.License
|
|
|
|
// IsEnterpriseReady returns true if the Mattermost server is configured as Enterprise Ready.
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.10
|
|
IsEnterpriseReady() bool
|
|
|
|
// GetServerVersion return the current Mattermost server version
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.4
|
|
GetServerVersion() string
|
|
|
|
// GetSystemInstallDate returns the time that Mattermost was first installed and ran.
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.10
|
|
GetSystemInstallDate() (int64, *model.AppError)
|
|
|
|
// GetDiagnosticId returns a unique identifier used by the server for diagnostic reports.
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.10
|
|
GetDiagnosticId() string
|
|
|
|
// GetTelemetryId returns a unique identifier used by the server for telemetry reports.
|
|
//
|
|
// @tag Server
|
|
// Minimum server version: 5.28
|
|
GetTelemetryId() string
|
|
|
|
// CreateUser creates a user.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
CreateUser(user *model.User) (*model.User, *model.AppError)
|
|
|
|
// DeleteUser deletes a user.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
DeleteUser(userID string) *model.AppError
|
|
|
|
// GetUsers a list of users based on search options.
|
|
//
|
|
// Not all fields in UserGetOptions are supported by this API.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.10
|
|
GetUsers(options *model.UserGetOptions) ([]*model.User, *model.AppError)
|
|
|
|
// GetUsersByIds gets a list of users by their IDs.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 9.8
|
|
GetUsersByIds(userIDs []string) ([]*model.User, *model.AppError)
|
|
|
|
// GetUser gets a user.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetUser(userID string) (*model.User, *model.AppError)
|
|
|
|
// GetUserByEmail gets a user by their email address.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetUserByEmail(email string) (*model.User, *model.AppError)
|
|
|
|
// GetUserByUsername gets a user by their username.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetUserByUsername(name string) (*model.User, *model.AppError)
|
|
|
|
// GetUsersByUsernames gets users by their usernames.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetUsersByUsernames(usernames []string) ([]*model.User, *model.AppError)
|
|
|
|
// GetUsersInTeam gets users in team.
|
|
//
|
|
// @tag User
|
|
// @tag Team
|
|
// Minimum server version: 5.6
|
|
GetUsersInTeam(teamID string, page int, perPage int) ([]*model.User, *model.AppError)
|
|
|
|
// GetPreferenceForUser gets a single preference for a user. An error is returned if the user has no preference
|
|
// set with the given category and name, an error is returned.
|
|
//
|
|
// @tag User
|
|
// @tag Preference
|
|
// Minimum server version: 9.5
|
|
GetPreferenceForUser(userID, category, name string) (model.Preference, *model.AppError)
|
|
|
|
// GetPreferencesForUser gets a user's preferences.
|
|
//
|
|
// @tag User
|
|
// @tag Preference
|
|
// Minimum server version: 5.26
|
|
GetPreferencesForUser(userID string) ([]model.Preference, *model.AppError)
|
|
|
|
// UpdatePreferencesForUser updates a user's preferences.
|
|
//
|
|
// @tag User
|
|
// @tag Preference
|
|
// Minimum server version: 5.26
|
|
UpdatePreferencesForUser(userID string, preferences []model.Preference) *model.AppError
|
|
|
|
// DeletePreferencesForUser deletes a user's preferences.
|
|
//
|
|
// @tag User
|
|
// @tag Preference
|
|
// Minimum server version: 5.26
|
|
DeletePreferencesForUser(userID string, preferences []model.Preference) *model.AppError
|
|
|
|
// GetSession returns the session object for the Session ID
|
|
//
|
|
//
|
|
// Minimum server version: 5.2
|
|
GetSession(sessionID string) (*model.Session, *model.AppError)
|
|
|
|
// CreateSession creates a new user session.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 6.2
|
|
CreateSession(session *model.Session) (*model.Session, *model.AppError)
|
|
|
|
// ExtendSessionExpiry extends the duration of an existing session.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 6.2
|
|
ExtendSessionExpiry(sessionID string, newExpiry int64) *model.AppError
|
|
|
|
// RevokeSession revokes an existing user session.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 6.2
|
|
RevokeSession(sessionID string) *model.AppError
|
|
|
|
// CreateUserAccessToken creates a new access token.
|
|
// @tag User
|
|
// Minimum server version: 5.38
|
|
CreateUserAccessToken(token *model.UserAccessToken) (*model.UserAccessToken, *model.AppError)
|
|
|
|
// RevokeUserAccessToken revokes an existing access token.
|
|
// @tag User
|
|
// Minimum server version: 5.38
|
|
RevokeUserAccessToken(tokenID string) *model.AppError
|
|
|
|
// GetTeamIcon gets the team icon.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.6
|
|
GetTeamIcon(teamID string) ([]byte, *model.AppError)
|
|
|
|
// SetTeamIcon sets the team icon.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.6
|
|
SetTeamIcon(teamID string, data []byte) *model.AppError
|
|
|
|
// RemoveTeamIcon removes the team icon.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.6
|
|
RemoveTeamIcon(teamID string) *model.AppError
|
|
|
|
// UpdateUser updates a user.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
UpdateUser(user *model.User) (*model.User, *model.AppError)
|
|
|
|
// GetUserStatus will get a user's status.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetUserStatus(userID string) (*model.Status, *model.AppError)
|
|
|
|
// GetUserStatusesByIds will return a list of user statuses based on the provided slice of user IDs.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
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".
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
UpdateUserStatus(userID, status string) (*model.Status, *model.AppError)
|
|
|
|
// SetUserStatusTimedDND will set a user's status to dnd for given time until the user,
|
|
// or another integration/plugin, sets it back to online.
|
|
// @tag User
|
|
// Minimum server version: 5.35
|
|
SetUserStatusTimedDND(userId string, endtime int64) (*model.Status, *model.AppError)
|
|
|
|
// UpdateUserActive deactivates or reactivates an user.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.8
|
|
UpdateUserActive(userID string, active bool) *model.AppError
|
|
|
|
// UpdateUserCustomStatus will set a user's custom status until the user, or another integration/plugin, clear it or update the custom status.
|
|
// The custom status have two parameters: emoji icon and custom text.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 6.2
|
|
UpdateUserCustomStatus(userID string, customStatus *model.CustomStatus) *model.AppError
|
|
|
|
// RemoveUserCustomStatus will remove a user's custom status.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 6.2
|
|
RemoveUserCustomStatus(userID string) *model.AppError
|
|
|
|
// GetUsersInChannel returns a page of users in a channel. Page counting starts at 0.
|
|
// The sortBy parameter can be: "username" or "status".
|
|
//
|
|
// @tag User
|
|
// @tag Channel
|
|
// 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.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.3
|
|
GetLDAPUserAttributes(userID string, attributes []string) (map[string]string, *model.AppError)
|
|
|
|
// CreateTeam creates a team.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
CreateTeam(team *model.Team) (*model.Team, *model.AppError)
|
|
|
|
// DeleteTeam deletes a team.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
DeleteTeam(teamID string) *model.AppError
|
|
|
|
// GetTeam gets all teams.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
GetTeams() ([]*model.Team, *model.AppError)
|
|
|
|
// GetTeam gets a team.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
GetTeam(teamID string) (*model.Team, *model.AppError)
|
|
|
|
// GetTeamByName gets a team by its name.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
GetTeamByName(name string) (*model.Team, *model.AppError)
|
|
|
|
// GetTeamsUnreadForUser gets the unread message and mention counts for each team to which the given user belongs.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetTeamsUnreadForUser(userID string) ([]*model.TeamUnread, *model.AppError)
|
|
|
|
// UpdateTeam updates a team.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
UpdateTeam(team *model.Team) (*model.Team, *model.AppError)
|
|
|
|
// SearchTeams search a team.
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.8
|
|
SearchTeams(term string) ([]*model.Team, *model.AppError)
|
|
|
|
// GetTeamsForUser returns list of teams of given user ID.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetTeamsForUser(userID string) ([]*model.Team, *model.AppError)
|
|
|
|
// CreateTeamMember creates a team membership.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
CreateTeamMember(teamID, userID string) (*model.TeamMember, *model.AppError)
|
|
|
|
// CreateTeamMembers creates a team membership for all provided user ids.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
CreateTeamMembers(teamID string, userIds []string, requestorId string) ([]*model.TeamMember, *model.AppError)
|
|
|
|
// CreateTeamMembersGracefully creates a team membership for all provided user ids and reports the users that were not added.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.20
|
|
CreateTeamMembersGracefully(teamID string, userIds []string, requestorId string) ([]*model.TeamMemberWithError, *model.AppError)
|
|
|
|
// DeleteTeamMember deletes a team membership.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
DeleteTeamMember(teamID, userID, requestorId string) *model.AppError
|
|
|
|
// GetTeamMembers returns the memberships of a specific team.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetTeamMembers(teamID string, page, perPage int) ([]*model.TeamMember, *model.AppError)
|
|
|
|
// GetTeamMember returns a specific membership.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetTeamMember(teamID, userID string) (*model.TeamMember, *model.AppError)
|
|
|
|
// GetTeamMembersForUser returns all team memberships for a user.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.10
|
|
GetTeamMembersForUser(userID string, page int, perPage int) ([]*model.TeamMember, *model.AppError)
|
|
|
|
// UpdateTeamMemberRoles updates the role for a team membership.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
UpdateTeamMemberRoles(teamID, userID, newRoles string) (*model.TeamMember, *model.AppError)
|
|
|
|
// CreateChannel creates a channel.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.2
|
|
CreateChannel(channel *model.Channel) (*model.Channel, *model.AppError)
|
|
|
|
// DeleteChannel deletes a channel.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.2
|
|
DeleteChannel(channelId string) *model.AppError
|
|
|
|
// GetPublicChannelsForTeam gets a list of all channels.
|
|
//
|
|
// @tag Channel
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
GetPublicChannelsForTeam(teamID string, page, perPage int) ([]*model.Channel, *model.AppError)
|
|
|
|
// GetChannel gets a channel.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.2
|
|
GetChannel(channelId string) (*model.Channel, *model.AppError)
|
|
|
|
// GetChannelByName gets a channel by its name, given a team id.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.2
|
|
GetChannelByName(teamID, name string, includeDeleted bool) (*model.Channel, *model.AppError)
|
|
|
|
// GetChannelByNameForTeamName gets a channel by its name, given a team name.
|
|
//
|
|
// @tag Channel
|
|
// @tag Team
|
|
// Minimum server version: 5.2
|
|
GetChannelByNameForTeamName(teamName, channelName string, includeDeleted bool) (*model.Channel, *model.AppError)
|
|
|
|
// GetChannelsForTeamForUser gets a list of channels for given user ID in given team ID, including DMs.
|
|
// If an empty string is passed as the team ID, the user's channels on all teams and their DMs will be returned.
|
|
//
|
|
// @tag Channel
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetChannelsForTeamForUser(teamID, userID string, includeDeleted bool) ([]*model.Channel, *model.AppError)
|
|
|
|
// GetChannelStats gets statistics for a channel.
|
|
//
|
|
// @tag 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.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetDirectChannel(userId1, userId2 string) (*model.Channel, *model.AppError)
|
|
|
|
// GetGroupChannel gets a group message channel.
|
|
// If the channel does not exist it will create it.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetGroupChannel(userIds []string) (*model.Channel, *model.AppError)
|
|
|
|
// UpdateChannel updates a channel.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.2
|
|
UpdateChannel(channel *model.Channel) (*model.Channel, *model.AppError)
|
|
|
|
// SearchChannels returns the channels on a team matching the provided search term.
|
|
//
|
|
// @tag Channel
|
|
// Minimum server version: 5.6
|
|
SearchChannels(teamID string, term string) ([]*model.Channel, *model.AppError)
|
|
|
|
// CreateChannelSidebarCategory creates a new sidebar category for a set of channels.
|
|
//
|
|
// @tag ChannelSidebar
|
|
// Minimum server version: 5.38
|
|
CreateChannelSidebarCategory(userID, teamID string, newCategory *model.SidebarCategoryWithChannels) (*model.SidebarCategoryWithChannels, *model.AppError)
|
|
|
|
// GetChannelSidebarCategories returns sidebar categories.
|
|
//
|
|
// @tag ChannelSidebar
|
|
// Minimum server version: 5.38
|
|
GetChannelSidebarCategories(userID, teamID string) (*model.OrderedSidebarCategories, *model.AppError)
|
|
|
|
// UpdateChannelSidebarCategories updates the channel sidebar categories.
|
|
//
|
|
// @tag ChannelSidebar
|
|
// Minimum server version: 5.38
|
|
UpdateChannelSidebarCategories(userID, teamID string, categories []*model.SidebarCategoryWithChannels) ([]*model.SidebarCategoryWithChannels, *model.AppError)
|
|
|
|
// SearchUsers returns a list of users based on some search criteria.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
SearchUsers(search *model.UserSearch) ([]*model.User, *model.AppError)
|
|
|
|
// SearchPostsInTeam returns a list of posts in a specific team that match the given params.
|
|
//
|
|
// @tag Post
|
|
// @tag Team
|
|
// Minimum server version: 5.10
|
|
SearchPostsInTeam(teamID string, paramsList []*model.SearchParams) ([]*model.Post, *model.AppError)
|
|
|
|
// SearchPostsInTeamForUser returns a list of posts by team and user that match the given
|
|
// search parameters.
|
|
// @tag Post
|
|
// Minimum server version: 5.26
|
|
SearchPostsInTeamForUser(teamID string, userID string, searchParams model.SearchParameter) (*model.PostSearchResults, *model.AppError)
|
|
|
|
// AddChannelMember joins a user to a channel (as if they joined themselves)
|
|
// This means the user will not receive notifications for joining the channel.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
AddChannelMember(channelId, userID string) (*model.ChannelMember, *model.AppError)
|
|
|
|
// AddUserToChannel adds a user to a channel as if the specified user had invited them.
|
|
// This means the user will receive the regular notifications for being added to the channel.
|
|
//
|
|
// @tag User
|
|
// @tag Channel
|
|
// Minimum server version: 5.18
|
|
AddUserToChannel(channelId, userID, asUserId string) (*model.ChannelMember, *model.AppError)
|
|
|
|
// GetChannelMember gets a channel membership for a user.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
GetChannelMember(channelId, userID string) (*model.ChannelMember, *model.AppError)
|
|
|
|
// GetChannelMembers gets a channel membership for all users.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetChannelMembers(channelId string, page, perPage int) (model.ChannelMembers, *model.AppError)
|
|
|
|
// GetChannelMembersByIds gets a channel membership for a particular User
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetChannelMembersByIds(channelId string, userIds []string) (model.ChannelMembers, *model.AppError)
|
|
|
|
// GetChannelMembersForUser returns all channel memberships on a team for a user.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.10
|
|
GetChannelMembersForUser(teamID, userID string, page, perPage int) ([]*model.ChannelMember, *model.AppError)
|
|
|
|
// UpdateChannelMemberRoles updates a user's roles for a channel.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
UpdateChannelMemberRoles(channelId, userID, newRoles string) (*model.ChannelMember, *model.AppError)
|
|
|
|
// UpdateChannelMemberNotifications updates a user's notification properties for a channel.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
UpdateChannelMemberNotifications(channelId, userID string, notifications map[string]string) (*model.ChannelMember, *model.AppError)
|
|
|
|
// PatchChannelMembersNotifications updates the notification properties for multiple channel members.
|
|
// Other changes made to the channel memberships will be ignored. A maximum of 200 members can be
|
|
// updated at once.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 9.5
|
|
PatchChannelMembersNotifications(members []*model.ChannelMemberIdentifier, notifyProps map[string]string) *model.AppError
|
|
|
|
// GetGroup gets a group by ID.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 5.18
|
|
GetGroup(groupId string) (*model.Group, *model.AppError)
|
|
|
|
// GetGroupByName gets a group by name.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 5.18
|
|
GetGroupByName(name string) (*model.Group, *model.AppError)
|
|
|
|
// GetGroupMemberUsers gets a page of users belonging to the given group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 5.35
|
|
GetGroupMemberUsers(groupID string, page, perPage int) ([]*model.User, *model.AppError)
|
|
|
|
// GetGroupsBySource gets a list of all groups for the given source.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 5.35
|
|
GetGroupsBySource(groupSource model.GroupSource) ([]*model.Group, *model.AppError)
|
|
|
|
// GetGroupsForUser gets the groups a user is in.
|
|
//
|
|
// @tag Group
|
|
// @tag User
|
|
// Minimum server version: 5.18
|
|
GetGroupsForUser(userID string) ([]*model.Group, *model.AppError)
|
|
|
|
// DeleteChannelMember deletes a channel membership for a user.
|
|
//
|
|
// @tag Channel
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
DeleteChannelMember(channelId, userID string) *model.AppError
|
|
|
|
// CreatePost creates a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
CreatePost(post *model.Post) (*model.Post, *model.AppError)
|
|
|
|
// AddReaction add a reaction to a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.3
|
|
AddReaction(reaction *model.Reaction) (*model.Reaction, *model.AppError)
|
|
|
|
// RemoveReaction remove a reaction from a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.3
|
|
RemoveReaction(reaction *model.Reaction) *model.AppError
|
|
|
|
// GetReaction get the reactions of a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.3
|
|
GetReactions(postId string) ([]*model.Reaction, *model.AppError)
|
|
|
|
// SendEphemeralPost creates an ephemeral post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
SendEphemeralPost(userID string, post *model.Post) *model.Post
|
|
|
|
// UpdateEphemeralPost updates an ephemeral message previously sent to the user.
|
|
// EXPERIMENTAL: This API is experimental and can be changed without advance notice.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
UpdateEphemeralPost(userID string, post *model.Post) *model.Post
|
|
|
|
// DeleteEphemeralPost deletes an ephemeral message previously sent to the user.
|
|
// EXPERIMENTAL: This API is experimental and can be changed without advance notice.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
DeleteEphemeralPost(userID, postId string)
|
|
|
|
// DeletePost deletes a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
DeletePost(postId string) *model.AppError
|
|
|
|
// GetPostThread gets a post with all the other posts in the same thread.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.6
|
|
GetPostThread(postId string) (*model.PostList, *model.AppError)
|
|
|
|
// GetPost gets a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
GetPost(postId string) (*model.Post, *model.AppError)
|
|
|
|
// GetPostsSince gets posts created after a specified time as Unix time in milliseconds.
|
|
//
|
|
// @tag Post
|
|
// @tag Channel
|
|
// 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.
|
|
//
|
|
// @tag Post
|
|
// @tag Channel
|
|
// 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.
|
|
//
|
|
// @tag Post
|
|
// @tag Channel
|
|
// 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.
|
|
//
|
|
// @tag Post
|
|
// @tag Channel
|
|
// Minimum server version: 5.6
|
|
GetPostsForChannel(channelId string, page, perPage int) (*model.PostList, *model.AppError)
|
|
|
|
// GetTeamStats gets a team's statistics
|
|
//
|
|
// @tag Team
|
|
// Minimum server version: 5.8
|
|
GetTeamStats(teamID string) (*model.TeamStats, *model.AppError)
|
|
|
|
// UpdatePost updates a post.
|
|
//
|
|
// @tag Post
|
|
// Minimum server version: 5.2
|
|
UpdatePost(post *model.Post) (*model.Post, *model.AppError)
|
|
|
|
// GetProfileImage gets user's profile image.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.6
|
|
GetProfileImage(userID string) ([]byte, *model.AppError)
|
|
|
|
// SetProfileImage sets a user's profile image.
|
|
//
|
|
// @tag User
|
|
// 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".
|
|
//
|
|
// @tag Emoji
|
|
// Minimum server version: 5.6
|
|
GetEmojiList(sortBy string, page, perPage int) ([]*model.Emoji, *model.AppError)
|
|
|
|
// GetEmojiByName gets an emoji by it's name.
|
|
//
|
|
// @tag Emoji
|
|
// Minimum server version: 5.6
|
|
GetEmojiByName(name string) (*model.Emoji, *model.AppError)
|
|
|
|
// GetEmoji returns a custom emoji based on the emojiId string.
|
|
//
|
|
// @tag Emoji
|
|
// 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.
|
|
//
|
|
// @tag File
|
|
// @tag User
|
|
// Minimum server version: 5.2
|
|
CopyFileInfos(userID string, fileIds []string) ([]string, *model.AppError)
|
|
|
|
// GetFileInfo gets a File Info for a specific fileId
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 5.3
|
|
GetFileInfo(fileId string) (*model.FileInfo, *model.AppError)
|
|
|
|
// SetFileSearchableContent update the File Info searchable text for full text search
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 9.1
|
|
SetFileSearchableContent(fileID string, content string) *model.AppError
|
|
|
|
// GetFileInfos gets File Infos with options
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 5.22
|
|
GetFileInfos(page, perPage int, opt *model.GetFileInfosOptions) ([]*model.FileInfo, *model.AppError)
|
|
|
|
// GetFile gets content of a file by it's ID
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 5.8
|
|
GetFile(fileId string) ([]byte, *model.AppError)
|
|
|
|
// GetFileLink gets the public link to a file by fileId.
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 5.6
|
|
GetFileLink(fileId string) (string, *model.AppError)
|
|
|
|
// ReadFile reads the file from the backend for a specific path
|
|
//
|
|
// @tag File
|
|
// Minimum server version: 5.3
|
|
ReadFile(path string) ([]byte, *model.AppError)
|
|
|
|
// GetEmojiImage returns the emoji image.
|
|
//
|
|
// @tag Emoji
|
|
// 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.
|
|
//
|
|
// @tag File
|
|
// @tag Channel
|
|
// 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
|
|
|
|
// Plugin Section
|
|
|
|
// GetPlugins will return a list of plugin manifests for currently active plugins.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
GetPlugins() ([]*model.Manifest, *model.AppError)
|
|
|
|
// EnablePlugin will enable an plugin installed.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
EnablePlugin(id string) *model.AppError
|
|
|
|
// DisablePlugin will disable an enabled plugin.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
DisablePlugin(id string) *model.AppError
|
|
|
|
// RemovePlugin will disable and delete a plugin.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
RemovePlugin(id string) *model.AppError
|
|
|
|
// GetPluginStatus will return the status of a plugin.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.6
|
|
GetPluginStatus(id string) (*model.PluginStatus, *model.AppError)
|
|
|
|
// InstallPlugin will upload another plugin with tar.gz file.
|
|
// Previous version will be replaced on replace true.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 5.18
|
|
InstallPlugin(file io.Reader, replace bool) (*model.Manifest, *model.AppError)
|
|
|
|
// KV Store Section
|
|
|
|
// KVSet stores a key-value pair, unique per plugin.
|
|
// Provided helper functions and internal plugin code will use the prefix `mmi_` before keys. Do not use this prefix.
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.2
|
|
KVSet(key string, value []byte) *model.AppError
|
|
|
|
// KVCompareAndSet updates a key-value pair, unique per plugin, but only if the current value matches the given oldValue.
|
|
// Inserts a new key if oldValue == nil.
|
|
// Returns (false, err) if DB error occurred
|
|
// Returns (false, nil) if current value != oldValue or key already exists when inserting
|
|
// Returns (true, nil) if current value == oldValue or new key is inserted
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.12
|
|
KVCompareAndSet(key string, oldValue, newValue []byte) (bool, *model.AppError)
|
|
|
|
// KVCompareAndDelete deletes a key-value pair, unique per plugin, but only if the current value matches the given oldValue.
|
|
// Returns (false, err) if DB error occurred
|
|
// Returns (false, nil) if current value != oldValue or key does not exist when deleting
|
|
// Returns (true, nil) if current value == oldValue and the key was deleted
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.16
|
|
KVCompareAndDelete(key string, oldValue []byte) (bool, *model.AppError)
|
|
|
|
// KVSetWithOptions stores a key-value pair, unique per plugin, according to the given options.
|
|
// Returns (false, err) if DB error occurred
|
|
// Returns (false, nil) if the value was not set
|
|
// Returns (true, nil) if the value was set
|
|
//
|
|
// Minimum server version: 5.20
|
|
KVSetWithOptions(key string, value []byte, options model.PluginKVSetOptions) (bool, *model.AppError)
|
|
|
|
// KVSet stores a key-value pair with an expiry time, unique per plugin.
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.6
|
|
KVSetWithExpiry(key string, value []byte, expireInSeconds int64) *model.AppError
|
|
|
|
// KVGet retrieves a value based on the key, unique per plugin. Returns nil for non-existent keys.
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.2
|
|
KVGet(key string) ([]byte, *model.AppError)
|
|
|
|
// KVDelete removes a key-value pair, unique per plugin. Returns nil for non-existent keys.
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.2
|
|
KVDelete(key string) *model.AppError
|
|
|
|
// KVDeleteAll removes all key-value pairs for a plugin.
|
|
//
|
|
// @tag KeyValueStore
|
|
// Minimum server version: 5.6
|
|
KVDeleteAll() *model.AppError
|
|
|
|
// KVList lists all keys for a plugin.
|
|
//
|
|
// @tag KeyValueStore
|
|
// 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.
|
|
//
|
|
// Minimum server version: 5.2
|
|
PublishWebSocketEvent(event string, payload map[string]any, broadcast *model.WebsocketBroadcast)
|
|
|
|
// HasPermissionTo check if the user has the permission at system scope.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.3
|
|
HasPermissionTo(userID string, permission *model.Permission) bool
|
|
|
|
// HasPermissionToTeam check if the user has the permission at team scope.
|
|
//
|
|
// @tag User
|
|
// @tag Team
|
|
// Minimum server version: 5.3
|
|
HasPermissionToTeam(userID, teamID string, permission *model.Permission) bool
|
|
|
|
// HasPermissionToChannel check if the user has the permission at channel scope.
|
|
//
|
|
// @tag User
|
|
// @tag Channel
|
|
// Minimum server version: 5.3
|
|
HasPermissionToChannel(userID, channelId string, permission *model.Permission) bool
|
|
|
|
// RolesGrantPermission check if the specified roles grant the specified permission
|
|
//
|
|
// Minimum server version: 6.3
|
|
RolesGrantPermission(roleNames []string, permissionId string) 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.
|
|
//
|
|
// @tag Logging
|
|
// Minimum server version: 5.2
|
|
LogDebug(msg string, keyValuePairs ...any)
|
|
|
|
// 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.
|
|
//
|
|
// @tag Logging
|
|
// Minimum server version: 5.2
|
|
LogInfo(msg string, keyValuePairs ...any)
|
|
|
|
// 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.
|
|
//
|
|
// @tag Logging
|
|
// Minimum server version: 5.2
|
|
LogError(msg string, keyValuePairs ...any)
|
|
|
|
// 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.
|
|
//
|
|
// @tag Logging
|
|
// Minimum server version: 5.2
|
|
LogWarn(msg string, keyValuePairs ...any)
|
|
|
|
// SendMail sends an email to a specific address
|
|
//
|
|
// Minimum server version: 5.7
|
|
SendMail(to, subject, htmlBody string) *model.AppError
|
|
|
|
// CreateBot creates the given bot and corresponding user.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
CreateBot(bot *model.Bot) (*model.Bot, *model.AppError)
|
|
|
|
// PatchBot applies the given patch to the bot and corresponding user.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
PatchBot(botUserId string, botPatch *model.BotPatch) (*model.Bot, *model.AppError)
|
|
|
|
// GetBot returns the given bot.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
GetBot(botUserId string, includeDeleted bool) (*model.Bot, *model.AppError)
|
|
|
|
// GetBots returns the requested page of bots.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
GetBots(options *model.BotGetOptions) ([]*model.Bot, *model.AppError)
|
|
|
|
// UpdateBotActive marks a bot as active or inactive, along with its corresponding user.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
UpdateBotActive(botUserId string, active bool) (*model.Bot, *model.AppError)
|
|
|
|
// PermanentDeleteBot permanently deletes a bot and its corresponding user.
|
|
//
|
|
// @tag Bot
|
|
// Minimum server version: 5.10
|
|
PermanentDeleteBot(botUserId string) *model.AppError
|
|
|
|
// PluginHTTP allows inter-plugin requests to plugin APIs.
|
|
//
|
|
// Minimum server version: 5.18
|
|
PluginHTTP(request *http.Request) *http.Response
|
|
|
|
// PublishUserTyping publishes a user is typing WebSocket event.
|
|
// The parentId parameter may be an empty string, the other parameters are required.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 5.26
|
|
PublishUserTyping(userID, channelId, parentId string) *model.AppError
|
|
|
|
// CreateCommand creates a server-owned slash command that is not handled by the plugin
|
|
// itself, and which will persist past the life of the plugin. The command will have its
|
|
// CreatorId set to "" and its PluginId set to the id of the plugin that created it.
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
CreateCommand(cmd *model.Command) (*model.Command, error)
|
|
|
|
// ListCommands returns the list of all slash commands for teamID. E.g., custom commands
|
|
// (those created through the integrations menu, the REST api, or the plugin api CreateCommand),
|
|
// plugin commands (those created with plugin api RegisterCommand), and builtin commands
|
|
// (those added internally through RegisterCommandProvider).
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
ListCommands(teamID string) ([]*model.Command, error)
|
|
|
|
// ListCustomCommands returns the list of slash commands for teamID that where created
|
|
// through the integrations menu, the REST api, or the plugin api CreateCommand.
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
ListCustomCommands(teamID string) ([]*model.Command, error)
|
|
|
|
// ListPluginCommands returns the list of slash commands for teamID that were created
|
|
// with the plugin api RegisterCommand.
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
ListPluginCommands(teamID string) ([]*model.Command, error)
|
|
|
|
// ListBuiltInCommands returns the list of slash commands that are builtin commands
|
|
// (those added internally through RegisterCommandProvider).
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
ListBuiltInCommands() ([]*model.Command, error)
|
|
|
|
// GetCommand returns the command definition based on a command id string.
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
GetCommand(commandID string) (*model.Command, error)
|
|
|
|
// UpdateCommand updates a single command (commandID) with the information provided in the
|
|
// updatedCmd model.Command struct. The following fields in the command cannot be updated:
|
|
// Id, Token, CreateAt, DeleteAt, and PluginId. If updatedCmd.TeamId is blank, it
|
|
// will be set to commandID's TeamId.
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
UpdateCommand(commandID string, updatedCmd *model.Command) (*model.Command, error)
|
|
|
|
// DeleteCommand deletes a slash command (commandID).
|
|
//
|
|
// @tag SlashCommand
|
|
// Minimum server version: 5.28
|
|
DeleteCommand(commandID string) error
|
|
|
|
// CreateOAuthApp creates a new OAuth App.
|
|
//
|
|
// @tag OAuth
|
|
// Minimum server version: 5.38
|
|
CreateOAuthApp(app *model.OAuthApp) (*model.OAuthApp, *model.AppError)
|
|
|
|
// GetOAuthApp gets an existing OAuth App by id.
|
|
//
|
|
// @tag OAuth
|
|
// Minimum server version: 5.38
|
|
GetOAuthApp(appID string) (*model.OAuthApp, *model.AppError)
|
|
|
|
// UpdateOAuthApp updates an existing OAuth App.
|
|
//
|
|
// @tag OAuth
|
|
// Minimum server version: 5.38
|
|
UpdateOAuthApp(app *model.OAuthApp) (*model.OAuthApp, *model.AppError)
|
|
|
|
// DeleteOAuthApp deletes an existing OAuth App by id.
|
|
//
|
|
// @tag OAuth
|
|
// Minimum server version: 5.38
|
|
DeleteOAuthApp(appID string) *model.AppError
|
|
|
|
// PublishPluginClusterEvent broadcasts a plugin event to all other running instances of
|
|
// the calling plugin that are present in the cluster.
|
|
//
|
|
// This method is used to allow plugin communication in a High-Availability cluster.
|
|
// The receiving side should implement the OnPluginClusterEvent hook
|
|
// to receive events sent through this method.
|
|
//
|
|
// Minimum server version: 5.36
|
|
PublishPluginClusterEvent(ev model.PluginClusterEvent, opts model.PluginClusterEventSendOptions) error
|
|
|
|
// RequestTrialLicense requests a trial license and installs it in the server
|
|
//
|
|
// Minimum server version: 5.36
|
|
RequestTrialLicense(requesterID string, users int, termsAccepted bool, receiveEmailsAccepted bool) *model.AppError
|
|
|
|
// GetCloudLimits gets limits associated with a cloud workspace, if any
|
|
//
|
|
// Minimum server version: 7.0
|
|
GetCloudLimits() (*model.ProductLimits, error)
|
|
|
|
// EnsureBotUser updates the bot if it exists, otherwise creates it.
|
|
//
|
|
// Minimum server version: 7.1
|
|
EnsureBotUser(bot *model.Bot) (string, error)
|
|
|
|
// RegisterCollectionAndTopic is no longer supported.
|
|
//
|
|
// Minimum server version: 7.6
|
|
RegisterCollectionAndTopic(collectionType, topicType string) error
|
|
|
|
// CreateUploadSession creates and returns a new (resumable) upload session.
|
|
//
|
|
// @tag Upload
|
|
// Minimum server version: 7.6
|
|
CreateUploadSession(us *model.UploadSession) (*model.UploadSession, error)
|
|
|
|
// UploadData uploads the data for a given upload session.
|
|
//
|
|
// @tag Upload
|
|
// Minimum server version: 7.6
|
|
UploadData(us *model.UploadSession, rd io.Reader) (*model.FileInfo, error)
|
|
|
|
// GetUploadSession returns the upload session for the provided id.
|
|
//
|
|
// @tag Upload
|
|
// Minimum server version: 7.6
|
|
GetUploadSession(uploadID string) (*model.UploadSession, error)
|
|
|
|
// SendPushNotification will send a push notification to all of user's sessions.
|
|
//
|
|
// It is the responsibility of the plugin to respect the server's configuration and licence,
|
|
// especially related to `cfg.EmailSettings.PushNotificationContents`, particularly
|
|
// `model.IdLoadedNotification` and the generic settings.
|
|
// Refer to `app.sendPushNotificationSync` for the logic used to construct push notifications.
|
|
//
|
|
// Note: the NotificationWillBePushed hook will be run after SendPushNotification is called.
|
|
//
|
|
// Minimum server version: 9.0
|
|
SendPushNotification(notification *model.PushNotification, userID string) *model.AppError
|
|
|
|
// UpdateUserAuth updates a user's auth data.
|
|
//
|
|
// It is not currently possible to use this to set a user's auth to e-mail with a hashed
|
|
// password. It is meant to be used exclusively in setting a non-email auth service.
|
|
//
|
|
// @tag User
|
|
// Minimum server version: 9.3
|
|
UpdateUserAuth(userID string, userAuth *model.UserAuth) (*model.UserAuth, *model.AppError)
|
|
|
|
// RegisterPluginForSharedChannels registers the plugin as a `Remote` for SharedChannels.
|
|
// The plugin will receive synchronization messages via the `OnSharedChannelsSyncMsg` hook.
|
|
// This API is idempotent - when called repeatedly with the same `RegisterPluginOpts.PluginID`
|
|
// it will return the same remoteID.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
RegisterPluginForSharedChannels(opts model.RegisterPluginOpts) (remoteID string, err error)
|
|
|
|
// UnregisterPluginForSharedChannels unregisters the plugin as a `Remote` for SharedChannels.
|
|
// The plugin will no longer receive synchronization messages via the `OnSharedChannelsSyncMsg` hook.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
UnregisterPluginForSharedChannels(pluginID string) error
|
|
|
|
// ShareChannel marks a channel for sharing via shared channels. Note, this does not automatically
|
|
// invite any remote clusters to the channel - use `InviteRemote` to invite a remote , or this plugin,
|
|
// to the shared channel and start synchronization.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
ShareChannel(sc *model.SharedChannel) (*model.SharedChannel, error)
|
|
|
|
// UpdateSharedChannel updates a shared channel. This can be used to change the share name,
|
|
// display name, purpose, header, etc.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
UpdateSharedChannel(sc *model.SharedChannel) (*model.SharedChannel, error)
|
|
|
|
// UnshareChannel unmarks a channel for sharing. The channel will no longer be shared and
|
|
// all remotes will be uninvited to the channel.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
UnshareChannel(channelID string) (unshared bool, err error)
|
|
|
|
// UpdateSharedChannelCursor updates the cursor for the specified channel and RemoteID (passed by
|
|
// the plugin when registering). This can be used to manually set the point of last sync, either
|
|
// forward to skip older posts, or backward to re-sync history. This call by itself does not force
|
|
// a re-sync - a change to channel contents or a call to SyncSharedChannel are needed to force a sync.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
UpdateSharedChannelCursor(channelID, remoteID string, cusror model.GetPostsSinceForSyncCursor) error
|
|
|
|
// SyncSharedChannel forces a shared channel to send any changed content to all remotes.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
SyncSharedChannel(channelID string) error
|
|
|
|
// InviteRemoteToChannel invites a remote, or this plugin, as a target for synchronizing. Once invited, the
|
|
// remote will start to receive synchronization messages for any changed content in the specified channel.
|
|
// If `shareIfNotShared` is true, the channel's shared flag will be set, if not already.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
InviteRemoteToChannel(channelID string, remoteID string, userID string, shareIfNotShared bool) error
|
|
|
|
// UninviteRemoteFromChannel uninvites a remote, or this plugin, such that it will stop receiving sychronization
|
|
// messages for the channel.
|
|
//
|
|
// @tag SharedChannels
|
|
// Minimum server version: 9.5
|
|
UninviteRemoteFromChannel(channelID string, remoteID string) error
|
|
|
|
// UpsertGroupMember adds a user to a group or updates their existing membership.
|
|
//
|
|
// @tag Group
|
|
// @tag User
|
|
// Minimum server version: 10.7
|
|
UpsertGroupMember(groupID string, userID string) (*model.GroupMember, *model.AppError)
|
|
|
|
// UpsertGroupMembers adds multiple users to a group or updates their existing memberships.
|
|
//
|
|
// @tag Group
|
|
// @tag User
|
|
// Minimum server version: 10.7
|
|
UpsertGroupMembers(groupID string, userIDs []string) ([]*model.GroupMember, *model.AppError)
|
|
|
|
// GetGroupByRemoteID gets a group by its remote ID.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
GetGroupByRemoteID(remoteID string, groupSource model.GroupSource) (*model.Group, *model.AppError)
|
|
|
|
// CreateGroup creates a new group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
CreateGroup(group *model.Group) (*model.Group, *model.AppError)
|
|
|
|
// UpdateGroup updates a group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
UpdateGroup(group *model.Group) (*model.Group, *model.AppError)
|
|
|
|
// DeleteGroup soft deletes a group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
DeleteGroup(groupID string) (*model.Group, *model.AppError)
|
|
|
|
// RestoreGroup restores a soft deleted group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
RestoreGroup(groupID string) (*model.Group, *model.AppError)
|
|
|
|
// DeleteGroupMember removes a user from a group.
|
|
//
|
|
// @tag Group
|
|
// @tag User
|
|
// Minimum server version: 10.7
|
|
DeleteGroupMember(groupID string, userID string) (*model.GroupMember, *model.AppError)
|
|
|
|
// GetGroupSyncable gets a group syncable.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
GetGroupSyncable(groupID string, syncableID string, syncableType model.GroupSyncableType) (*model.GroupSyncable, *model.AppError)
|
|
|
|
// GetGroupSyncables gets all group syncables for the given group.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
GetGroupSyncables(groupID string, syncableType model.GroupSyncableType) ([]*model.GroupSyncable, *model.AppError)
|
|
|
|
// UpsertGroupSyncable creates or updates a group syncable.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
UpsertGroupSyncable(groupSyncable *model.GroupSyncable) (*model.GroupSyncable, *model.AppError)
|
|
|
|
// UpdateGroupSyncable updates a group syncable.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
UpdateGroupSyncable(groupSyncable *model.GroupSyncable) (*model.GroupSyncable, *model.AppError)
|
|
|
|
// DeleteGroupSyncable deletes a group syncable.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
DeleteGroupSyncable(groupID string, syncableID string, syncableType model.GroupSyncableType) (*model.GroupSyncable, *model.AppError)
|
|
|
|
// UpdateUserRoles updates the role for a user.
|
|
//
|
|
// @tag Team
|
|
// @tag User
|
|
// Minimum server version: 9.8
|
|
UpdateUserRoles(userID, newRoles string) (*model.User, *model.AppError)
|
|
|
|
// GetPluginID returns the plugin ID.
|
|
//
|
|
// @tag Plugin
|
|
// Minimum server version: 10.1
|
|
GetPluginID() string
|
|
|
|
// GetGroups returns a list of all groups with the given options and restrictions.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.7
|
|
GetGroups(page, perPage int, opts model.GroupSearchOpts, viewRestrictions *model.ViewUsersRestrictions) ([]*model.Group, *model.AppError)
|
|
|
|
// CreateDefaultSyncableMemberships creates default syncable memberships based off the provided parameters.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.9
|
|
CreateDefaultSyncableMemberships(params model.CreateDefaultMembershipParams) *model.AppError
|
|
|
|
// DeleteGroupConstrainedMemberships deletes team and channel memberships of users who aren't members of the allowed groups of all group-constrained teams and channels.
|
|
//
|
|
// @tag Group
|
|
// Minimum server version: 10.9
|
|
DeleteGroupConstrainedMemberships() *model.AppError
|
|
|
|
// CreatePropertyField creates a new property field.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
CreatePropertyField(field *model.PropertyField) (*model.PropertyField, error)
|
|
|
|
// GetPropertyField gets a property field by groupID and fieldID.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
GetPropertyField(groupID, fieldID string) (*model.PropertyField, error)
|
|
|
|
// GetPropertyFields gets multiple property fields by groupID and a list of IDs.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
GetPropertyFields(groupID string, ids []string) ([]*model.PropertyField, error)
|
|
|
|
// UpdatePropertyField updates an existing property field.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
UpdatePropertyField(groupID string, field *model.PropertyField) (*model.PropertyField, error)
|
|
|
|
// DeletePropertyField deletes a property field (soft delete).
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
DeletePropertyField(groupID, fieldID string) error
|
|
|
|
// SearchPropertyFields searches for property fields with filtering options.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 11.0
|
|
SearchPropertyFields(groupID string, opts model.PropertyFieldSearchOpts) ([]*model.PropertyField, error)
|
|
|
|
// CountPropertyFields counts property fields for a group.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 11.0
|
|
CountPropertyFields(groupID string, includeDeleted bool) (int64, error)
|
|
|
|
// CountPropertyFieldsForTarget counts property fields for a specific target.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 11.0
|
|
CountPropertyFieldsForTarget(groupID, targetType, targetID string, includeDeleted bool) (int64, error)
|
|
|
|
// CreatePropertyValue creates a new property value.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
CreatePropertyValue(value *model.PropertyValue) (*model.PropertyValue, error)
|
|
|
|
// GetPropertyValue gets a property value by groupID and valueID.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
GetPropertyValue(groupID, valueID string) (*model.PropertyValue, error)
|
|
|
|
// GetPropertyValues gets multiple property values by groupID and a list of IDs.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
GetPropertyValues(groupID string, ids []string) ([]*model.PropertyValue, error)
|
|
|
|
// UpdatePropertyValue updates an existing property value.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
UpdatePropertyValue(groupID string, value *model.PropertyValue) (*model.PropertyValue, error)
|
|
|
|
// UpsertPropertyValue creates a new property value or updates if it already exists.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
UpsertPropertyValue(value *model.PropertyValue) (*model.PropertyValue, error)
|
|
|
|
// DeletePropertyValue deletes a property value (soft delete).
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
DeletePropertyValue(groupID, valueID string) error
|
|
|
|
// SearchPropertyValues searches for property values with filtering options.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 11.0
|
|
SearchPropertyValues(groupID string, opts model.PropertyValueSearchOpts) ([]*model.PropertyValue, error)
|
|
|
|
// RegisterPropertyGroup registers a new property group.
|
|
//
|
|
// @tag PropertyGroup
|
|
// Minimum server version: 10.10
|
|
RegisterPropertyGroup(name string) (*model.PropertyGroup, error)
|
|
|
|
// GetPropertyGroup gets a property group by name.
|
|
//
|
|
// @tag PropertyGroup
|
|
// Minimum server version: 10.10
|
|
GetPropertyGroup(name string) (*model.PropertyGroup, error)
|
|
|
|
// GetPropertyFieldByName gets a property field by groupID, targetID and name.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
GetPropertyFieldByName(groupID, targetID, name string) (*model.PropertyField, error)
|
|
|
|
// UpdatePropertyFields updates multiple property fields in a single operation.
|
|
//
|
|
// @tag PropertyField
|
|
// Minimum server version: 10.10
|
|
UpdatePropertyFields(groupID string, fields []*model.PropertyField) ([]*model.PropertyField, error)
|
|
|
|
// UpdatePropertyValues updates multiple property values in a single operation.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
UpdatePropertyValues(groupID string, values []*model.PropertyValue) ([]*model.PropertyValue, error)
|
|
|
|
// UpsertPropertyValues creates or updates multiple property values in a single operation.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
UpsertPropertyValues(values []*model.PropertyValue) ([]*model.PropertyValue, error)
|
|
|
|
// DeletePropertyValuesForTarget deletes all property values for a specific target.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
DeletePropertyValuesForTarget(groupID, targetType, targetID string) error
|
|
|
|
// DeletePropertyValuesForField deletes all property values for a specific field.
|
|
//
|
|
// @tag PropertyValue
|
|
// Minimum server version: 10.10
|
|
DeletePropertyValuesForField(groupID, fieldID string) error
|
|
|
|
// LogAuditRec logs an audit record using the default audit logger.
|
|
//
|
|
// @tag Audit
|
|
// Minimum server version: 10.10
|
|
LogAuditRec(rec *model.AuditRecord)
|
|
|
|
// LogAuditRecWithLevel logs an audit record with a specific log level.
|
|
//
|
|
// @tag Audit
|
|
// Minimum server version: 10.10
|
|
LogAuditRecWithLevel(rec *model.AuditRecord, level mlog.Level)
|
|
}
|
|
|
|
var handshake = plugin.HandshakeConfig{
|
|
ProtocolVersion: 1,
|
|
MagicCookieKey: "MATTERMOST_PLUGIN",
|
|
MagicCookieValue: "Securely message teams, anywhere.",
|
|
}
|