MattermostClient (Mattermost APIv4 Client for Java 0.1.1 API)

java.lang.Object
- net.bis5.mattermost.client4.MattermostClient

All Implemented Interfaces:: AutoCloseable, AuditsApi, AuthenticationApi, BrandApi, ChannelApi, ClusterApi, CommandsApi, ComplianceApi, EmojiApi, GeneralApi, LdapApi, LogsApi, OAuthApi, PostApi, PreferencesApi, ReactionApi, SamlApi, StatusApi, TeamApi, UserApi, WebhookApi, WebrtcApi

public class MattermostClient
extends Object
implements AutoCloseable, AuditsApi, AuthenticationApi, BrandApi, ChannelApi, ClusterApi, CommandsApi, ComplianceApi, EmojiApi, GeneralApi, LdapApi, LogsApi, OAuthApi, PostApi, PreferencesApi, ReactionApi, SamlApi, StatusApi, TeamApi, UserApi, WebhookApi, WebrtcApi

Since:: 2017/06/10
Author:: Maruyama Takayuki

Field Summary

Fields
Modifier and Type Field and Description

protected static String API_URL_SUFFIX

protected static String HEADER_AUTH

protected static String HEADER_ETAG_CLIENT

Fields
Modifier and Type	Field and Description
`protected static String`	`API_URL_SUFFIX`
`protected static String`	`HEADER_AUTH`
`protected static String`	`HEADER_ETAG_CLIENT`

Constructor Summary

Constructors
Constructor and Description

MattermostClient(String url)

MattermostClient(String url, Level logLevel)

