user

Documentation

Index

• Variables
• type User

Variables

var TestUserSuffixRegexp = regexp.MustCompile(`\d+$`)

TestUserSuffixRegexp matches the numerical suffix of test usernames, which are assumed to be in this format.

Types

type User

type User interface {
	Store() store.UserStore

	// connection
	Connect() (<-chan error, error)
	Disconnect() error
	// Events returns the WebSocket event chan for the controller
	// to listen and react to events.
	Events() <-chan *model.WebSocketEvent
	SignUp(email, username, password string) error
	Login() error
	Logout() (bool, error)

	//server
	GetConfig() error
	FetchStaticAssets() error

	// user
	GetMe() (string, error)
	GetPreferences() error
	UpdatePreferences(pref *model.Preferences) error
	CreateUser(user *model.User) (string, error)
	UpdateUser(user *model.User) error
	// UpdateUserRoles updates the given userId with the given role ids.
	UpdateUserRoles(userId, roles string) error
	PatchUser(userId string, patch *model.UserPatch) error
	GetUsersByIds(userIds []string) ([]string, error)
	GetUsersByUsernames(usernames []string) ([]string, error)
	GetUserStatus() error
	GetUsersStatusesByIds(userIds []string) error
	GetUsersInChannel(channelId string, page, perPage int) error
	GetUsers(page, perPage int) ([]string, error)
	SetProfileImage(data []byte) error
	GetProfileImage() error
	GetProfileImageForUser(userId string) error
	SearchUsers(search *model.UserSearch) ([]*model.User, error)
	AutoCompleteUsersInChannel(teamId, channelId, username string, limit int) (map[string]bool, error)

	// posts
	CreatePost(post *model.Post) (string, error)
	PatchPost(postId string, patch *model.PostPatch) (string, error)
	SearchPosts(teamId, terms string, isOrSearch bool) (*model.PostList, error)
	GetPostsForChannel(channelId string, page, perPage int) error
	GetPostsBefore(channelId, postId string, page, perPage int) error
	GetPostsAfter(channelId, postId string, page, perPage int) error
	GetPostsSince(channelId string, time int64) ([]string, error)
	GetPinnedPosts(channelId string) (*model.PostList, error)
	// GetPostsAroundLastUnread returns the list of posts around last unread post by the current user in a channel.
	GetPostsAroundLastUnread(channelId string, limitBefore, limitAfter int) ([]string, error)
	SaveReaction(reaction *model.Reaction) error
	DeleteReaction(reaction *model.Reaction) error
	GetReactions(postId string) error

	// files
	UploadFile(data []byte, channelId, filename string) (*model.FileUploadResponse, error)
	GetFileInfosForPost(postId string) ([]*model.FileInfo, error)
	GetFileThumbnail(fileId string) error
	GetFilePreview(fileId string) error

	// channels
	CreateChannel(channel *model.Channel) (string, error)
	CreateGroupChannel(memberIds []string) (string, error)
	CreateDirectChannel(otherUserId string) (string, error)
	GetChannel(channelId string) error
	GetChannelsForTeam(teamId string, includeDeleted bool) error
	GetPublicChannelsForTeam(teamId string, page, perPage int) error
	SearchChannels(teamId string, search *model.ChannelSearch) ([]*model.Channel, error)
	RemoveUserFromChannel(channelId, userId string) (bool, error)
	ViewChannel(view *model.ChannelView) (*model.ChannelViewResponse, error)
	GetChannelUnread(channelId string) (*model.ChannelUnread, error)
	GetChannelMembers(channelId string, page, perPage int) error
	// GetChannelMembersForUser gets all the channel members for a user on a team.
	GetChannelMembersForUser(userId, teamId string) error
	GetChannelMember(channelId string, userId string) error
	GetChannelStats(channelId string) error
	AddChannelMember(channelId, userId string) error
	GetChannelsForTeamForUser(teamId, userId string, includeDeleted bool) ([]*model.Channel, error)
	// AutocompleteChannelsForTeam returns an ordered list of channels for a given name.
	AutocompleteChannelsForTeam(teamId, name string) error

	// teams
	GetTeams() ([]string, error)
	// GetAllTeams returns all teams based on permissions.
	GetAllTeams(page, perPage int) ([]string, error)
	CreateTeam(team *model.Team) (string, error)
	GetTeam(teamId string) error
	GetTeamsForUser(userId string) ([]string, error)
	AddTeamMember(teamId, userId string) error
	RemoveTeamMember(teamId, userId string) error
	GetTeamMembers(teamId string, page, perPage int) error
	GetTeamMembersForUser(userId string) error
	GetTeamStats(teamId string) error
	GetTeamsUnread(teamIdToExclude string) ([]*model.TeamUnread, error)
	AddTeamMemberFromInvite(token, inviteId string) error
	// UpdateTeam updates the given team.
	UpdateTeam(team *model.Team) error

	// roles
	// GetRolesByNames returns a list of role ids based on the provided role names.
	GetRolesByNames(roleNames []string) ([]string, error)

	// emoji
	GetEmojiList(page, perPage int) error
	GetEmojiImage(emojiId string) error

	// plugins
	GetWebappPlugins() error

	// license
	// GetClientLicense returns the client license in the old format.
	GetClientLicense() error

	// utils
	// IsSysAdmin returns whether a user is a SysAdmin or not.
	IsSysAdmin() (bool, error)
	// IsTeamAdmin returns whether a user is a TeamAdmin or not.
	IsTeamAdmin() (bool, error)
	SetCurrentTeam(team *model.Team) error
	SetCurrentChannel(channel *model.Channel) error

	// GetLogs fetches the logs.
	GetLogs(page, perPage int) error
	// GetAnalytics fetches the system analytics.
	GetAnalytics() error
	// GetClusterStatus fetches the cluster status.
	GetClusterStatus() error
	// GetPluginStatuses fetches the plugin statuses.
	GetPluginStatuses() error
	// UpdateConfig updates the config with cfg.
	UpdateConfig(cfg *model.Config) error

	// Clear clears the underlying UserStore
	ClearUserData()

	// SendTypingEvent will push a user_typing event out to all connected users
	// who are in the specified channel.
	SendTypingEvent(channelId, parentId string) error
}

User provides a wrapper interface to interact with the Mattermost server through its client APIs. It persists the data to its UserStore for later use.