mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
116849842b
* add CUD support for channel members via plugins This effectively exposes AddChannelMember, UpdateChannelMemberRoles, UpdateChannelMemberNotifyProps and LeaveChannel via the plugin API. It also modifies the semantics of AddChannelMember to explicitly allow for an empty user requestor, left as such for now via the plugin API. * change the signature of AddChannelMember to accept a channel id instead of a channel
121 lines
4.3 KiB
Go
121 lines
4.3 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See License.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"github.com/mattermost/mattermost-server/model"
|
|
)
|
|
|
|
// 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 can obtain access to the API by implementing the OnActivate hook.
|
|
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
|
|
|
|
// 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)
|
|
|
|
// UpdateUser updates a user.
|
|
UpdateUser(user *model.User) (*model.User, *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 a team.
|
|
GetTeam(teamId string) (*model.Team, *model.AppError)
|
|
|
|
// GetTeamByName gets a team by its name.
|
|
GetTeamByName(name string) (*model.Team, *model.AppError)
|
|
|
|
// UpdateTeam updates a team.
|
|
UpdateTeam(team *model.Team) (*model.Team, *model.AppError)
|
|
|
|
// CreateChannel creates a channel.
|
|
CreateChannel(channel *model.Channel) (*model.Channel, *model.AppError)
|
|
|
|
// DeleteChannel deletes a channel.
|
|
DeleteChannel(channelId string) *model.AppError
|
|
|
|
// GetChannel gets a channel.
|
|
GetChannel(channelId string) (*model.Channel, *model.AppError)
|
|
|
|
// GetChannelByName gets a channel by its name.
|
|
GetChannelByName(name, teamId string) (*model.Channel, *model.AppError)
|
|
|
|
// GetDirectChannel gets a direct message channel.
|
|
GetDirectChannel(userId1, userId2 string) (*model.Channel, *model.AppError)
|
|
|
|
// GetGroupChannel gets a group message channel.
|
|
GetGroupChannel(userIds []string) (*model.Channel, *model.AppError)
|
|
|
|
// UpdateChannel updates a channel.
|
|
UpdateChannel(channel *model.Channel) (*model.Channel, *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)
|
|
|
|
// 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)
|
|
|
|
// DeletePost deletes a post.
|
|
DeletePost(postId string) *model.AppError
|
|
|
|
// GetPost gets a post.
|
|
GetPost(postId string) (*model.Post, *model.AppError)
|
|
|
|
// UpdatePost updates a post.
|
|
UpdatePost(post *model.Post) (*model.Post, *model.AppError)
|
|
|
|
// KeyValueStore returns an object for accessing the persistent key value storage.
|
|
KeyValueStore() KeyValueStore
|
|
}
|
|
|
|
type KeyValueStore interface {
|
|
// Set will store a key-value pair, unique per plugin.
|
|
Set(key string, value []byte) *model.AppError
|
|
|
|
// Get will retrieve a value based on the key. Returns nil for non-existent keys.
|
|
Get(key string) ([]byte, *model.AppError)
|
|
|
|
// Delete will remove a key-value pair. Returns nil for non-existent keys.
|
|
Delete(key string) *model.AppError
|
|
}
|