Constructors
Constructor and Description
`MattermostClient(String url)`
`MattermostClient(String url, Level logLevel)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ApiResponse<ChannelMember>`	`addChannelMember(String channelId, String userId)` adds user to channel and return a channel memner.
`ApiResponse<TeamMember>`	`addTeamMember(String hash, String dataToHash, String inviteId)` adds user to a team and return a team member.
`ApiResponse<TeamMember>`	`addTeamMember(String teamId, String userId, String hash, String dataToHash, String inviteId)` Deprecated. API Change on Mattermost 4.0
`ApiResponse<TeamMember>`	`addTeamMember(TeamMember teamMemberToAdd)` add user to a team and return a team member.
`ApiResponse<TeamMemberList>`	`addTeamMembers(String teamId, String... userIds)` adds a number of users to a team and returns the team members.
`ApiResponse<Boolean>`	`attachDeviceId(String deviceId)` attaches a mobile device ID to the current session/
`String`	`authorizeOAuthApp(AuthorizeRequest authRequest)` will authorize an OAuth 2.0 client application to access a user's account and provide a redirect link to follow.
`ApiResponse<UserAutocomplete>`	`autocompleteUsers(String username, String etag)` returns the users in the system based on search term.
`ApiResponse<UserAutocomplete>`	`autocompleteUsersInChannel(String teamId, String channelId, String username, String etag)` returns the users in a channel based on search term.
`ApiResponse<UserAutocomplete>`	`autocompleteUsersInTeam(String teamId, String username, String etag)` returns the users on a team based on search term.
`protected javax.ws.rs.client.Client`	`buildClient()`
`boolean`	`checkUserMfa(String loginId)` checks whether a user has MFA active on their account or not based on the provided login id.
`void`	`clearOAuthToken()`
`void`	`close()`
`ApiResponse<Channel>`	`createChannel(Channel channel)` creates a channel based on the provided channel object.
`ApiResponse<Command>`	`createCommand(Command cmd)` will create a new command if the user have the right permissions.
`ApiResponse<Compliance>`	`createComplianceReport(Compliance report)` creates a compliance report.
`ApiResponse<Channel>`	`createDirectChannel(String userId1, String userId2)` creates a direct message channel based on the two user ids provided.
`ApiResponse<Emoji>`	`createEmoji(Emoji emoji, Path imageFile)` will save an emoji to the server if the current user has permission to do so.
`ApiResponse<Channel>`	`createGroupChannel(String... userIds)` creates a group message channel based on userIds provided.
`ApiResponse<IncomingWebhook>`	`createIncomingWebhook(IncomingWebhook hook)` creates an incoming webhook for a channel.
`ApiResponse<OAuthApp>`	`createOAuthApp(OAuthApp app)` will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
`ApiResponse<OutgoingWebhook>`	`createOutgoingWebhook(OutgoingWebhook hook)` creates an outgoing webhook for a team or channel.
`ApiResponse<Post>`	`createPost(Post post)` creates a post based on the provided post object.
`ApiResponse<Team>`	`createTeam(Team team)` creates a team in the system based on the provided team object.
`ApiResponse<User>`	`createUser(User user)` creates a user in the system based on the provided user object.
`ApiResponse<Boolean>`	`databaseRecycle()` will recycle the connections.
`ApiResponse<Boolean>`	`deauthorizeOAuthApp(String appId)` will deauthorize an OAuth 2.0 client application from accessing a user's account.
`ApiResponse<Boolean>`	`deleteChannel(String channelId)` deletes channel based on the provided channel id string.
`ApiResponse<Boolean>`	`deleteCommand(String commandId)` deletes a command based on the provided command id string.
`ApiResponse<Boolean>`	`deleteEmoji(String emojiId)` delete an custom emoji on the provided emoji id string.
`ApiResponse<Boolean>`	`deleteIncomingWebhook(String hookId)` deletes an Incoming Webhook given the hook id.
`ApiResponse<Boolean>`	`deleteOAuthApp(String appId)` deletes a registered OAuth 2.0 client application.
`ApiResponse<Boolean>`	`deleteOutgoingWebhook(String hookId)` delete the outgoing webhook on the system requested by hook id.
`ApiResponse<Boolean>`	`deletePost(String postId)` deletes a post from the provided post id string.
`ApiResponse<Boolean>`	`deletePreferences(String userId, Preferences preferences)` deletes the user's preferences.
`ApiResponse<Boolean>`	`deleteReaction(Reaction reaction)` deletes reaction of a user in a post.
`ApiResponse<Boolean>`	`deleteSamlIdpCertificate()` deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
`ApiResponse<Boolean>`	`deleteSamlPrivateCertificate()` deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
`ApiResponse<Boolean>`	`deleteSamlPublicCertificate()` deletes the saml IDP certificate from the server and updates the config to not use it and disable SAML.
`ApiResponse<Boolean>`	`deleteTeam(String teamId)` deletes the team softly (archive only, not permanent delete).
`ApiResponse<Boolean>`	`deleteTeam(String teamId, boolean permanent)` deletes the team
`ApiResponse<Boolean>`	`deleteUser(String userId)` deactivates a user in the system based on the provided user id string.
`protected ApiResponse<Void>`	`doApiDelete(String url)`
`protected <T> ApiResponse<T>`	`doApiDelete(String url, Class<T> responseType)`
`protected ApiResponse<Void>`	`doApiGet(String url, String etag)`
`protected <T> ApiResponse<T>`	`doApiGet(String url, String etag, Class<T> responseType)`
`protected <T> ApiResponse<T>`	`doApiGet(String url, String etag, javax.ws.rs.core.GenericType<T> responseType)`
`protected <U> ApiResponse<Void>`	`doApiPost(String url, U data)`
`protected <T,U> ApiResponse<T>`	`doApiPost(String url, U data, Class<T> responseType)`
`protected <T,U> ApiResponse<T>`	`doApiPost(String url, U data, javax.ws.rs.core.GenericType<T> responseType)`
`protected ApiResponse<Void>`	`doApiPostMultiPart(String url, org.glassfish.jersey.media.multipart.MultiPart multiPart)`
`protected <T> ApiResponse<T>`	`doApiPostMultiPart(String url, org.glassfish.jersey.media.multipart.MultiPart multiPart, Class<T> responseType)`
`protected <U> ApiResponse<Void>`	`doApiPut(String url, U data)`
`protected <T,U> ApiResponse<T>`	`doApiPut(String url, U data, Class<T> responseType)`
`protected <U> ApiResponse<Void>`	`doApiRequest(String method, String url, U data, String etag)`
`protected <T,U> ApiResponse<T>`	`doApiRequest(String method, String url, U data, String etag, Class<T> responseType)`
`protected <T,U> ApiResponse<T>`	`doApiRequest(String method, String url, U data, String etag, javax.ws.rs.core.GenericType<T> responseType)`
`ApiResponse<Object>`	`downloadComplianceReport(String reportId)` returns a full compliance report as a file/
`ApiResponse<CommandResponse>`	`executeCommand(String channelId, String command)` executes a given command.
`ApiResponse<MfaSecret>`	`generateMfaSecret(String userId)` will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.
`ApiResponse<TeamList>`	`getAllTeams(Pager pager, String etag)` returns all teams based on permssions.
`ApiResponse<Audits>`	`getAudits(Pager pager, String etag)` returns a list of audits for the whole system.
`ApiResponse<List<OAuthApp>>`	`getAuthorizedOAuthAppsForUser(String userId, Pager pager)` gets a page of OAuth 2.0 client applications the user authorized to use access their account.
`ApiResponse<Object>`	`getBrandImage()` retrieves the previously uploaded brand image.
`String`	`getBrandRoute()`
`String`	`getCacheRoute()`
`ApiResponse<Channel>`	`getChannel(String channelId, String etag)` returns a channel based on the provided channel id string.
`ApiResponse<Channel>`	`getChannelByName(String channelName, String teamId, String etag)` returns a channel based on the provided channel name and team id strings.
`ApiResponse<Channel>`	`getChannelByNameForTeamName(String channelName, String teamName, String etag)` returns a channel based on the provided channel name and team name strings.
`String`	`getChannelByNameForTeamNameRoute(String channelName, String teamName)`
`String`	`getChannelByNameRoute(String channelName, String teamId)`
`ApiResponse<ChannelMember>`	`getChannelMember(String channelId, String userId, String etag)` gets a channel memner.
`String`	`getChannelMemberRoute(String channelId, String userId)`
`ApiResponse<ChannelMembers>`	`getChannelMembers(String channelId, Pager pager, String etag)` gets a page of channel members.
`ApiResponse<ChannelMembers>`	`getChannelMembersByIds(String channelId, String... userIds)` gets the channel members in a channel for a list of user ids.
`ApiResponse<ChannelMembers>`	`getChannelMembersForUser(String userId, String teamId, String etag)` gets all the channel members for a user on a team.
`String`	`getChannelMembersRoute(String channelId)`
`String`	`getChannelRoute(String channelId)`
`ApiResponse<ChannelList>`	`getChannelsForTeamForUser(String teamId, String userId, String etag)` returns a list channels of on a team for user.
`String`	`getChannelsForTeamRoute(String teamId)`
`String`	`getChannelsRoute()`
`ApiResponse<ChannelStats>`	`getChannelStats(String channelId, String etag)` returns statistics for a channel.
`ApiResponse<ChannelUnread>`	`getChannelUnread(String channelId, String userId)` will return a ChannelUnread object that contains the number ofo unread messages and mentions for a user.
`String`	`getClusterRoute()`
`ApiResponse<List<ClusterInfo>>`	`getClusterStatus()`
`String`	`getCommandRoute(String commandId)`
`String`	`getCommandsRoute()`
`ApiResponse<Compliance>`	`getComplianceReport(String reportId)` returns a compliance report.
`String`	`getComplianceReportRoute(String reportId)`
`ApiResponse<Compliances>`	`getComplianceReports(Pager pager)` returns list of compliance reports.
`String`	`getComplianceReportsRoute()`
`ApiResponse<Config>`	`getConfig()` will retrieve the server config with some sanitized items.
`String`	`getConfigRoute()`
`String`	`getDatabaseRoute()`
`ApiResponse<Emoji>`	`getEmoji(String emojiId)` returns a custom emoji in the system on the provided emoji id string.
`ApiResponse<Object>`	`getEmojiImage(String emojiId)` returns the emoji image.
`ApiResponse<EmojiList>`	`getEmojiList(Pager pager)` returns a list of custom emoji in the syste,/
`String`	`getEmojiRoute(String emojiId)`
`String`	`getEmojisRoute()`
`String`	`getFileRoute(String fileId)`
`String`	`getFilesRoute()`
`ApiResponse<PostList>`	`getFlaggedPostsForUser(String userId, Pager pager)` returns flagges posts of a user based on user id string.
`ApiResponse<PostList>`	`getFlaggedPostsForUserInChannel(String userId, String channelId, Pager pager)` returns flagged posts in channel of a user based on user id string.
`ApiResponse<PostList>`	`getFlaggedPostsForUserInTeam(String userId, String teamId, Pager pager)` returns flagged posts in team of a user based on user id string.
`ApiResponse<IncomingWebhook>`	`getIncomingWebhook(String hookId, String etag)` returns an Incoming webhook given the hook id.
`String`	`getIncomingWebhookRoute(String hookId)`
`ApiResponse<IncomingWebhookList>`	`getIncomingWebhooks(Pager pager, String etag)` returns a page of incoming webhooks on the system.
`ApiResponse<IncomingWebhookList>`	`getIncomingWebhooksForTeam(String teamId, Pager pager, String etag)` returns a page of incoming webhooks for a team.
`String`	`getIncomingWebhooksRoute()`
`String`	`getLdapRoute()`
`String`	`getLicenseRoute()`
`ApiResponse<List<String>>`	`getLogs(Pager pager)` page of logs as a string list.
`ApiResponse<User>`	`getMe(String etag)` returns the logged in user.
`ApiResponse<OAuthApp>`	`getOAuthApp(String appId)` gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
`ApiResponse<OAuthApp>`	`getOAuthAppInfo(String appId)` gets a sanitized version of a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
`String`	`getOAuthAppRoute(String appId)`
`ApiResponse<List<OAuthApp>>`	`getOAuthApps(Pager pager)` gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.
`String`	`getOAuthAppsRoute()`
`ApiResponse<Map<String,String>>`	`getOldClientConfig(String etag)` will retrieve the parts of the server configuration needed by the client, formatted in the old format.
`ApiResponse<Map<String,String>>`	`getOldClientLicense(String etag)` will retrieve the parts of the server license needed by the client, formatted in the old format.
`ApiResponse<OutgoingWebhook>`	`getOutgoingWebhook(String hookId)` outgoing webhooks on the system requested by hook id.
`String`	`getOutgoingWebhookRoute(String hookId)`
`ApiResponse<OutgoingWebhookList>`	`getOutgoingWebhooks(Pager pager, String etag)` returns a page of outgoing webhooks ont eh system.
`ApiResponse<OutgoingWebhookList>`	`getOutgoingWebhooksForChannel(String channelId, Pager pager, String etag)` returns a page of outgoing webhooks for a channel.
`ApiResponse<OutgoingWebhookList>`	`getOutgoingWebhooksForTeam(String teamId, Pager pager, String etag)` returns a page of outgoing webhooks for a team.
`String`	`getOutgoingWebhooksRoute()`
`ApiResponse<Boolean>`	`getPing()` will ping the server and to see if it is up and running.
`ApiResponse<PostList>`	`getPinnedPosts(String channelId, String etag)` gets a list of pinned posts.
`ApiResponse<Post>`	`getPost(String postId, String etag)` gets a single post.
`String`	`getPostRoute(String postId)`
`ApiResponse<PostList>`	`getPostsAfter(String channelId, String postId, Pager pager, String etag)` gets a page of posts that were posted after the post provided.
`ApiResponse<PostList>`	`getPostsBefore(String channelId, String postId, Pager pager, String etag)` gets a page of posts that were posted before the post provided.
`ApiResponse<PostList>`	`getPostsForChannel(String channelId, Pager pager, String etag)` gets a page of posts with an array for ordering for a channel.
`String`	`getPostsRoute()`
`ApiResponse<PostList>`	`getPostsSince(String channelId, long time)` gets posts created after a specified time as Unix time in milliseconds.
`ApiResponse<PostList>`	`getPostThread(String postId, String etag)` gets a post with all the other posts in the same thread.
`ApiResponse<Preference>`	`getPreferenceByCategoryAndName(String userId, PreferenceCategory category, String preferenceName)` returns the user's preferences from the provided category and preference name string.
`ApiResponse<Preferences>`	`getPreferences(String userId)` returns the user's preferences.
`ApiResponse<Preferences>`	`getPreferencesByCategory(String userId, PreferenceCategory category)` returns the user's preferences from the provided category string.
`String`	`getPreferencesRoute(String userId)`
`ApiResponse<byte[]>`	`getProfileImage(String userId, String etag)` gets user's profile image.
`ApiResponse<ChannelList>`	`getPublicChannelsByIdsForTeam(String teamId, String... channelIds)` returns a list of public channeld based on provided team id string.
`ApiResponse<ChannelList>`	`getPublicChannelsForTeam(String teamId, Pager pager, String etag)` returns a list of public channels based on the provided team id string.
`ApiResponse<List<Reaction>>`	`getReactions(String postId)` returns a list of reactions to a post.
`String`	`getReactionsRoute()`
`ApiResponse<SamlCertificateStatus>`	`getSamlCertificateStatus()` returns metadata for the SAML configuration.
`ApiResponse<String>`	`getSamlMetadata()` returns metadata for the SAML configuration.
`String`	`getSamlRoute()`
`ApiResponse<SessionList>`	`getSessions(String userId, String etag)` returns a list of sessions based on the provided user id string.
`String`	`getSystemRoute()`
`ApiResponse<Team>`	`getTeam(String teamId, String etag)` returns a team based on the provided team is string/
`String`	`getTeamAutoCompleteCommandsRoute(String teamId)`
`ApiResponse<Team>`	`getTeamByName(String name, String etag)` returns a team based on the provided team name string.
`String`	`getTeamByNameRoute(String teamName)`
`String`	`getTeamImportRoute(String teamId)`
`ApiResponse<TeamMember>`	`getTeamMember(String teamId, String userId, String etag)` returns a team member based on the provided team and user id strings.
`String`	`getTeamMemberRoute(String teamId, String userId)`
`ApiResponse<TeamMemberList>`	`getTeamMembers(String teamId, Pager pager, String etag)` returns team members based on the provided team id string.
`ApiResponse<TeamMemberList>`	`getTeamMembersByIds(String teamId, String... userIds)` will return an array of team members based on the team id and a list of user ids provided.
`ApiResponse<TeamMemberList>`	`getTeamMembersForUser(String userId, String etag)` returns the team member for a user.
`String`	`getTeamMembersRoute(String teamId)`
`String`	`getTeamRoute(String teamId)`
`ApiResponse<TeamList>`	`getTeamsForUser(String userId, String etag)` returns a list of teams a user is on.
`String`	`getTeamsRoute()`
`ApiResponse<TeamStats>`	`getTeamStats(String teamId, String etag)` returns a team stats based on the team id string.
`String`	`getTeamStatsRoute(String teamId)`
`ApiResponse<TeamUnread>`	`getTeamUnread(String teamId, String userId)` will return a TeamUnread object that contains the amount of unread messages and mentions the user has for the specified team.
`ApiResponse<TeamUnreadList>`	`getTeamUnreadForUser(String userId, String teamIdToExclude)` will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to.
`String`	`getTestEmailRoute()`
`ApiResponse<User>`	`getUser(String userId, String etag)` returns a user based on the provided user id string.
`ApiResponse<Audits>`	`getUserAudits(String userId, Pager pager, String etag)` returns a list of audit based on the provided user id string.
`ApiResponse<User>`	`getUserByEmail(String email, String etag)` returns a user based on the provided user email string.
`String`	`getUserByEmailRoute(String email)`
`ApiResponse<User>`	`getUserByUsername(String userName, String etag)` returns a user based pn the provided user name string.
`String`	`getUserByUsernameRoute(String userName)`
`String`	`getUserRoute(String userId)`
`ApiResponse<UserList>`	`getUsers(Pager pager, String etag)` returns a page of users on the system.
`ApiResponse<UserList>`	`getUsersByIds(String... userIds)` returns a list of users based on the provided user ids.
`ApiResponse<UserList>`	`getUsersByUsernames(String... usernames)` returns a list of users based on the provided usernames.
`ApiResponse<UserList>`	`getUsersInChannel(String channelId, Pager pager, String etag)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersInTeam(String teamId, Pager pager, String etag)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersNotInChannel(String teamId, String channelId, Pager pager, String etag)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersNotInTeam(String teamId, Pager pager, String etag)` returns a page of users who are not in a team.
`String`	`getUsersRoute()`
`ApiResponse<List<Status>>`	`getUsersStatusesByIds(String... userIds)` returns a list of users status based on the provided user ids.
`ApiResponse<Status>`	`getUserStatus(String userId, String etag)` returns a user status based on the provided user id string.
`String`	`getUserStatusesRoute()`
`String`	`getUserStatusRoute(String userId)`
`ApiResponse<UserList>`	`getUsersWithoutTeam(Pager pager, String etag)` returns a page of users on the system that aren't on any teams.
`ApiResponse<WebrtcInfoResponse>`	`getWebrtcToken()` returns a valid token, stun server and turn server with credentials to use with the Mattermost WebRTC service.
`ApiResponse<byte[]>`	`importTeam(byte[] data, int filesize, String importFrom, String fileName, String teamId)` will import an exported team from other app into a existing team.
`ApiResponse<Boolean>`	`invalidateCaches()` will purge the cache and can affect the performance while is cleaning.
`ApiResponse<Boolean>`	`inviteUsersToTeam(String teamId, Collection<String> userEmails)` invite users by email to the team.
`ApiResponse<CommandList>`	`listAutocompleteCommands(String teamId)` will retrieve a list of commands available in the team.
`ApiResponse<CommandList>`	`listCommands(String teamId, boolean customOnly)` will retrieve a list of commands available in the team.
`protected User`	`login(LoginRequest param)`
`User`	`login(String loginId, String password)` authenticates a user by login id, which can be username, email, or some sort of SSO identifier based on server configuration, and a password.
`User`	`loginById(String id, String password)` authenticates a user by user id and password.
`User`	`loginByLdap(String loginId, String password)` authenticates a user by LDAP id and password.
`User`	`loginWithDevice(String loginId, String password, String deviceId)` authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.
`ApiResponse<Boolean>`	`logout()` terminates the current user's session.
`protected ApiResponse<User>`	`onLogin(ApiResponse<Void> loginResponse)`
`protected ApiResponse<Boolean>`	`onLogout(ApiResponse<Void> logoutResponse)`
`ApiResponse<Channel>`	`patchChannel(String channelId, ChannelPatch patch)` partially updates a channel.
`ApiResponse<Post>`	`patchPost(String postId, PostPatch patch)` partially updates a post.
`ApiResponse<Team>`	`patchTeam(String teamId, TeamPatch patch)` partially updates a team.
`ApiResponse<User>`	`patchUser(String userId, UserPatch patch)` partially updates a user in the system.
`ApiResponse<Boolean>`	`pinPost(String postId)` pin a post based on proviced post id string.
`ApiResponse<Map<String,String>>`	`postLog(Map<String,String> message)` This method is a convenience Web Service call so clients can log messages into the server-side logs.
`ApiResponse<String>`	`regenCommandToken(String commandId)` will create a new token if the user have the right permissions.
`ApiResponse<OAuthApp>`	`regenerateOAuthAppSecret(String appId)` regenerates the client secret for a registered OAuth 2.0 client application.
`ApiResponse<OutgoingWebhook>`	`regenOutgoingHookToken(String hookId)` regenerate the outgoing webhook token.
`ApiResponse<Boolean>`	`reloadConfig()` will reload the server configuration.
`ApiResponse<Boolean>`	`removeTeamMember(String teamId, String userId)` will remove a user from a team.
`ApiResponse<Boolean>`	`removeUserFromChannel(String channelId, String userId)` will delete the channel member object for a user, effectively removing the user from a channel.
`ApiResponse<Boolean>`	`resetPassword(String token, String newPassword)` uses a recovery code to update reset a user's password.
`ApiResponse<Boolean>`	`revokeSession(String userId, String sessionId)` revokes a user session based on the provided user id and session id strings.
`protected Object`	`samlFileToMultipart(Path dataFile, String dataFileName)`
`ApiResponse<Reaction>`	`saveReaction(Reaction reaction)` saves an emoji reaction for a post.
`ApiResponse<ChannelList>`	`searchChannels(String teamId, ChannelSearch search)` returns the channels on a team matching the provided search term.
`ApiResponse<PostList>`	`searchPosts(String teamId, String terms, boolean isOrSearch)` returns any posts with matching term string.
`ApiResponse<TeamList>`	`searchTeams(TeamSearch search)` returns teams matching the provided search term.
`ApiResponse<UserList>`	`searchUsers(UserSearch search)` returns a list of users based on some search criteria.
`ApiResponse<Boolean>`	`sendPasswordResetEmail(String email)` will send a link for password resetting to a user with the provided email.
`ApiResponse<Boolean>`	`sendVerificationEmail(String email)` will send an email to the user with the provided email addresses, if that user exists.
`void`	`setAccessToken(String token)`
`void`	`setOAuthToken(String token)`
`ApiResponse<Boolean>`	`setProfileImage(String userId, Path imageFilePath)` sets profile image of the user.
`ApiResponse<SwitchAccountTypeResult>`	`switchAccountType(SwitchRequest switchRequest)` changes a user's login type from one type to another.
`ApiResponse<Boolean>`	`syncLdap()` will force a sync with the configured LDAP server.
`ApiResponse<TeamExists>`	`teamExists(String name, String etag)` returns true or false if the team exist or not.
`ApiResponse<Boolean>`	`testEmail()` will attempt to connect to the configured SMTP server.
`ApiResponse<Boolean>`	`testLdap()` will attempt to connect to the configured LDAP server and return OK if configured correctly.
`ApiResponse<Boolean>`	`unpinPost(String postId)` unpin a post based on provided post id string.
`ApiResponse<Channel>`	`updateChannel(Channel channel)` update a channel based on the provided channel object.
`ApiResponse<Boolean>`	`updateChannelNotifyProps(String channelId, String userId, Map<String,String> props)` will update the notification properties on a channel for a user.
`ApiResponse<Boolean>`	`updateChannelRoles(String channelId, String userId, Role... roles)` will update the roles on a channel for a user.
`ApiResponse<Command>`	`updateCommand(Command cmd)` updates a command based on the provided Command object.
`ApiResponse<Config>`	`updateConfig(Config config)` will update the server configuration.
`ApiResponse<IncomingWebhook>`	`updateIncomingWebhook(IncomingWebhook hook)` updates an incoming webhook for a channel.
`ApiResponse<OutgoingWebhook>`	`updateOutgoingWebhook(OutgoingWebhook hook)` updates an outgoing webhook.
`ApiResponse<Post>`	`updatePost(String postId, Post post)` updates a post based on the provided post object.
`ApiResponse<Boolean>`	`updatePreferences(String userId, Preferences preferences)` saves the user's preferences.
`ApiResponse<Team>`	`updateTeam(Team team)` will update a team.
`ApiResponse<Boolean>`	`updateTeamMemberRoles(String teamId, String userId, Role... newRoles)` will update the roles on a team for a user.
`ApiResponse<User>`	`updateUser(User user)` updates a user in the system based on the provided user object.
`ApiResponse<Boolean>`	`updateUserActive(String userId, boolean active)` updates status of a user whether active or not.
`ApiResponse<Boolean>`	`updateUserMfa(String userId, String code, boolean activate)` activates multi-factor authentication for a user if activate is true and a valid code is provided.
`ApiResponse<Boolean>`	`updateUserPassword(String userId, String currentPassword, String newPassword)` updates a user's password.
`ApiResponse<Boolean>`	`updateUserRoles(String userId, Role... roles)` updates a user's roles in the system.
`ApiResponse<Status>`	`updateUserStatus(String userId, Status userStatus)` sets a user's status based on the provided user id string.
`boolean`	`uploadBrandImage(Path dataFile)` sets the brand image for the system.
`boolean`	`uploadSamlIdpCertificate(Path dataFile, String fileName)` will upload an IDP certificate for SAML and set the config to use it.
`boolean`	`uploadSamlPrivateCertificate(Path dataFile, String fileName)` will upload a private key for SAML and set the config to use it.
`boolean`	`uploadSamlPublicCertificate(Path dataFile, String fileName)` will upload a public certificate for SAML and set the config to use it.
`ApiResponse<Boolean>`	`verifyUserEmail(String token)` will verify a user's email using the supplied token.
`ApiResponse<ChannelViewResponse>`	`viewChannel(String userId, ChannelView view)` performs a view action for a user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.bis5.mattermost.client4.api.AuditsApi
getAudits, getAudits

