Fix initialism errors (PR-2) (#17032)
* Fix initialism errors * Fix check-mocks test * Revert mlog and filestore packages * Update plugin_hooks_test.go * Update opentracinglayer.go * Regenerate mocks and check store layers * Revert plugin's context changes * Update context.go * Update plugin_requests.go * Update plugin_hooks_test.go * Regenerate mocks * Regenerate mocks and store layers Co-authored-by: Mattermod <mattermod@users.noreply.github.com>
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
db01f2a91b
Коммит
343c51830f
106
plugin/api.go
106
plugin/api.go
@@ -36,7 +36,7 @@ type API interface {
|
||||
//
|
||||
// @tag Command
|
||||
// Minimum server version: 5.2
|
||||
UnregisterCommand(teamId, trigger string) error
|
||||
UnregisterCommand(teamID, trigger string) error
|
||||
|
||||
// ExecuteSlashCommand executes a slash command with the given parameters.
|
||||
//
|
||||
@@ -47,7 +47,7 @@ type API interface {
|
||||
// GetSession returns the session object for the Session ID
|
||||
//
|
||||
// Minimum server version: 5.2
|
||||
GetSession(sessionId string) (*model.Session, *model.AppError)
|
||||
GetSession(sessionID string) (*model.Session, *model.AppError)
|
||||
|
||||
// GetConfig fetches the currently persisted config
|
||||
//
|
||||
@@ -126,7 +126,7 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
DeleteUser(userId string) *model.AppError
|
||||
DeleteUser(userID string) *model.AppError
|
||||
|
||||
// GetUsers a list of users based on search options.
|
||||
//
|
||||
@@ -138,7 +138,7 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
GetUser(userId string) (*model.User, *model.AppError)
|
||||
GetUser(userID string) (*model.User, *model.AppError)
|
||||
|
||||
// GetUserByEmail gets a user by their email address.
|
||||
//
|
||||
@@ -163,46 +163,46 @@ type API interface {
|
||||
// @tag User
|
||||
// @tag Team
|
||||
// Minimum server version: 5.6
|
||||
GetUsersInTeam(teamId string, page int, perPage int) ([]*model.User, *model.AppError)
|
||||
GetUsersInTeam(teamID string, page int, perPage int) ([]*model.User, *model.AppError)
|
||||
|
||||
// GetPreferencesForUser gets a user's preferences.
|
||||
//
|
||||
// @tag User
|
||||
// @tag Preference
|
||||
// Minimum server version: 5.26
|
||||
GetPreferencesForUser(userId string) ([]model.Preference, *model.AppError)
|
||||
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
|
||||
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
|
||||
DeletePreferencesForUser(userID string, preferences []model.Preference) *model.AppError
|
||||
|
||||
// GetTeamIcon gets the team icon.
|
||||
//
|
||||
// @tag Team
|
||||
// Minimum server version: 5.6
|
||||
GetTeamIcon(teamId string) ([]byte, *model.AppError)
|
||||
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
|
||||
SetTeamIcon(teamID string, data []byte) *model.AppError
|
||||
|
||||
// RemoveTeamIcon removes the team icon.
|
||||
//
|
||||
// @tag Team
|
||||
// Minimum server version: 5.6
|
||||
RemoveTeamIcon(teamId string) *model.AppError
|
||||
RemoveTeamIcon(teamID string) *model.AppError
|
||||
|
||||
// UpdateUser updates a user.
|
||||
//
|
||||
@@ -214,7 +214,7 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
GetUserStatus(userId string) (*model.Status, *model.AppError)
|
||||
GetUserStatus(userID string) (*model.Status, *model.AppError)
|
||||
|
||||
// GetUserStatusesByIds will return a list of user statuses based on the provided slice of user IDs.
|
||||
//
|
||||
@@ -227,13 +227,13 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
UpdateUserStatus(userId, status string) (*model.Status, *model.AppError)
|
||||
UpdateUserStatus(userID, status string) (*model.Status, *model.AppError)
|
||||
|
||||
// UpdateUserActive deactivates or reactivates an user.
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.8
|
||||
UpdateUserActive(userId string, active bool) *model.AppError
|
||||
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".
|
||||
@@ -241,7 +241,7 @@ type API interface {
|
||||
// @tag User
|
||||
// @tag Channel
|
||||
// Minimum server version: 5.6
|
||||
GetUsersInChannel(channelId, sortBy string, page, perPage int) ([]*model.User, *model.AppError)
|
||||
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.
|
||||
@@ -250,7 +250,7 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.3
|
||||
GetLDAPUserAttributes(userId string, attributes []string) (map[string]string, *model.AppError)
|
||||
GetLDAPUserAttributes(userID string, attributes []string) (map[string]string, *model.AppError)
|
||||
|
||||
// CreateTeam creates a team.
|
||||
//
|
||||
@@ -262,7 +262,7 @@ type API interface {
|
||||
//
|
||||
// @tag Team
|
||||
// Minimum server version: 5.2
|
||||
DeleteTeam(teamId string) *model.AppError
|
||||
DeleteTeam(teamID string) *model.AppError
|
||||
|
||||
// GetTeam gets all teams.
|
||||
//
|
||||
@@ -274,7 +274,7 @@ type API interface {
|
||||
//
|
||||
// @tag Team
|
||||
// Minimum server version: 5.2
|
||||
GetTeam(teamId string) (*model.Team, *model.AppError)
|
||||
GetTeam(teamID string) (*model.Team, *model.AppError)
|
||||
|
||||
// GetTeamByName gets a team by its name.
|
||||
//
|
||||
@@ -287,7 +287,7 @@ type API interface {
|
||||
// @tag Team
|
||||
// @tag User
|
||||
// Minimum server version: 5.6
|
||||
GetTeamsUnreadForUser(userId string) ([]*model.TeamUnread, *model.AppError)
|
||||
GetTeamsUnreadForUser(userID string) ([]*model.TeamUnread, *model.AppError)
|
||||
|
||||
// UpdateTeam updates a team.
|
||||
//
|
||||
@@ -306,63 +306,63 @@ type API interface {
|
||||
// @tag Team
|
||||
// @tag User
|
||||
// Minimum server version: 5.6
|
||||
GetTeamsForUser(userId string) ([]*model.Team, *model.AppError)
|
||||
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)
|
||||
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)
|
||||
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)
|
||||
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
|
||||
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)
|
||||
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)
|
||||
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)
|
||||
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)
|
||||
UpdateTeamMemberRoles(teamID, userID, newRoles string) (*model.TeamMember, *model.AppError)
|
||||
|
||||
// CreateChannel creates a channel.
|
||||
//
|
||||
@@ -381,7 +381,7 @@ type API interface {
|
||||
// @tag Channel
|
||||
// @tag Team
|
||||
// Minimum server version: 5.2
|
||||
GetPublicChannelsForTeam(teamId string, page, perPage int) ([]*model.Channel, *model.AppError)
|
||||
GetPublicChannelsForTeam(teamID string, page, perPage int) ([]*model.Channel, *model.AppError)
|
||||
|
||||
// GetChannel gets a channel.
|
||||
//
|
||||
@@ -393,7 +393,7 @@ type API interface {
|
||||
//
|
||||
// @tag Channel
|
||||
// Minimum server version: 5.2
|
||||
GetChannelByName(teamId, name string, includeDeleted bool) (*model.Channel, *model.AppError)
|
||||
GetChannelByName(teamID, name string, includeDeleted bool) (*model.Channel, *model.AppError)
|
||||
|
||||
// GetChannelByNameForTeamName gets a channel by its name, given a team name.
|
||||
//
|
||||
@@ -408,7 +408,7 @@ type API interface {
|
||||
// @tag Team
|
||||
// @tag User
|
||||
// Minimum server version: 5.6
|
||||
GetChannelsForTeamForUser(teamId, userId string, includeDeleted bool) ([]*model.Channel, *model.AppError)
|
||||
GetChannelsForTeamForUser(teamID, userID string, includeDeleted bool) ([]*model.Channel, *model.AppError)
|
||||
|
||||
// GetChannelStats gets statistics for a channel.
|
||||
//
|
||||
@@ -442,7 +442,7 @@ type API interface {
|
||||
//
|
||||
// @tag Channel
|
||||
// Minimum server version: 5.6
|
||||
SearchChannels(teamId string, term string) ([]*model.Channel, *model.AppError)
|
||||
SearchChannels(teamID string, term string) ([]*model.Channel, *model.AppError)
|
||||
|
||||
// SearchUsers returns a list of users based on some search criteria.
|
||||
//
|
||||
@@ -455,13 +455,13 @@ type API interface {
|
||||
// @tag Post
|
||||
// @tag Team
|
||||
// Minimum server version: 5.10
|
||||
SearchPostsInTeam(teamId string, paramsList []*model.SearchParams) ([]*model.Post, *model.AppError)
|
||||
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)
|
||||
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.
|
||||
@@ -469,7 +469,7 @@ type API interface {
|
||||
// @tag Channel
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
AddChannelMember(channelId, userId string) (*model.ChannelMember, *model.AppError)
|
||||
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.
|
||||
@@ -477,14 +477,14 @@ type API interface {
|
||||
// @tag User
|
||||
// @tag Channel
|
||||
// Minimum server version: 5.18
|
||||
AddUserToChannel(channelId, userId, asUserId string) (*model.ChannelMember, *model.AppError)
|
||||
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)
|
||||
GetChannelMember(channelId, userID string) (*model.ChannelMember, *model.AppError)
|
||||
|
||||
// GetChannelMembers gets a channel membership for all users.
|
||||
//
|
||||
@@ -505,21 +505,21 @@ type API interface {
|
||||
// @tag Channel
|
||||
// @tag User
|
||||
// Minimum server version: 5.10
|
||||
GetChannelMembersForUser(teamId, userId string, page, perPage int) ([]*model.ChannelMember, *model.AppError)
|
||||
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)
|
||||
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)
|
||||
UpdateChannelMemberNotifications(channelId, userID string, notifications map[string]string) (*model.ChannelMember, *model.AppError)
|
||||
|
||||
// GetGroup gets a group by ID.
|
||||
//
|
||||
@@ -538,14 +538,14 @@ type API interface {
|
||||
// @tag Group
|
||||
// @tag User
|
||||
// Minimum server version: 5.18
|
||||
GetGroupsForUser(userId string) ([]*model.Group, *model.AppError)
|
||||
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
|
||||
DeleteChannelMember(channelId, userID string) *model.AppError
|
||||
|
||||
// CreatePost creates a post.
|
||||
//
|
||||
@@ -575,21 +575,21 @@ type API interface {
|
||||
//
|
||||
// @tag Post
|
||||
// Minimum server version: 5.2
|
||||
SendEphemeralPost(userId string, post *model.Post) *model.Post
|
||||
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
|
||||
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)
|
||||
DeleteEphemeralPost(userID, postId string)
|
||||
|
||||
// DeletePost deletes a post.
|
||||
//
|
||||
@@ -641,7 +641,7 @@ type API interface {
|
||||
//
|
||||
// @tag Team
|
||||
// Minimum server version: 5.8
|
||||
GetTeamStats(teamId string) (*model.TeamStats, *model.AppError)
|
||||
GetTeamStats(teamID string) (*model.TeamStats, *model.AppError)
|
||||
|
||||
// UpdatePost updates a post.
|
||||
//
|
||||
@@ -653,13 +653,13 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.6
|
||||
GetProfileImage(userId string) ([]byte, *model.AppError)
|
||||
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
|
||||
SetProfileImage(userID string, data []byte) *model.AppError
|
||||
|
||||
// GetEmojiList returns a page of custom emoji on the system.
|
||||
//
|
||||
@@ -691,7 +691,7 @@ type API interface {
|
||||
// @tag File
|
||||
// @tag User
|
||||
// Minimum server version: 5.2
|
||||
CopyFileInfos(userId string, fileIds []string) ([]string, *model.AppError)
|
||||
CopyFileInfos(userID string, fileIds []string) ([]string, *model.AppError)
|
||||
|
||||
// GetFileInfo gets a File Info for a specific fileId
|
||||
//
|
||||
@@ -860,21 +860,21 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.3
|
||||
HasPermissionTo(userId string, permission *model.Permission) bool
|
||||
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
|
||||
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
|
||||
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
|
||||
@@ -978,7 +978,7 @@ type API interface {
|
||||
//
|
||||
// @tag User
|
||||
// Minimum server version: 5.26
|
||||
PublishUserTyping(userId, channelId, parentId string) *model.AppError
|
||||
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
|
||||
|
||||
Ссылка в новой задаче
Block a user