Methods inherited from interface net.bis5.mattermost.client4.api.ChannelApi
createGroupChannel, getChannel, getChannelByName, getChannelByNameForTeamName, getChannelMember, getChannelMembers, getChannelMembers, getChannelMembersByIds, getChannelMembersForUser, getChannelsForTeamForUser, getChannelStats, getPinnedPosts, getPublicChannelsByIdsForTeam, getPublicChannelsForTeam, getPublicChannelsForTeam, updateChannelRoles

Methods inherited from interface net.bis5.mattermost.client4.api.CommandsApi
listCommands

Methods inherited from interface net.bis5.mattermost.client4.api.ComplianceApi
getComplianceReports

Methods inherited from interface net.bis5.mattermost.client4.api.EmojiApi
getEmojiList

Methods inherited from interface net.bis5.mattermost.client4.api.GeneralApi
getOldClientConfig, getOldClientLicense

Methods inherited from interface net.bis5.mattermost.client4.api.LogsApi
getLogs

Methods inherited from interface net.bis5.mattermost.client4.api.OAuthApi
getAuthorizedOAuthAppsForUser, getOAuthApps

Methods inherited from interface net.bis5.mattermost.client4.api.PostApi
getFlaggedPostsForUser, getFlaggedPostsForUserInChannel, getFlaggedPostsForUserInTeam, getPost, getPostsAfter, getPostsAfter, getPostsBefore, getPostsBefore, getPostsForChannel, getPostsForChannel, getPostsSince, getPostsSince, getPostThread, searchPosts, updatePost

Methods inherited from interface net.bis5.mattermost.client4.api.StatusApi
getUsersStatusesByIds, getUserStatus

Methods inherited from interface net.bis5.mattermost.client4.api.TeamApi
addTeamMembers, getAllTeams, getAllTeams, getTeam, getTeamByName, getTeamMember, getTeamMembers, getTeamMembers, getTeamMembersByIds, getTeamMembersforUser, getTeamsForUser, getteamStats, removeTeamMember, teamExists, updateTeamMemberRoles

Methods inherited from interface net.bis5.mattermost.client4.api.UserApi
autocompleteUsers, autocompleteUsersInChannel, autocompleteUsersInTeam, getMe, getProfileImage, getSessions, getTeamUnreadForUser, getUser, getUserAudits, getUserAudits, getUserByEmail, getUserByUsername, getUsers, getUsers, getUsersByIds, getUsersByUsernames, getUsersInChannel, getUsersInChannel, getUsersInTeam, getUsersInTeam, getUsersNotInChannel, getUsersNotInChannel, getUsersNotInTeam, getUsersNotInTeam, getUsersWithoutTeam, getUsersWithoutTeam, revokeSession, updateUserRoles

Methods inherited from interface net.bis5.mattermost.client4.api.WebhookApi
getIncomingWebhook, getIncomingWebhooks, getIncomingWebhooks, getIncomingWebhooksForTeam, getIncomingWebhooksForTeam, getOutgoingWebhooks, getOutgoingWebhooks, getOutgoingWebhooksForChannel, getOutgoingWebhooksForChannel, getOutgoingWebhooksForTeam, getOutgoingWebhooksForTeam

Field Detail

API_URL_SUFFIX

protected static final String API_URL_SUFFIX

See Also:: Constant Field Values

HEADER_ETAG_CLIENT

protected static final String HEADER_ETAG_CLIENT

See Also:: Constant Field Values

HEADER_AUTH

protected static final String HEADER_AUTH

See Also:: Constant Field Values

Constructor Detail

MattermostClient
```
public MattermostClient(String url)
```

MattermostClient

public MattermostClient(String url,
                        Level logLevel)

Method Detail

buildClient

protected javax.ws.rs.client.Client buildClient()

close
```
public void close()
           throws Exception
```
Specified by:

close in interface AutoCloseable

Throws:

Exception

See Also:

AutoCloseable.close()

setOAuthToken

public void setOAuthToken(String token)

clearOAuthToken
```
public void clearOAuthToken()
```

setAccessToken
```
public void setAccessToken(String token)
```
Parameters:

token - Personal Access Token to access Mattermost API

Since:

Mattermost Server 4.1

getUsersRoute
```
public String getUsersRoute()
```

getUserRoute

public String getUserRoute(String userId)

getUserByUsernameRoute

public String getUserByUsernameRoute(String userName)

getUserByEmailRoute

public String getUserByEmailRoute(String email)

getTeamsRoute
```
public String getTeamsRoute()
```

getTeamRoute

public String getTeamRoute(String teamId)

getTeamAutoCompleteCommandsRoute

public String getTeamAutoCompleteCommandsRoute(String teamId)

getTeamByNameRoute

public String getTeamByNameRoute(String teamName)

getTeamMemberRoute

public String getTeamMemberRoute(String teamId,
                                 String userId)

getTeamMembersRoute

public String getTeamMembersRoute(String teamId)

getTeamStatsRoute

public String getTeamStatsRoute(String teamId)

getTeamImportRoute

public String getTeamImportRoute(String teamId)

getChannelsRoute
```
public String getChannelsRoute()
```

getChannelsForTeamRoute

public String getChannelsForTeamRoute(String teamId)

getChannelRoute

public String getChannelRoute(String channelId)

getChannelByNameRoute

public String getChannelByNameRoute(String channelName,
                                    String teamId)

getChannelByNameForTeamNameRoute

public String getChannelByNameForTeamNameRoute(String channelName,
                                               String teamName)

getChannelMembersRoute

public String getChannelMembersRoute(String channelId)

getChannelMemberRoute

public String getChannelMemberRoute(String channelId,
                                    String userId)

getPostsRoute
```
public String getPostsRoute()
```

getConfigRoute
```
public String getConfigRoute()
```

getLicenseRoute
```
public String getLicenseRoute()
```

getPostRoute

public String getPostRoute(String postId)

getFilesRoute
```
public String getFilesRoute()
```

getFileRoute

public String getFileRoute(String fileId)

getSystemRoute
```
public String getSystemRoute()
```

getTestEmailRoute
```
public String getTestEmailRoute()
```

getDatabaseRoute
```
public String getDatabaseRoute()
```

getCacheRoute
```
public String getCacheRoute()
```

getClusterRoute
```
public String getClusterRoute()
```

getIncomingWebhooksRoute

public String getIncomingWebhooksRoute()

getIncomingWebhookRoute

public String getIncomingWebhookRoute(String hookId)

getComplianceReportsRoute

public String getComplianceReportsRoute()

getComplianceReportRoute

public String getComplianceReportRoute(String reportId)

getOutgoingWebhooksRoute

public String getOutgoingWebhooksRoute()

getOutgoingWebhookRoute

public String getOutgoingWebhookRoute(String hookId)

getPreferencesRoute

public String getPreferencesRoute(String userId)

getUserStatusRoute

public String getUserStatusRoute(String userId)

getUserStatusesRoute
```
public String getUserStatusesRoute()
```

getSamlRoute
```
public String getSamlRoute()
```

getLdapRoute
```
public String getLdapRoute()
```

getBrandRoute
```
public String getBrandRoute()
```

getCommandsRoute
```
public String getCommandsRoute()
```

getCommandRoute

public String getCommandRoute(String commandId)

getEmojisRoute
```
public String getEmojisRoute()
```

getEmojiRoute

public String getEmojiRoute(String emojiId)

getReactionsRoute
```
public String getReactionsRoute()
```

getOAuthAppsRoute
```
public String getOAuthAppsRoute()
```

getOAuthAppRoute

public String getOAuthAppRoute(String appId)

doApiGet

protected <T> ApiResponse<T> doApiGet(String url,
                                      String etag,
                                      Class<T> responseType)

doApiGet

protected <T> ApiResponse<T> doApiGet(String url,
                                      String etag,
                                      javax.ws.rs.core.GenericType<T> responseType)

doApiGet

protected ApiResponse<Void> doApiGet(String url,
                                     String etag)

doApiPost

protected <T,U> ApiResponse<T> doApiPost(String url,
                                         U data,
                                         Class<T> responseType)

doApiPost

protected <T,U> ApiResponse<T> doApiPost(String url,
                                         U data,
                                         javax.ws.rs.core.GenericType<T> responseType)

doApiPost

protected <U> ApiResponse<Void> doApiPost(String url,
                                          U data)

doApiPostMultiPart

protected ApiResponse<Void> doApiPostMultiPart(String url,
                                               org.glassfish.jersey.media.multipart.MultiPart multiPart)

doApiPostMultiPart

protected <T> ApiResponse<T> doApiPostMultiPart(String url,
                                                org.glassfish.jersey.media.multipart.MultiPart multiPart,
                                                Class<T> responseType)

doApiPut

protected <T,U> ApiResponse<T> doApiPut(String url,
                                        U data,
                                        Class<T> responseType)

doApiPut

protected <U> ApiResponse<Void> doApiPut(String url,
                                         U data)

doApiDelete

protected <T> ApiResponse<T> doApiDelete(String url,
                                         Class<T> responseType)

doApiDelete

protected ApiResponse<Void> doApiDelete(String url)

doApiRequest

protected <T,U> ApiResponse<T> doApiRequest(String method,
                                            String url,
                                            U data,
                                            String etag,
                                            Class<T> responseType)

doApiRequest

protected <T,U> ApiResponse<T> doApiRequest(String method,
                                            String url,
                                            U data,
                                            String etag,
                                            javax.ws.rs.core.GenericType<T> responseType)

doApiRequest

protected <U> ApiResponse<Void> doApiRequest(String method,
                                             String url,
                                             U data,
                                             String etag)

loginById
```
public User loginById(String id,
                      String password)
```
authenticates a user by user id and password.

Specified by:

loginById in interface AuthenticationApi

Parameters:

id -

password -

Returns:

login
```
public User login(String loginId,
                  String password)
```
authenticates a user by login id, which can be username, email, or some sort of SSO identifier based on server configuration, and a password.

Specified by:

login in interface AuthenticationApi

Parameters:

loginId -

password -

Returns:

loginByLdap
```
public User loginByLdap(String loginId,
                        String password)
```
authenticates a user by LDAP id and password.

Specified by:

loginByLdap in interface AuthenticationApi

Parameters:

loginId -

password -

Returns:

loginWithDevice
```
public User loginWithDevice(String loginId,
                            String password,
                            String deviceId)
```
authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.

Specified by:

loginWithDevice in interface AuthenticationApi

Parameters:

loginId -

password -

deviceId -

Returns:

login

protected User login(LoginRequest param)

onLogin

protected ApiResponse<User> onLogin(ApiResponse<Void> loginResponse)

logout
```
public ApiResponse<Boolean> logout()
```
terminates the current user's session.

Specified by:

logout in interface AuthenticationApi

Returns:

onLogout

protected ApiResponse<Boolean> onLogout(ApiResponse<Void> logoutResponse)

switchAccountType
```
public ApiResponse<SwitchAccountTypeResult> switchAccountType(SwitchRequest switchRequest)
```
changes a user's login type from one type to another.

Specified by:

switchAccountType in interface AuthenticationApi

Returns:

createUser
```
public ApiResponse<User> createUser(User user)
```
creates a user in the system based on the provided user object.

Specified by:

createUser in interface UserApi

Parameters:

user -

Returns:

getMe
```
public ApiResponse<User> getMe(String etag)
```
returns the logged in user.

Specified by:

getMe in interface UserApi

Parameters:

etag -

Returns:

getUser

public ApiResponse<User> getUser(String userId,
                                 String etag)

returns a user based on the provided user id string.

Specified by:: getUser in interface UserApi
Parameters:: userId -; etag -
Returns:

getUserByUsername

public ApiResponse<User> getUserByUsername(String userName,
                                           String etag)

returns a user based pn the provided user name string.

Specified by:: getUserByUsername in interface UserApi
Parameters:: userName -; etag -
Returns:

getUserByEmail

public ApiResponse<User> getUserByEmail(String email,
                                        String etag)

returns a user based on the provided user email string.

Specified by:: getUserByEmail in interface UserApi
Parameters:: email -; etag -
Returns:

autocompleteUsersInTeam

public ApiResponse<UserAutocomplete> autocompleteUsersInTeam(String teamId,
                                                             String username,
                                                             String etag)

returns the users on a team based on search term.

Specified by:: autocompleteUsersInTeam in interface UserApi
Parameters:: teamId -; username -; etag -
Returns:

autocompleteUsersInChannel

public ApiResponse<UserAutocomplete> autocompleteUsersInChannel(String teamId,
                                                                String channelId,
                                                                String username,
                                                                String etag)

returns the users in a channel based on search term.

Specified by:: autocompleteUsersInChannel in interface UserApi
Parameters:: teamId -; channelId -; username -; etag -
Returns:

autocompleteUsers

public ApiResponse<UserAutocomplete> autocompleteUsers(String username,
                                                       String etag)

returns the users in the system based on search term.

Specified by:: autocompleteUsers in interface UserApi
Parameters:: username -; etag -
Returns:

getProfileImage
```
public ApiResponse<byte[]> getProfileImage(String userId,
                                           String etag)
```
gets user's profile image. Must be logged in or be a system administrator.

Specified by:

getProfileImage in interface UserApi

Parameters:

userId -

etag -

Returns:

getUsers

public ApiResponse<UserList> getUsers(Pager pager,
                                      String etag)

returns a page of users on the system. Page counting starts at 0.

Specified by:: getUsers in interface UserApi
Parameters:: pager -; etag -
Returns:

getUsersInTeam

public ApiResponse<UserList> getUsersInTeam(String teamId,
                                            Pager pager,
                                            String etag)

returns a page of users on a team. Page counting starts at 0.

Specified by:: getUsersInTeam in interface UserApi
Parameters:: teamId -; pager -; etag -
Returns:

getUsersNotInTeam

public ApiResponse<UserList> getUsersNotInTeam(String teamId,
                                               Pager pager,
                                               String etag)

returns a page of users who are not in a team. Page counting starts at 0.

Specified by:: getUsersNotInTeam in interface UserApi
Parameters:: teamId -; pager -; etag -
Returns:

getUsersInChannel

public ApiResponse<UserList> getUsersInChannel(String channelId,
                                               Pager pager,
                                               String etag)

returns a page of users on a team. Page counting starts at 0.

Specified by:: getUsersInChannel in interface UserApi
Parameters:: channelId -; pager -; etag -
Returns:

getUsersNotInChannel

public ApiResponse<UserList> getUsersNotInChannel(String teamId,
                                                  String channelId,
                                                  Pager pager,
                                                  String etag)

returns a page of users on a team. Page counting starts at 0.

Specified by:: getUsersNotInChannel in interface UserApi
Parameters:: teamId -; channelId -; pager -; etag -
Returns:

getUsersWithoutTeam
```
public ApiResponse<UserList> getUsersWithoutTeam(Pager pager,
                                                 String etag)
```
returns a page of users on the system that aren't on any teams. Page counting starts at 0.

Specified by:

getUsersWithoutTeam in interface UserApi

Parameters:

pager -

etag -

Returns:

getUsersByIds
```
public ApiResponse<UserList> getUsersByIds(String... userIds)
```
returns a list of users based on the provided user ids.

Specified by:

getUsersByIds in interface UserApi

Parameters:

userIds -

Returns:

getUsersByUsernames
```
public ApiResponse<UserList> getUsersByUsernames(String... usernames)
```
returns a list of users based on the provided usernames.

Specified by:

getUsersByUsernames in interface UserApi

Parameters:

usernames -

Returns:

searchUsers
```
public ApiResponse<UserList> searchUsers(UserSearch search)
```
returns a list of users based on some search criteria.

Specified by:

searchUsers in interface UserApi

Parameters:

search -

Returns:

updateUser
```
public ApiResponse<User> updateUser(User user)
```
updates a user in the system based on the provided user object.

Specified by:

updateUser in interface UserApi

Parameters:

user -

Returns:

patchUser
```
public ApiResponse<User> patchUser(String userId,
                                   UserPatch patch)
```
partially updates a user in the system. Any missing fields are not updated.

Specified by:

patchUser in interface UserApi

Parameters:

userId -

patch -

Returns:

updateUserMfa
```
public ApiResponse<Boolean> updateUserMfa(String userId,
                                          String code,
                                          boolean activate)
```
activates multi-factor authentication for a user if activate is true and a valid code is provided. If activate is false, then code is not required and multi-factor authentication is disabled for the user.

Specified by:

updateUserMfa in interface UserApi

Parameters:

userId -

code -

activate -

Returns:

checkUserMfa
```
public boolean checkUserMfa(String loginId)
```
checks whether a user has MFA active on their account or not based on the provided login id.

Specified by:

checkUserMfa in interface UserApi

Parameters:

loginId -

Returns:

generateMfaSecret
```
public ApiResponse<MfaSecret> generateMfaSecret(String userId)
```
will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.

Specified by:

generateMfaSecret in interface UserApi

Parameters:

userId -

Returns:

updateUserPassword

public ApiResponse<Boolean> updateUserPassword(String userId,
                                               String currentPassword,
                                               String newPassword)

updates a user's password. Must be logged in as the user or be a system administrator.

Specified by:: updateUserPassword in interface UserApi
Parameters:: userId -; currentPassword -; newPassword -
Returns:

updateUserRoles
```
public ApiResponse<Boolean> updateUserRoles(String userId,
                                            Role... roles)
```
updates a user's roles in the system. A user can have "system_user" and "system_admin" roles.

Specified by:

updateUserRoles in interface UserApi

Parameters:

userId -

role -

Returns:

updateUserActive
```
public ApiResponse<Boolean> updateUserActive(String userId,
                                             boolean active)
```
updates status of a user whether active or not.

Specified by:

updateUserActive in interface UserApi

Parameters:

userId -

active -

Returns:

deleteUser
```
public ApiResponse<Boolean> deleteUser(String userId)
```
deactivates a user in the system based on the provided user id string.

Specified by:

deleteUser in interface UserApi

Parameters:

userId -

Returns:

sendPasswordResetEmail
```
public ApiResponse<Boolean> sendPasswordResetEmail(String email)
```
will send a link for password resetting to a user with the provided email.

Specified by:

sendPasswordResetEmail in interface UserApi

Parameters:

email -

Returns:

resetPassword

public ApiResponse<Boolean> resetPassword(String token,
                                          String newPassword)

uses a recovery code to update reset a user's password.

Specified by:: resetPassword in interface UserApi
Parameters:: token -; newPassword -
Returns:

getSessions

public ApiResponse<SessionList> getSessions(String userId,
                                            String etag)

returns a list of sessions based on the provided user id string.

Specified by:: getSessions in interface UserApi
Parameters:: userId -; etag -
Returns:

revokeSession
```
public ApiResponse<Boolean> revokeSession(String userId,
                                          String sessionId)
```
revokes a user session based on the provided user id and session id strings.

Specified by:

revokeSession in interface UserApi

Parameters:

userId -

sessionId -

Returns:

attachDeviceId
```
public ApiResponse<Boolean> attachDeviceId(String deviceId)
```
attaches a mobile device ID to the current session/

Specified by:

attachDeviceId in interface UserApi

Parameters:

deviceId -

Returns:

getTeamUnreadForUser
```
public ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId,
                                                        String teamIdToExclude)
```
will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to. An optional team ID can be set to exclude that team from the results. Must be authenticated.

Specified by:

getTeamUnreadForUser in interface UserApi

Parameters:

userId -

teamIdToExclude -

Returns:

getUserAudits

public ApiResponse<Audits> getUserAudits(String userId,
                                         Pager pager,
                                         String etag)

returns a list of audit based on the provided user id string.

Specified by:: getUserAudits in interface UserApi
Parameters:: userId -; pager -; etag -
Returns:

verifyUserEmail
```
public ApiResponse<Boolean> verifyUserEmail(String token)
```
will verify a user's email using the supplied token.

Specified by:

verifyUserEmail in interface UserApi

Parameters:

token -

Returns:

sendVerificationEmail
```
public ApiResponse<Boolean> sendVerificationEmail(String email)
```
will send an email to the user with the provided email addresses, if that user exists. The email will contain a link that can be used to verify the user's email address.

Specified by:

sendVerificationEmail in interface UserApi

Parameters:

email -

Returns:

setProfileImage

public ApiResponse<Boolean> setProfileImage(String userId,
                                            Path imageFilePath)

sets profile image of the user.

Specified by:: setProfileImage in interface UserApi
Parameters:: userId -; imageFilePath -
Returns:

createTeam
```
public ApiResponse<Team> createTeam(Team team)
```
creates a team in the system based on the provided team object.

Specified by:

createTeam in interface TeamApi

Parameters:

team -

Returns:

getTeam

public ApiResponse<Team> getTeam(String teamId,
                                 String etag)

returns a team based on the provided team is string/

Specified by:: getTeam in interface TeamApi
Parameters:: teamId -; etag -
Returns:

getAllTeams

public ApiResponse<TeamList> getAllTeams(Pager pager,
                                         String etag)

returns all teams based on permssions.

Specified by:: getAllTeams in interface TeamApi
Parameters:: pager -; etag -
Returns:

getTeamByName

public ApiResponse<Team> getTeamByName(String name,
                                       String etag)

returns a team based on the provided team name string.

Specified by:: getTeamByName in interface TeamApi
Parameters:: name -; etag -
Returns:

searchTeams
```
public ApiResponse<TeamList> searchTeams(TeamSearch search)
```
returns teams matching the provided search term.

Specified by:

searchTeams in interface TeamApi

Parameters:

search -

Returns:

teamExists

public ApiResponse<TeamExists> teamExists(String name,
                                          String etag)

returns true or false if the team exist or not.

Specified by:: teamExists in interface TeamApi
Parameters:: name -; etag -
Returns:

getTeamsForUser
```
public ApiResponse<TeamList> getTeamsForUser(String userId,
                                             String etag)
```
returns a list of teams a user is on. Must be logged in as the user or be a system administrator.

Specified by:

getTeamsForUser in interface TeamApi

Parameters:

userId -

etag -

Returns:

getTeamMember

public ApiResponse<TeamMember> getTeamMember(String teamId,
                                             String userId,
                                             String etag)

returns a team member based on the provided team and user id strings.

Specified by:: getTeamMember in interface TeamApi
Parameters:: teamId -; userId -; etag -
Returns:

updateTeamMemberRoles

public ApiResponse<Boolean> updateTeamMemberRoles(String teamId,
                                                  String userId,
                                                  Role... newRoles)

will update the roles on a team for a user.

Specified by:: updateTeamMemberRoles in interface TeamApi
Parameters:: teamId -; userId -; newRoles -
Returns:

updateTeam
```
public ApiResponse<Team> updateTeam(Team team)
```
will update a team.

Specified by:

updateTeam in interface TeamApi

Parameters:

team -

Returns:

patchTeam

public ApiResponse<Team> patchTeam(String teamId,
                                   TeamPatch patch)

partially updates a team. Any missing fields are not updated.

Specified by:: patchTeam in interface TeamApi
Parameters:: teamId -; patch -
Returns:

deleteTeam
```
public ApiResponse<Boolean> deleteTeam(String teamId)
```
deletes the team softly (archive only, not permanent delete).

Specified by:

deleteTeam in interface TeamApi

Parameters:

teamId -

Returns:

See Also:

#deleteTeam(String, boolean)}

deleteTeam
```
public ApiResponse<Boolean> deleteTeam(String teamId,
                                       boolean permanent)
```
deletes the team

Specified by:

deleteTeam in interface TeamApi

Parameters:

teamId -

permanent - true: Permanently delete the team, to be used for compliance reasons only.

Returns:

See Also:

#deleteTeam(String)}

getTeamMembers

public ApiResponse<TeamMemberList> getTeamMembers(String teamId,
                                                  Pager pager,
                                                  String etag)

returns team members based on the provided team id string.

Specified by:: getTeamMembers in interface TeamApi
Parameters:: teamId -; pager -; etag -
Returns:

getTeamMembersForUser

public ApiResponse<TeamMemberList> getTeamMembersForUser(String userId,
                                                         String etag)

returns the team member for a user.

Specified by:: getTeamMembersForUser in interface TeamApi
Parameters:: userId -; etag -
Returns:

getTeamMembersByIds
```
public ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId,
                                                       String... userIds)
```
will return an array of team members based on the team id and a list of user ids provided. Must be authenticated.

Specified by:

getTeamMembersByIds in interface TeamApi

Parameters:

teamId -

userIds -

Returns:

addTeamMember
```
public ApiResponse<TeamMember> addTeamMember(TeamMember teamMemberToAdd)
```
add user to a team and return a team member.

Specified by:

addTeamMember in interface TeamApi

Parameters:

teamMemberToAdd -

Returns:

addTeamMember

@Deprecated
public ApiResponse<TeamMember> addTeamMember(String teamId,
                                                         String userId,
                                                         String hash,
                                                         String dataToHash,
                                                         String inviteId)

Deprecated. API Change on Mattermost 4.0

Specified by:: addTeamMember in interface TeamApi
Parameters:: teamId -; userId -; hash -; dataToHash -; inviteId -
Returns:

addTeamMember

public ApiResponse<TeamMember> addTeamMember(String hash,
                                             String dataToHash,
                                             String inviteId)

adds user to a team and return a team member.

Specified by:: addTeamMember in interface TeamApi
Parameters:: hash -; dataToHash -; inviteId -
Returns:
Since:: Mattermost 4.0

addTeamMembers

public ApiResponse<TeamMemberList> addTeamMembers(String teamId,
                                                  String... userIds)

adds a number of users to a team and returns the team members.

Specified by:: addTeamMembers in interface TeamApi
Parameters:: teamId -; userIds -
Returns:

removeTeamMember

public ApiResponse<Boolean> removeTeamMember(String teamId,
                                             String userId)

will remove a user from a team.

Specified by:: removeTeamMember in interface TeamApi
Parameters:: teamId -; userId -
Returns:

getTeamStats

public ApiResponse<TeamStats> getTeamStats(String teamId,
                                           String etag)

returns a team stats based on the team id string. Must be authenticated.

Specified by:: getTeamStats in interface TeamApi
Parameters:: teamId -; etag -
Returns:

getTeamUnread
```
public ApiResponse<TeamUnread> getTeamUnread(String teamId,
                                             String userId)
```
will return a TeamUnread object that contains the amount of unread messages and mentions the user has for the specified team. Must be authenticated.

Specified by:

getTeamUnread in interface TeamApi

Parameters:

teamId -

userId -

Returns:

importTeam

public ApiResponse<byte[]> importTeam(byte[] data,
                                      int filesize,
                                      String importFrom,
                                      String fileName,
                                      String teamId)

will import an exported team from other app into a existing team.

Specified by:: importTeam in interface TeamApi
Parameters:: data -; filesize -; importFrom -; fileName -; teamId -
Returns:

inviteUsersToTeam

public ApiResponse<Boolean> inviteUsersToTeam(String teamId,
                                              Collection<String> userEmails)

invite users by email to the team.

Specified by:: inviteUsersToTeam in interface TeamApi
Parameters:: teamId -; userEmails -
Returns:

createChannel
```
public ApiResponse<Channel> createChannel(Channel channel)
```
creates a channel based on the provided channel object.

Specified by:

createChannel in interface ChannelApi

Parameters:

channel -

Returns:

updateChannel
```
public ApiResponse<Channel> updateChannel(Channel channel)
```
update a channel based on the provided channel object.

Specified by:

updateChannel in interface ChannelApi

Parameters:

channel -

Returns:

patchChannel

public ApiResponse<Channel> patchChannel(String channelId,
                                         ChannelPatch patch)

partially updates a channel. Any missing fields are not updated.

Specified by:: patchChannel in interface ChannelApi
Parameters:: channelId -; patch -
Returns:

createDirectChannel

public ApiResponse<Channel> createDirectChannel(String userId1,
                                                String userId2)

creates a direct message channel based on the two user ids provided.

Specified by:: createDirectChannel in interface ChannelApi
Parameters:: userId1 -; userId2 -
Returns:

createGroupChannel
```
public ApiResponse<Channel> createGroupChannel(String... userIds)
```
creates a group message channel based on userIds provided.

Specified by:

createGroupChannel in interface ChannelApi

Parameters:

userIds -

Returns:

getChannel

public ApiResponse<Channel> getChannel(String channelId,
                                       String etag)

returns a channel based on the provided channel id string.

Specified by:: getChannel in interface ChannelApi
Parameters:: channelId -; etag -
Returns:

getChannelStats

public ApiResponse<ChannelStats> getChannelStats(String channelId,
                                                 String etag)

returns statistics for a channel.

Specified by:: getChannelStats in interface ChannelApi
Parameters:: channelId -; etag -
Returns:

getPinnedPosts

public ApiResponse<PostList> getPinnedPosts(String channelId,
                                            String etag)

gets a list of pinned posts.

Specified by:: getPinnedPosts in interface ChannelApi
Parameters:: channelId -; etag -
Returns:

getPublicChannelsForTeam

public ApiResponse<ChannelList> getPublicChannelsForTeam(String teamId,
                                                         Pager pager,
                                                         String etag)

returns a list of public channels based on the provided team id string.

Specified by:: getPublicChannelsForTeam in interface ChannelApi
Parameters:: teamId -; pager -; etag -
Returns:

getPublicChannelsByIdsForTeam

public ApiResponse<ChannelList> getPublicChannelsByIdsForTeam(String teamId,
                                                              String... channelIds)

returns a list of public channeld based on provided team id string.

Specified by:: getPublicChannelsByIdsForTeam in interface ChannelApi
Parameters:: teamId -; channelIds -
Returns:

getChannelsForTeamForUser

public ApiResponse<ChannelList> getChannelsForTeamForUser(String teamId,
                                                          String userId,
                                                          String etag)

returns a list channels of on a team for user.

Specified by:: getChannelsForTeamForUser in interface ChannelApi
Parameters:: teamId -; userId -; etag -
Returns:

searchChannels

public ApiResponse<ChannelList> searchChannels(String teamId,
                                               ChannelSearch search)

returns the channels on a team matching the provided search term.

Specified by:: searchChannels in interface ChannelApi
Parameters:: teamId -; search -
Returns:

deleteChannel
```
public ApiResponse<Boolean> deleteChannel(String channelId)
```
deletes channel based on the provided channel id string.

Specified by:

deleteChannel in interface ChannelApi

Parameters:

channelId -

Returns:

getChannelByName

public ApiResponse<Channel> getChannelByName(String channelName,
                                             String teamId,
                                             String etag)

returns a channel based on the provided channel name and team id strings.

Specified by:: getChannelByName in interface ChannelApi
Parameters:: channelName -; teamId -; etag -
Returns:

getChannelByNameForTeamName

public ApiResponse<Channel> getChannelByNameForTeamName(String channelName,
                                                        String teamName,
                                                        String etag)

returns a channel based on the provided channel name and team name strings.

Specified by:: getChannelByNameForTeamName in interface ChannelApi
Parameters:: channelName -; teamName -; etag -
Returns:

getChannelMembers

public ApiResponse<ChannelMembers> getChannelMembers(String channelId,
                                                     Pager pager,
                                                     String etag)

gets a page of channel members.

Specified by:: getChannelMembers in interface ChannelApi
Parameters:: channelId -
Returns:

getChannelMembersByIds

public ApiResponse<ChannelMembers> getChannelMembersByIds(String channelId,
                                                          String... userIds)

gets the channel members in a channel for a list of user ids.

Specified by:: getChannelMembersByIds in interface ChannelApi
Parameters:: channelId -; userIds -
Returns:

getChannelMember

public ApiResponse<ChannelMember> getChannelMember(String channelId,
                                                   String userId,
                                                   String etag)

gets a channel memner.

Specified by:: getChannelMember in interface ChannelApi
Parameters:: channelId -; userId -; etag -
Returns:

getChannelMembersForUser

public ApiResponse<ChannelMembers> getChannelMembersForUser(String userId,
                                                            String teamId,
                                                            String etag)

gets all the channel members for a user on a team.

Specified by:: getChannelMembersForUser in interface ChannelApi
Parameters:: userId -; teamId -; etag -
Returns:

viewChannel

public ApiResponse<ChannelViewResponse> viewChannel(String userId,
                                                    ChannelView view)

performs a view action for a user. synonymous with switching channels or marking channels as read by a user.

Specified by:: viewChannel in interface ChannelApi
Parameters:: userId -; view -
Returns:

getChannelUnread
```
public ApiResponse<ChannelUnread> getChannelUnread(String channelId,
                                                   String userId)
```
will return a ChannelUnread object that contains the number ofo unread messages and mentions for a user.

Specified by:

getChannelUnread in interface ChannelApi

Parameters:

channelId -

userId -

Returns:

updateChannelRoles

public ApiResponse<Boolean> updateChannelRoles(String channelId,
                                               String userId,
                                               Role... roles)

will update the roles on a channel for a user.

Specified by:: updateChannelRoles in interface ChannelApi
Parameters:: channelId -; userId -; roles -
Returns:

updateChannelNotifyProps

public ApiResponse<Boolean> updateChannelNotifyProps(String channelId,
                                                     String userId,
                                                     Map<String,String> props)

will update the notification properties on a channel for a user.

Specified by:: updateChannelNotifyProps in interface ChannelApi
Parameters:: channelId -; userId -; props -
Returns:

addChannelMember

public ApiResponse<ChannelMember> addChannelMember(String channelId,
                                                   String userId)

adds user to channel and return a channel memner.

Specified by:: addChannelMember in interface ChannelApi
Parameters:: channelId -; userId -
Returns:

removeUserFromChannel
```
public ApiResponse<Boolean> removeUserFromChannel(String channelId,
                                                  String userId)
```
will delete the channel member object for a user, effectively removing the user from a channel.

Specified by:

removeUserFromChannel in interface ChannelApi

Parameters:

channelId -

userId -

Returns:

createPost
```
public ApiResponse<Post> createPost(Post post)
```
creates a post based on the provided post object.

Specified by:

createPost in interface PostApi

Parameters:

post -

Returns:

updatePost

public ApiResponse<Post> updatePost(String postId,
                                    Post post)

updates a post based on the provided post object.

Specified by:: updatePost in interface PostApi
Parameters:: postId -; post -
Returns:

patchPost

public ApiResponse<Post> patchPost(String postId,
                                   PostPatch patch)

partially updates a post. Any missing fields are not updated.

Specified by:: patchPost in interface PostApi
Parameters:: postId -; patch -
Returns:

pinPost
```
public ApiResponse<Boolean> pinPost(String postId)
```
pin a post based on proviced post id string.

Specified by:

pinPost in interface PostApi

Parameters:

postId -

Returns:

unpinPost
```
public ApiResponse<Boolean> unpinPost(String postId)
```
unpin a post based on provided post id string.

Specified by:

unpinPost in interface PostApi

Parameters:

postId -

Returns:

getPost

public ApiResponse<Post> getPost(String postId,
                                 String etag)

gets a single post.

Specified by:: getPost in interface PostApi
Parameters:: postId -; etag -
Returns:

deletePost
```
public ApiResponse<Boolean> deletePost(String postId)
```
deletes a post from the provided post id string.

Specified by:

deletePost in interface PostApi

Parameters:

postId -

Returns:

getPostThread

public ApiResponse<PostList> getPostThread(String postId,
                                           String etag)

gets a post with all the other posts in the same thread.

Specified by:: getPostThread in interface PostApi
Parameters:: postId -; etag -
Returns:

getPostsForChannel

public ApiResponse<PostList> getPostsForChannel(String channelId,
                                                Pager pager,
                                                String etag)

gets a page of posts with an array for ordering for a channel.

Specified by:: getPostsForChannel in interface PostApi
Parameters:: channelId -; pager -; etag -
Returns:

getFlaggedPostsForUser

public ApiResponse<PostList> getFlaggedPostsForUser(String userId,
                                                    Pager pager)

returns flagges posts of a user based on user id string.

Specified by:: getFlaggedPostsForUser in interface PostApi
Parameters:: userId -; pager -
Returns:

getFlaggedPostsForUserInTeam

public ApiResponse<PostList> getFlaggedPostsForUserInTeam(String userId,
                                                          String teamId,
                                                          Pager pager)

returns flagged posts in team of a user based on user id string.

Specified by:: getFlaggedPostsForUserInTeam in interface PostApi
Parameters:: userId -; teamId -; pager -
Returns:

getFlaggedPostsForUserInChannel

public ApiResponse<PostList> getFlaggedPostsForUserInChannel(String userId,
                                                             String channelId,
                                                             Pager pager)

returns flagged posts in channel of a user based on user id string.

Specified by:: getFlaggedPostsForUserInChannel in interface PostApi
Parameters:: userId -; channelId -; pager -
Returns:

getPostsSince
```
public ApiResponse<PostList> getPostsSince(String channelId,
                                           long time)
```
gets posts created after a specified time as Unix time in milliseconds.

Specified by:

getPostsSince in interface PostApi

Parameters:

channelId -

time -

Returns:

getPostsAfter

public ApiResponse<PostList> getPostsAfter(String channelId,
                                           String postId,
                                           Pager pager,
                                           String etag)

gets a page of posts that were posted after the post provided.

Specified by:: getPostsAfter in interface PostApi
Parameters:: channelId -; postId -; pager -; etag -
Returns:

getPostsBefore

public ApiResponse<PostList> getPostsBefore(String channelId,
                                            String postId,
                                            Pager pager,
                                            String etag)

gets a page of posts that were posted before the post provided.

Specified by:: getPostsBefore in interface PostApi
Parameters:: channelId -; postId -; pager -; etag -
Returns:

searchPosts

public ApiResponse<PostList> searchPosts(String teamId,
                                         String terms,
                                         boolean isOrSearch)

returns any posts with matching term string.

Specified by:: searchPosts in interface PostApi
Parameters:: teamId -; terms -; isOrSearch -
Returns:

getPing
```
public ApiResponse<Boolean> getPing()
```
will ping the server and to see if it is up and running.

Specified by:

getPing in interface GeneralApi

Returns:

testEmail
```
public ApiResponse<Boolean> testEmail()
```
will attempt to connect to the configured SMTP server.

Specified by:

testEmail in interface GeneralApi

Returns:

getConfig
```
public ApiResponse<Config> getConfig()
```
will retrieve the server config with some sanitized items.

Specified by:

getConfig in interface GeneralApi

Returns:

reloadConfig
```
public ApiResponse<Boolean> reloadConfig()
```
will reload the server configuration.

Specified by:

reloadConfig in interface GeneralApi

Returns:

getOldClientConfig
```
public ApiResponse<Map<String,String>> getOldClientConfig(String etag)
```
will retrieve the parts of the server configuration needed by the client, formatted in the old format.

Specified by:

getOldClientConfig in interface GeneralApi

Parameters:

etag -

Returns:

getOldClientLicense
```
public ApiResponse<Map<String,String>> getOldClientLicense(String etag)
```
will retrieve the parts of the server license needed by the client, formatted in the old format.

Specified by:

getOldClientLicense in interface GeneralApi

Parameters:

etag -

Returns:

databaseRecycle
```
public ApiResponse<Boolean> databaseRecycle()
```
will recycle the connections. Discard current connection and get new one.

Specified by:

databaseRecycle in interface GeneralApi

Returns:

invalidateCaches
```
public ApiResponse<Boolean> invalidateCaches()
```
will purge the cache and can affect the performance while is cleaning.

Specified by:

invalidateCaches in interface GeneralApi

Returns:

updateConfig
```
public ApiResponse<Config> updateConfig(Config config)
```
will update the server configuration.

Specified by:

updateConfig in interface GeneralApi

Parameters:

config -

Returns:

createIncomingWebhook
```
public ApiResponse<IncomingWebhook> createIncomingWebhook(IncomingWebhook hook)
```
creates an incoming webhook for a channel.

Specified by:

createIncomingWebhook in interface WebhookApi

Parameters:

hook -

Returns:

updateIncomingWebhook
```
public ApiResponse<IncomingWebhook> updateIncomingWebhook(IncomingWebhook hook)
```
updates an incoming webhook for a channel.

Specified by:

updateIncomingWebhook in interface WebhookApi

Parameters:

hook -

Returns:

getIncomingWebhooks

public ApiResponse<IncomingWebhookList> getIncomingWebhooks(Pager pager,
                                                            String etag)

returns a page of incoming webhooks on the system. Page counting starts at 0.

Specified by:: getIncomingWebhooks in interface WebhookApi
Parameters:: pager -; etag -
Returns:

getIncomingWebhooksForTeam

public ApiResponse<IncomingWebhookList> getIncomingWebhooksForTeam(String teamId,
                                                                   Pager pager,
                                                                   String etag)

returns a page of incoming webhooks for a team. Page counting starts at 0.

Specified by:: getIncomingWebhooksForTeam in interface WebhookApi
Parameters:: teamId -; pager -; etag -
Returns:

getIncomingWebhook

public ApiResponse<IncomingWebhook> getIncomingWebhook(String hookId,
                                                       String etag)

returns an Incoming webhook given the hook id.

Specified by:: getIncomingWebhook in interface WebhookApi
Parameters:: hookId -; etag -
Returns:

deleteIncomingWebhook
```
public ApiResponse<Boolean> deleteIncomingWebhook(String hookId)
```
deletes an Incoming Webhook given the hook id.

Specified by:

deleteIncomingWebhook in interface WebhookApi

Parameters:

hookId -

Returns:

createOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> createOutgoingWebhook(OutgoingWebhook hook)
```
creates an outgoing webhook for a team or channel.

Specified by:

createOutgoingWebhook in interface WebhookApi

Parameters:

hook -

Returns:

updateOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> updateOutgoingWebhook(OutgoingWebhook hook)
```
updates an outgoing webhook.

Specified by:

updateOutgoingWebhook in interface WebhookApi

Parameters:

hook -

Returns:

getOutgoingWebhooks

public ApiResponse<OutgoingWebhookList> getOutgoingWebhooks(Pager pager,
                                                            String etag)

returns a page of outgoing webhooks ont eh system. Page counting starts at 0.

Specified by:: getOutgoingWebhooks in interface WebhookApi
Parameters:: pager -; etag -
Returns:

getOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> getOutgoingWebhook(String hookId)
```
outgoing webhooks on the system requested by hook id.

Specified by:

getOutgoingWebhook in interface WebhookApi

Parameters:

hookId -

Returns:

getOutgoingWebhooksForChannel

public ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForChannel(String channelId,
                                                                      Pager pager,
                                                                      String etag)

returns a page of outgoing webhooks for a channel. Page counting starts at 0.

Specified by:: getOutgoingWebhooksForChannel in interface WebhookApi
Parameters:: channelId -; pager -; etag -
Returns:

getOutgoingWebhooksForTeam

public ApiResponse<OutgoingWebhookList> getOutgoingWebhooksForTeam(String teamId,
                                                                   Pager pager,
                                                                   String etag)

returns a page of outgoing webhooks for a team. Page counting starts at 0.

Specified by:: getOutgoingWebhooksForTeam in interface WebhookApi
Parameters:: teamId -; pager -; etag -
Returns:

regenOutgoingHookToken
```
public ApiResponse<OutgoingWebhook> regenOutgoingHookToken(String hookId)
```
regenerate the outgoing webhook token.

Specified by:

regenOutgoingHookToken in interface WebhookApi

Parameters:

hookId -

Returns:

deleteOutgoingWebhook
```
public ApiResponse<Boolean> deleteOutgoingWebhook(String hookId)
```
delete the outgoing webhook on the system requested by hook id.

Specified by:

deleteOutgoingWebhook in interface WebhookApi

Parameters:

hookId -

Returns:

getPreferences
```
public ApiResponse<Preferences> getPreferences(String userId)
```
returns the user's preferences.

Specified by:

getPreferences in interface PreferencesApi

Parameters:

userId -

Returns:

updatePreferences

public ApiResponse<Boolean> updatePreferences(String userId,
                                              Preferences preferences)

saves the user's preferences.

Specified by:: updatePreferences in interface PreferencesApi
Parameters:: userId -; preferences -
Returns:

deletePreferences

public ApiResponse<Boolean> deletePreferences(String userId,
                                              Preferences preferences)

deletes the user's preferences.

Specified by:: deletePreferences in interface PreferencesApi
Parameters:: userId -; preferences -
Returns:

getPreferencesByCategory

public ApiResponse<Preferences> getPreferencesByCategory(String userId,
                                                         PreferenceCategory category)

returns the user's preferences from the provided category string.

Specified by:: getPreferencesByCategory in interface PreferencesApi
Parameters:: userId -; category -
Returns:

getPreferenceByCategoryAndName

public ApiResponse<Preference> getPreferenceByCategoryAndName(String userId,
                                                              PreferenceCategory category,
                                                              String preferenceName)

returns the user's preferences from the provided category and preference name string.

Specified by:: getPreferenceByCategoryAndName in interface PreferencesApi
Parameters:: userId -; category -; preferenceName -
Returns:

getSamlMetadata
```
public ApiResponse<String> getSamlMetadata()
```
returns metadata for the SAML configuration.

Specified by:

getSamlMetadata in interface SamlApi

Returns:

samlFileToMultipart

protected Object samlFileToMultipart(Path dataFile,
                                     String dataFileName)

uploadSamlIdpCertificate
```
public boolean uploadSamlIdpCertificate(Path dataFile,
                                        String fileName)
```
will upload an IDP certificate for SAML and set the config to use it.

Specified by:

uploadSamlIdpCertificate in interface SamlApi

Parameters:

dataFile -

fileName -

Returns:

uploadSamlPublicCertificate
```
public boolean uploadSamlPublicCertificate(Path dataFile,
                                           String fileName)
```
will upload a public certificate for SAML and set the config to use it.

Specified by:

uploadSamlPublicCertificate in interface SamlApi

Parameters:

dataFile -

fileName -

Returns:

uploadSamlPrivateCertificate
```
public boolean uploadSamlPrivateCertificate(Path dataFile,
                                            String fileName)
```
will upload a private key for SAML and set the config to use it.

Specified by:

uploadSamlPrivateCertificate in interface SamlApi

Parameters:

dataFile -

fileName -

Returns:

deleteSamlIdpCertificate
```
public ApiResponse<Boolean> deleteSamlIdpCertificate()
```
deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

Specified by:

deleteSamlIdpCertificate in interface SamlApi

Returns:

deleteSamlPublicCertificate
```
public ApiResponse<Boolean> deleteSamlPublicCertificate()
```
deletes the saml IDP certificate from the server and updates the config to not use it and disable SAML.

Specified by:

deleteSamlPublicCertificate in interface SamlApi

Returns:

deleteSamlPrivateCertificate
```
public ApiResponse<Boolean> deleteSamlPrivateCertificate()
```
deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

Specified by:

deleteSamlPrivateCertificate in interface SamlApi

Returns:

getSamlCertificateStatus
```
public ApiResponse<SamlCertificateStatus> getSamlCertificateStatus()
```
returns metadata for the SAML configuration.

Specified by:

getSamlCertificateStatus in interface SamlApi

Returns:

createComplianceReport
```
public ApiResponse<Compliance> createComplianceReport(Compliance report)
```
creates a compliance report.

Specified by:

createComplianceReport in interface ComplianceApi

Parameters:

report -

Returns:

getComplianceReports
```
public ApiResponse<Compliances> getComplianceReports(Pager pager)
```
returns list of compliance reports.

Specified by:

getComplianceReports in interface ComplianceApi

Parameters:

pager -

Returns:

getComplianceReport
```
public ApiResponse<Compliance> getComplianceReport(String reportId)
```
returns a compliance report.

Specified by:

getComplianceReport in interface ComplianceApi

Parameters:

reportId -

Returns:

downloadComplianceReport
```
public ApiResponse<Object> downloadComplianceReport(String reportId)
```
returns a full compliance report as a file/

Specified by:

downloadComplianceReport in interface ComplianceApi

Parameters:

reportId -

Returns:

getClusterStatus
```
public ApiResponse<List<ClusterInfo>> getClusterStatus()
```
Specified by:

getClusterStatus in interface ClusterApi

Returns:

syncLdap
```
public ApiResponse<Boolean> syncLdap()
```
will force a sync with the configured LDAP server.

Specified by:

syncLdap in interface LdapApi

Returns:

testLdap
```
public ApiResponse<Boolean> testLdap()
```
will attempt to connect to the configured LDAP server and return OK if configured correctly.

Specified by:

testLdap in interface LdapApi

Returns:

getAudits

public ApiResponse<Audits> getAudits(Pager pager,
                                     String etag)

returns a list of audits for the whole system.

Specified by:: getAudits in interface AuditsApi
Parameters:: pager -; etag -
Returns:

getBrandImage
```
public ApiResponse<Object> getBrandImage()
```
retrieves the previously uploaded brand image.

Specified by:

getBrandImage in interface BrandApi

Returns:

uploadBrandImage
```
public boolean uploadBrandImage(Path dataFile)
```
sets the brand image for the system.

Specified by:

uploadBrandImage in interface BrandApi

Parameters:

dataFile -

Returns:

getLogs
```
public ApiResponse<List<String>> getLogs(Pager pager)
```
page of logs as a string list.

Specified by:

getLogs in interface LogsApi

Parameters:

pager -

Returns:

postLog
```
public ApiResponse<Map<String,String>> postLog(Map<String,String> message)
```
This method is a convenience Web Service call so clients can log messages into the server-side logs. For example we typically log javascript error messages into the server-side. It returns the log message if the logging was successful.

Specified by:

postLog in interface LogsApi

Parameters:

message -

Returns:

createOAuthApp
```
public ApiResponse<OAuthApp> createOAuthApp(OAuthApp app)
```
will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

Specified by:

createOAuthApp in interface OAuthApi

Parameters:

app -

Returns:

getOAuthApps
```
public ApiResponse<List<OAuthApp>> getOAuthApps(Pager pager)
```
gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.

Specified by:

getOAuthApps in interface OAuthApi

Parameters:

pager -

Returns:

getOAuthApp
```
public ApiResponse<OAuthApp> getOAuthApp(String appId)
```
gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

Specified by:

getOAuthApp in interface OAuthApi

Parameters:

appId -

Returns:

getOAuthAppInfo
```
public ApiResponse<OAuthApp> getOAuthAppInfo(String appId)
```
gets a sanitized version of a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

Specified by:

getOAuthAppInfo in interface OAuthApi

Parameters:

appId -

Returns:

deleteOAuthApp
```
public ApiResponse<Boolean> deleteOAuthApp(String appId)
```
deletes a registered OAuth 2.0 client application.

Specified by:

deleteOAuthApp in interface OAuthApi

Parameters:

appId -

Returns:

regenerateOAuthAppSecret
```
public ApiResponse<OAuthApp> regenerateOAuthAppSecret(String appId)
```
regenerates the client secret for a registered OAuth 2.0 client application.

Specified by:

regenerateOAuthAppSecret in interface OAuthApi

Parameters:

appId -

Returns:

getAuthorizedOAuthAppsForUser

public ApiResponse<List<OAuthApp>> getAuthorizedOAuthAppsForUser(String userId,
                                                                 Pager pager)

gets a page of OAuth 2.0 client applications the user authorized to use access their account.

Specified by:: getAuthorizedOAuthAppsForUser in interface OAuthApi
Parameters:: userId -; pager -
Returns:

authorizeOAuthApp
```
public String authorizeOAuthApp(AuthorizeRequest authRequest)
```
will authorize an OAuth 2.0 client application to access a user's account and provide a redirect link to follow.

Specified by:

authorizeOAuthApp in interface OAuthApi

Parameters:

authRequest -

Returns:

deauthorizeOAuthApp
```
public ApiResponse<Boolean> deauthorizeOAuthApp(String appId)
```
will deauthorize an OAuth 2.0 client application from accessing a user's account.

Specified by:

deauthorizeOAuthApp in interface OAuthApi

Parameters:

appId -

Returns:

createCommand
```
public ApiResponse<Command> createCommand(Command cmd)
```
will create a new command if the user have the right permissions.

Specified by:

createCommand in interface CommandsApi

Parameters:

cmd -

Returns:

updateCommand
```
public ApiResponse<Command> updateCommand(Command cmd)
```
updates a command based on the provided Command object.

Specified by:

updateCommand in interface CommandsApi

Parameters:

cmd -

Returns:

deleteCommand
```
public ApiResponse<Boolean> deleteCommand(String commandId)
```
deletes a command based on the provided command id string.

Specified by:

deleteCommand in interface CommandsApi

Parameters:

commandId -

Returns:

listCommands
```
public ApiResponse<CommandList> listCommands(String teamId,
                                             boolean customOnly)
```
will retrieve a list of commands available in the team.

Specified by:

listCommands in interface CommandsApi

Parameters:

teamId -

customOnly -

Returns:

executeCommand

public ApiResponse<CommandResponse> executeCommand(String channelId,
                                                   String command)

executes a given command.

Specified by:: executeCommand in interface CommandsApi
Parameters:: channelId -; command -
Returns:

listAutocompleteCommands
```
public ApiResponse<CommandList> listAutocompleteCommands(String teamId)
```
will retrieve a list of commands available in the team.

Specified by:

listAutocompleteCommands in interface CommandsApi

Parameters:

teamId -

Returns:

regenCommandToken
```
public ApiResponse<String> regenCommandToken(String commandId)
```
will create a new token if the user have the right permissions.

Specified by:

regenCommandToken in interface CommandsApi

Parameters:

commandId -

Returns:

getUserStatus

public ApiResponse<Status> getUserStatus(String userId,
                                         String etag)

returns a user status based on the provided user id string.

Specified by:: getUserStatus in interface StatusApi
Parameters:: userId -; etag -
Returns:

getUsersStatusesByIds
```
public ApiResponse<List<Status>> getUsersStatusesByIds(String... userIds)
```
returns a list of users status based on the provided user ids.

Specified by:

getUsersStatusesByIds in interface StatusApi

Parameters:

userIds -

Returns:

updateUserStatus

public ApiResponse<Status> updateUserStatus(String userId,
                                            Status userStatus)

sets a user's status based on the provided user id string.

Specified by:: updateUserStatus in interface StatusApi
Parameters:: userId -; userStatus -
Returns:

getWebrtcToken
```
public ApiResponse<WebrtcInfoResponse> getWebrtcToken()
```
returns a valid token, stun server and turn server with credentials to use with the Mattermost WebRTC service.

Specified by:

getWebrtcToken in interface WebrtcApi

Returns:

createEmoji
```
public ApiResponse<Emoji> createEmoji(Emoji emoji,
                                      Path imageFile)
```
will save an emoji to the server if the current user has permission to do so. If successful, the provided emoji will be returned with its Id field filled in. Otherwise, an error will be returned.

Specified by:

createEmoji in interface EmojiApi

Parameters:

emoji -

imageFile -

Returns:

getEmojiList
```
public ApiResponse<EmojiList> getEmojiList(Pager pager)
```
returns a list of custom emoji in the syste,/

Specified by:

getEmojiList in interface EmojiApi

Parameters:

pager - add in Mattermost Server 4.1, in older version, ignore.

Returns:

deleteEmoji
```
public ApiResponse<Boolean> deleteEmoji(String emojiId)
```
delete an custom emoji on the provided emoji id string.

Specified by:

deleteEmoji in interface EmojiApi

Parameters:

emojiId -

Returns:

getEmoji
```
public ApiResponse<Emoji> getEmoji(String emojiId)
```
returns a custom emoji in the system on the provided emoji id string.

Specified by:

getEmoji in interface EmojiApi

Parameters:

emojiId -

Returns:

getEmojiImage
```
public ApiResponse<Object> getEmojiImage(String emojiId)
```
returns the emoji image.

Specified by:

getEmojiImage in interface EmojiApi

Parameters:

emojiId -

Returns:

saveReaction
```
public ApiResponse<Reaction> saveReaction(Reaction reaction)
```
saves an emoji reaction for a post. Returns the saved reaction if successful, otherwise an error will be returned.

Specified by:

saveReaction in interface ReactionApi

Parameters:

reaction -

Returns:

getReactions
```
public ApiResponse<List<Reaction>> getReactions(String postId)
```
returns a list of reactions to a post.

Specified by:

getReactions in interface ReactionApi

Parameters:

postId -

Returns:

deleteReaction
```
public ApiResponse<Boolean> deleteReaction(Reaction reaction)
```
deletes reaction of a user in a post.

Specified by:

deleteReaction in interface ReactionApi

Parameters:

reaction -

Returns:

Class MattermostClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.bis5.mattermost.client4.api.AuditsApi

Methods inherited from interface net.bis5.mattermost.client4.api.ChannelApi

Methods inherited from interface net.bis5.mattermost.client4.api.CommandsApi

Methods inherited from interface net.bis5.mattermost.client4.api.ComplianceApi

Methods inherited from interface net.bis5.mattermost.client4.api.EmojiApi

Methods inherited from interface net.bis5.mattermost.client4.api.GeneralApi

Methods inherited from interface net.bis5.mattermost.client4.api.LogsApi

Methods inherited from interface net.bis5.mattermost.client4.api.OAuthApi

Methods inherited from interface net.bis5.mattermost.client4.api.PostApi

Methods inherited from interface net.bis5.mattermost.client4.api.StatusApi

Methods inherited from interface net.bis5.mattermost.client4.api.TeamApi

Methods inherited from interface net.bis5.mattermost.client4.api.UserApi

Methods inherited from interface net.bis5.mattermost.client4.api.WebhookApi

Field Detail

API_URL_SUFFIX

HEADER_ETAG_CLIENT

HEADER_AUTH

Constructor Detail

MattermostClient

MattermostClient

Method Detail

buildClient

close

setOAuthToken

clearOAuthToken

setAccessToken

getUsersRoute

getUserRoute

getUserByUsernameRoute

getUserByEmailRoute

getTeamsRoute

getTeamRoute

getTeamAutoCompleteCommandsRoute

getTeamByNameRoute

getTeamMemberRoute

getTeamMembersRoute

getTeamStatsRoute

getTeamImportRoute

getChannelsRoute

getChannelsForTeamRoute

getChannelRoute

getChannelByNameRoute

getChannelByNameForTeamNameRoute

getChannelMembersRoute

getChannelMemberRoute

getPostsRoute

getConfigRoute

getLicenseRoute

getPostRoute

getFilesRoute

getFileRoute

getSystemRoute

getTestEmailRoute

getDatabaseRoute

getCacheRoute

getClusterRoute

getIncomingWebhooksRoute

getIncomingWebhookRoute

getComplianceReportsRoute

getComplianceReportRoute

getOutgoingWebhooksRoute

getOutgoingWebhookRoute

getPreferencesRoute

getUserStatusRoute

getUserStatusesRoute

getSamlRoute

getLdapRoute

getBrandRoute

getCommandsRoute

getCommandRoute

getEmojisRoute

getEmojiRoute

getReactionsRoute

getOAuthAppsRoute

getOAuthAppRoute