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

All Implemented Interfaces:

AutoCloseable, AuditsApi, AuthenticationApi, BotsApi, BrandApi, ChannelApi, ClusterApi, CommandsApi, ComplianceApi, ElasticsearchApi, EmojiApi, FilesApi, LdapApi, LogsApi, OAuthApi, OpenGraphApi, PluginApi, PostApi, PreferencesApi, ReactionApi, SamlApi, StatusApi, SystemApi, TeamApi, UserApi, WebhookApi
```
public class MattermostClient
extends Object
implements AutoCloseable, AuditsApi, AuthenticationApi, BotsApi, BrandApi, ChannelApi, ClusterApi, CommandsApi, ComplianceApi, ElasticsearchApi, EmojiApi, FilesApi, SystemApi, LdapApi, LogsApi, OAuthApi, OpenGraphApi, PluginApi, PostApi, PreferencesApi, ReactionApi, SamlApi, StatusApi, TeamApi, UserApi, WebhookApi
```
Mattermost API Version4 Client default implementation.

Since:

2017/06/10

Author:

Maruyama Takayuki

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MattermostClient.MattermostClientBuilder

Field Summary

Fields
Modifier and Type Field Description

protected static String API_URL_SUFFIX

protected static String HEADER_AUTH

protected static String HEADER_ETAG_CLIENT

Constructor Summary

Constructors
Constructor Description

MattermostClient(String url)

MattermostClient(String url, Level logLevel)
Create new MattermosClient instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	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)`	Deprecated.
`ApiResponse<TeamMember>`	`addTeamMember(String teamId, String userId, String hash, String dataToHash, String inviteId)`	Deprecated.
`ApiResponse<TeamMember>`	`addTeamMember(TeamMember teamMemberToAdd)`	add user to a team and return a team member.
`ApiResponse<TeamMember>`	`addTeamMemberFromInvite(String token, String inviteId)`	add user to team from invite.
`ApiResponse<TeamMemberList>`	`addTeamMembers(String teamId, String... userIds)`	adds a number of users to a team and returns the team members.
`ApiResponse<Bot>`	`assignBotToUser(String botUserId, String ownerUserId)`	Assign a bot to a user.
`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<ChannelList>`	`autocompleteChannels(String teamId, String searchTerm)`	autocomplete channels in team based on search term.
`ApiResponse<ChannelList>`	`autocompleteChannelsForSearch(String teamId, String searchTerm)`	autocomplete your (joined) channels in team based on search term.
`ApiResponse<EmojiList>`	`autocompleteEmoji(String name)`	get a list of custom emoji that name starts with or matching provided name.
`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 jakarta.ws.rs.client.Client`	`buildClient(Consumer<jakarta.ws.rs.client.ClientBuilder> httpClientConfig)`
`static MattermostClient.MattermostClientBuilder`	`builder()`
`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>`	`convertChannelToPrivate(String channelId)`	convert channel from public to private.
`ApiResponse<Bot>`	`createBot(BotPatch bot)`	Create a bot.
`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<Post>`	`createEphemeralPost(String sendToUserId, Post post)`	creates an ephemeral post send to `targetUserId`.
`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<UserAccessToken>`	`createUserAccessToken(String userId, String description)`
`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>`	`deleteBrandImage()`	delete the brand image for the system.
`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>`	`deleteProfileImage(String userId)`	delete user profile image.
`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.
`ApiResponse<Bot>`	`disableBot(String botUserId)`	Disable a bot.
`ApiResponse<Boolean>`	`disablePlugin(String pluginId)`
`ApiResponse<Boolean>`	`disableUserAccessToken(String tokenId)`
`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, jakarta.ws.rs.core.GenericType<T> responseType)`
`protected <T> ApiResponse<T>`	`doApiGet(String url, String etag, Class<T> responseType)`
`protected ApiResponse<Path>`	`doApiGetFile(String url, String etag)`
`protected <U> ApiResponse<Void>`	`doApiPost(String url, U data)`
`protected <T,U> ApiResponse<T>`	`doApiPost(String url, U data, jakarta.ws.rs.core.GenericType<T> responseType)`
`protected <T,U> ApiResponse<T>`	`doApiPost(String url, U data, Class<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, jakarta.ws.rs.core.GenericType<T> responseType)`
`protected <T,U> ApiResponse<T>`	`doApiRequest(String method, String url, U data, String etag, Class<T> responseType)`
`ApiResponse<Object>`	`downloadComplianceReport(String reportId)`	returns a full compliance report as a file.
`ApiResponse<Bot>`	`enableBot(String botUserId)`	Enable a bot.
`ApiResponse<Boolean>`	`enablePlugin(String pluginId)`
`ApiResponse<Boolean>`	`enableUserAccessToken(String tokenId)`
`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<AnalyticsRows>`	`getAnalytics(AnalyticsCategory category, String teamId)`
`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<Bot>`	`getBot(String botUserId, boolean includeDeleted)`	Get a bot.
`ApiResponse<Bots>`	`getBots(Pager pager, GetBotsOption option)`	Get bots.
`String`	`getBotsRoute()`
`String`	`getBotsRoute(String botUserId)`
`ApiResponse<Path>`	`getBrandImage()`	retrieves the previously uploaded brand image.
`String`	`getBrandImageRoute()`
`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<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<ChannelList>`	`getDeletedChannels(String teamId, Pager pager)`
`String`	`getElasticsearchRoute()`
`ApiResponse<Emoji>`	`getEmoji(String emojiId)`	returns a custom emoji in the system on the provided emoji id string.
`ApiResponse<Emoji>`	`getEmojiByName(String emojiName)`	get a custom emoji by name.
`String`	`getEmojiByNameRoute(String emojiName)`
`ApiResponse<Path>`	`getEmojiImage(String emojiId)`	returns the emoji image.
`ApiResponse<EmojiList>`	`getEmojiList(Pager pager)`	returns a list of custom emoji in the system.
`ApiResponse<EmojiList>`	`getEmojiListSorted(Pager pager)`	returns a list of custom emoji in the system sorted by name.
`String`	`getEmojiRoute(String emojiId)`
`String`	`getEmojisRoute()`
`ApiResponse<Path>`	`getFile(String fileId)`	Get a file content.
`ApiResponse<FileInfo[]>`	`getFileInfoForPost(String postId)`	get a list of file info attached the post.
`ApiResponse<FileInfo>`	`getFileMetadata(String fileId)`	Get a file metadata.
`ApiResponse<Path>`	`getFilePreview(String fileId)`	Get a file preview.
`String`	`getFileRoute(String fileId)`
`String`	`getFilesRoute()`
`ApiResponse<Path>`	`getFileThumbnail(String fileId)`	Get a file thumbnail.
`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()`
`ApiResponse<TeamInviteInfo>`	`getInviteInfo(String inviteId)`	get team info by invite id.
`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<net.bis5.opengraph.models.OpenGraph>`	`getOpenGraphMetadata(String url)`	Retrieve the OpenGraph metadata for provided url.
`String`	`getOpenGraphRoute()`
`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.
`String`	`getPluginRoute(String pluginId)`
`ApiResponse<Plugins>`	`getPlugins()`
`String`	`getPluginsRoute()`
`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<String>`	`getPublicFileLink(String fileId)`	Get a public link can be access without logging in to Mattermost.
`ApiResponse<ReactionList>`	`getReactions(String postId)`	returns a list of reactions to a post.
`String`	`getReactionsRoute()`
`ApiResponse<SamlCertificateStatus>`	`getSamlCertificateStatus()`	returns metadata for the SAML configuration.
`ApiResponse<Path>`	`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 id 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)`
`ApiResponse<Path>`	`getTeamIcon(String teamId)`	Get the team icon image.
`String`	`getTeamIconRoute(String teamId)`
`String`	`getTeamImportRoute(String teamId)`
`String`	`getTeamInviteRoute(String inviteId)`
`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<UserAccessToken>`	`getUserAccessToken(String tokenId)`
`ApiResponse<UserAccessTokenList>`	`getUserAccessTokens(String userId, Pager pager)`
`ApiResponse<UserAccessTokenList>`	`getUserAccessTokensAllUsers(Pager pager)`
`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`	`getUserProfileImageRoute(String userId)`
`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.
`String`	`getUserSessionsRoute(String userId)`
`ApiResponse<UserList>`	`getUsersInChannel(String channelId, UsersOrder.InChannel order, Pager pager, String etag)`	returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersInTeam(String teamId, UsersOrder.InTeam order, 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<StatusList>`	`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.
`String`	`getUserTokenRoute(String tokenId)`
`String`	`getUserTokensRoute()`
`String`	`getUserTokensRoute(String userId)`
`ApiResponse<PluginManifest[]>`	`getWebappPlugins()`
`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.
`ApiResponse<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.
`protected ApiResponse<User>`	`login(LoginRequest param)`
`ApiResponse<User>`	`loginById(String id, String password)`	authenticates a user by user id and password.
`ApiResponse<User>`	`loginByLdap(String loginId, String password)`	authenticates a user by LDAP id and password.
`ApiResponse<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<Bot>`	`patchBot(String botUserId, BotPatch patch)`	Patch a bot.
`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<Boolean>`	`purgeElasticsearchIndexes()`	deletes all Elasticsearch indexes.
`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>`	`removeLicense()`
`ApiResponse<Boolean>`	`removePlugin(String pluginId)`
`ApiResponse<Boolean>`	`removeTeamIcon(String teamId)`	Remove the team icon.
`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<Channel>`	`restoreChannel(String channelId)`
`ApiResponse<Boolean>`	`revokeAllActiveSessionForUser(String userId)`
`ApiResponse<Boolean>`	`revokeSession(String userId, String sessionId)`	revokes a user session based on the provided user id and session id strings.
`ApiResponse<Boolean>`	`revokeUserAccessToken(String tokenId)`
`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<EmojiList>`	`searchEmoji(SearchEmojiRequest searchRequest)`	search custom emoji based on request.
`ApiResponse<PostSearchResults>`	`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<UserAccessTokenList>`	`searchTokens(String 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)`	Set Personal Access Token that use to access Mattermost API to this client.
`void`	`setOAuthToken(String token)`
`ApiResponse<Boolean>`	`setProfileImage(String userId, Path imageFilePath)`	sets profile image of the user.
`ApiResponse<Boolean>`	`setTeamIcon(String teamId, Path iconFilePath)`	Set the team icon.
`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>`	`testElasticsearchConfiguration()`	test Elasticsearch configuration.
`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(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.
`ApiResponse<Boolean>`	`uploadBrandImage(Path dataFile)`	sets the brand image for the system.
`ApiResponse<FileUploadResult>`	`uploadFile(String channelId, Path... filePaths)`	Upload a file to specified channel.
`ApiResponse<Boolean>`	`uploadLicenseFile(Path licenseFile)`
`ApiResponse<PluginManifest>`	`uploadPlugin(Path plugin, boolean force)`
`ApiResponse<Boolean>`	`uploadSamlIdpCertificate(Path dataFile, String fileName)`	will upload an IDP certificate for SAML and set the config to use it.
`ApiResponse<Boolean>`	`uploadSamlPrivateCertificate(Path dataFile, String fileName)`	will upload a private key for SAML and set the config to use it.
`ApiResponse<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.BotsApi
getBot, getBots, getBots

Methods inherited from interface net.bis5.mattermost.client4.api.ChannelApi
createGroupChannel, getChannel, getChannelByName, getChannelByNameForTeamName, getChannelMember, getChannelMembers, getChannelMembers, getChannelMembersByIds, getChannelMembersForUser, getChannelsForTeamForUser, getChannelStats, getDeletedChannels, 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, getEmojiListSorted

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.PluginApi
uploadPlugin

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.SystemApi
getAnalytics, getAnalytics, getAnalytics, getOldClientConfig, getOldClientLicense

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.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)

Create new MattermosClient instance.

Method Detail

builder

public static MattermostClient.MattermostClientBuilder builder()

buildClient

protected jakarta.ws.rs.client.Client buildClient(Consumer<jakarta.ws.rs.client.ClientBuilder> httpClientConfig)

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

close in interface AutoCloseable

setOAuthToken

public void setOAuthToken(String token)

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

setAccessToken
```
public void setAccessToken(String token)
```
Set Personal Access Token that use to access Mattermost API to this client.

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)

getUserSessionsRoute

public String getUserSessionsRoute(String userId)

getUserTokensRoute

public String getUserTokensRoute(String userId)

getUserTokensRoute
```
public String getUserTokensRoute()
```

getUserTokenRoute

public String getUserTokenRoute(String tokenId)

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)

getTeamIconRoute

public String getTeamIconRoute(String teamId)

getTeamImportRoute

public String getTeamImportRoute(String teamId)

getTeamInviteRoute

public String getTeamInviteRoute(String inviteId)

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()
```

getUserProfileImageRoute

public String getUserProfileImageRoute(String userId)

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

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

getBrandImageRoute
```
public String getBrandImageRoute()
```

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

getCommandRoute

public String getCommandRoute(String commandId)

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

getEmojiRoute

public String getEmojiRoute(String emojiId)

getEmojiByNameRoute

public String getEmojiByNameRoute(String emojiName)

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

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

getOAuthAppRoute

public String getOAuthAppRoute(String appId)

getElasticsearchRoute
```
public String getElasticsearchRoute()
```

getPluginsRoute
```
public String getPluginsRoute()
```

getPluginRoute

public String getPluginRoute(String pluginId)

getOpenGraphRoute
```
public String getOpenGraphRoute()
```

getBotsRoute
```
public String getBotsRoute()
```

getBotsRoute

public String getBotsRoute(String botUserId)

doApiGet

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

doApiGet

protected <T> ApiResponse<T> doApiGet(String url,
                                      String etag,
                                      jakarta.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,
                                               jakarta.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,
                                                  jakarta.ws.rs.core.GenericType<T> responseType)

doApiRequest

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

doApiGetFile

protected ApiResponse<Path> doApiGetFile(String url,
                                         String etag)
                                  throws IOException

Throws:: IOException

loginById
```
public ApiResponse<User> loginById(String id,
                                   String password)
```
Description copied from interface: AuthenticationApi

authenticates a user by user id and password.

Specified by:

loginById in interface AuthenticationApi

onLogin

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

login

protected ApiResponse<User> login(LoginRequest param)

login
```
public ApiResponse<User> login(String loginId,
                               String password)
```
Description copied from interface: AuthenticationApi

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

loginByLdap
```
public ApiResponse<User> loginByLdap(String loginId,
                                     String password)
```
Description copied from interface: AuthenticationApi

authenticates a user by LDAP id and password.

Specified by:

loginByLdap in interface AuthenticationApi

loginWithDevice
```
public ApiResponse<User> loginWithDevice(String loginId,
                                         String password,
                                         String deviceId)
```
Description copied from interface: AuthenticationApi

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

logout
```
public ApiResponse<Boolean> logout()
```
Description copied from interface: AuthenticationApi

terminates the current user's session.

Specified by:

logout in interface AuthenticationApi

onLogout

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

switchAccountType
```
public ApiResponse<SwitchAccountTypeResult> switchAccountType(SwitchRequest switchRequest)
```
Description copied from interface: AuthenticationApi

changes a user's login type from one type to another.

Specified by:

switchAccountType in interface AuthenticationApi

createUser
```
public ApiResponse<User> createUser(User user)
```
Description copied from interface: UserApi

creates a user in the system based on the provided user object.

Specified by:

createUser in interface UserApi

getMe
```
public ApiResponse<User> getMe(String etag)
```
Description copied from interface: UserApi

returns the logged in user.

Specified by:

getMe in interface UserApi

getUser

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

Description copied from interface: UserApi

returns a user based on the provided user id string.

Specified by:: getUser in interface UserApi

getUserByUsername

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

Description copied from interface: UserApi

returns a user based pn the provided user name string.

Specified by:: getUserByUsername in interface UserApi

getUserByEmail

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

Description copied from interface: UserApi

returns a user based on the provided user email string.

Specified by:: getUserByEmail in interface UserApi

autocompleteUsersInTeam

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

Description copied from interface: UserApi

returns the users on a team based on search term.

Specified by:: autocompleteUsersInTeam in interface UserApi

autocompleteUsersInChannel

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

Description copied from interface: UserApi

returns the users in a channel based on search term.

Specified by:: autocompleteUsersInChannel in interface UserApi

autocompleteUsers

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

Description copied from interface: UserApi

returns the users in the system based on search term.

Specified by:: autocompleteUsers in interface UserApi

getProfileImage
```
public ApiResponse<byte[]> getProfileImage(String userId,
                                           String etag)
```
Description copied from interface: UserApi

gets user's profile image. Must be logged in or be a system administrator.

Specified by:

getProfileImage in interface UserApi

getUsers
```
public ApiResponse<UserList> getUsers(Pager pager,
                                      String etag)
```
Description copied from interface: UserApi

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

Specified by:

getUsers in interface UserApi

getUsersInTeam

public ApiResponse<UserList> getUsersInTeam(String teamId,
                                            UsersOrder.InTeam order,
                                            Pager pager,
                                            String etag)

Description copied from interface: UserApi

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

Specified by:: getUsersInTeam in interface UserApi

getUsersNotInTeam

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

Description copied from interface: UserApi

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

Specified by:: getUsersNotInTeam in interface UserApi

getUsersInChannel

public ApiResponse<UserList> getUsersInChannel(String channelId,
                                               UsersOrder.InChannel order,
                                               Pager pager,
                                               String etag)

Description copied from interface: UserApi

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

Specified by:: getUsersInChannel in interface UserApi

getUsersNotInChannel

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

Description copied from interface: UserApi

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

Specified by:: getUsersNotInChannel in interface UserApi

getUsersWithoutTeam
```
public ApiResponse<UserList> getUsersWithoutTeam(Pager pager,
                                                 String etag)
```
Description copied from interface: UserApi

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

getUsersByIds
```
public ApiResponse<UserList> getUsersByIds(String... userIds)
```
Description copied from interface: UserApi

returns a list of users based on the provided user ids.

Specified by:

getUsersByIds in interface UserApi

getUsersByUsernames
```
public ApiResponse<UserList> getUsersByUsernames(String... usernames)
```
Description copied from interface: UserApi

returns a list of users based on the provided usernames.

Specified by:

getUsersByUsernames in interface UserApi

searchUsers
```
public ApiResponse<UserList> searchUsers(UserSearch search)
```
Description copied from interface: UserApi

returns a list of users based on some search criteria.

Specified by:

searchUsers in interface UserApi

updateUser
```
public ApiResponse<User> updateUser(User user)
```
Description copied from interface: UserApi

updates a user in the system based on the provided user object.

Specified by:

updateUser in interface UserApi

patchUser
```
public ApiResponse<User> patchUser(String userId,
                                   UserPatch patch)
```
Description copied from interface: UserApi

partially updates a user in the system. Any missing fields are not updated.

Specified by:

patchUser in interface UserApi

updateUserMfa
```
public ApiResponse<Boolean> updateUserMfa(String userId,
                                          String code,
                                          boolean activate)
```
Description copied from interface: UserApi

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

checkUserMfa
```
public boolean checkUserMfa(String loginId)
```
Description copied from interface: UserApi

checks whether a user has MFA active on their account or not based on the provided login id.

Specified by:

checkUserMfa in interface UserApi

generateMfaSecret
```
public ApiResponse<MfaSecret> generateMfaSecret(String userId)
```
Description copied from interface: UserApi

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

updateUserPassword

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

Description copied from interface: UserApi

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

Specified by:: updateUserPassword in interface UserApi

updateUserRoles
```
public ApiResponse<Boolean> updateUserRoles(String userId,
                                            Role... roles)
```
Description copied from interface: UserApi

updates a user's roles in the system. A user can have "system_user" and "system_admin" roles.

Specified by:

updateUserRoles in interface UserApi

updateUserActive
```
public ApiResponse<Boolean> updateUserActive(String userId,
                                             boolean active)
```
Description copied from interface: UserApi

updates status of a user whether active or not.

Specified by:

updateUserActive in interface UserApi

deleteUser
```
public ApiResponse<Boolean> deleteUser(String userId)
```
Description copied from interface: UserApi

deactivates a user in the system based on the provided user id string.

Specified by:

deleteUser in interface UserApi

sendPasswordResetEmail
```
public ApiResponse<Boolean> sendPasswordResetEmail(String email)
```
Description copied from interface: UserApi

will send a link for password resetting to a user with the provided email.

Specified by:

sendPasswordResetEmail in interface UserApi

resetPassword

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

Description copied from interface: UserApi

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

Specified by:: resetPassword in interface UserApi

getSessions

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

Description copied from interface: UserApi

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

Specified by:: getSessions in interface UserApi

revokeSession
```
public ApiResponse<Boolean> revokeSession(String userId,
                                          String sessionId)
```
Description copied from interface: UserApi

revokes a user session based on the provided user id and session id strings.

Specified by:

revokeSession in interface UserApi

attachDeviceId
```
public ApiResponse<Boolean> attachDeviceId(String deviceId)
```
Description copied from interface: UserApi

attaches a mobile device ID to the current session.

Specified by:

attachDeviceId in interface UserApi

getTeamUnreadForUser
```
public ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId,
                                                        String teamIdToExclude)
```
Description copied from interface: UserApi

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

getUserAudits

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

Description copied from interface: UserApi

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

Specified by:: getUserAudits in interface UserApi

verifyUserEmail
```
public ApiResponse<Boolean> verifyUserEmail(String token)
```
Description copied from interface: UserApi

will verify a user's email using the supplied token.

Specified by:

verifyUserEmail in interface UserApi

sendVerificationEmail
```
public ApiResponse<Boolean> sendVerificationEmail(String email)
```
Description copied from interface: UserApi

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

setProfileImage

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

Description copied from interface: UserApi

sets profile image of the user.

Specified by:: setProfileImage in interface UserApi

createUserAccessToken

public ApiResponse<UserAccessToken> createUserAccessToken(String userId,
                                                          String description)

Specified by:: createUserAccessToken in interface UserApi

getUserAccessTokens

public ApiResponse<UserAccessTokenList> getUserAccessTokens(String userId,
                                                            Pager pager)

Specified by:: getUserAccessTokens in interface UserApi

getUserAccessTokensAllUsers

public ApiResponse<UserAccessTokenList> getUserAccessTokensAllUsers(Pager pager)

Specified by:: getUserAccessTokensAllUsers in interface UserApi

revokeUserAccessToken

public ApiResponse<Boolean> revokeUserAccessToken(String tokenId)

Specified by:: revokeUserAccessToken in interface UserApi

getUserAccessToken

public ApiResponse<UserAccessToken> getUserAccessToken(String tokenId)

Specified by:: getUserAccessToken in interface UserApi

disableUserAccessToken

public ApiResponse<Boolean> disableUserAccessToken(String tokenId)

Specified by:: disableUserAccessToken in interface UserApi

enableUserAccessToken

public ApiResponse<Boolean> enableUserAccessToken(String tokenId)

Specified by:: enableUserAccessToken in interface UserApi

searchTokens

public ApiResponse<UserAccessTokenList> searchTokens(String term)

Specified by:: searchTokens in interface UserApi

revokeAllActiveSessionForUser
```
public ApiResponse<Boolean> revokeAllActiveSessionForUser(String userId)
```
Specified by:

revokeAllActiveSessionForUser in interface UserApi

deleteProfileImage
```
public ApiResponse<Boolean> deleteProfileImage(String userId)
```
Description copied from interface: UserApi

delete user profile image.

Specified by:

deleteProfileImage in interface UserApi

createTeam
```
public ApiResponse<Team> createTeam(Team team)
```
Description copied from interface: TeamApi

creates a team in the system based on the provided team object.

Specified by:

createTeam in interface TeamApi

getTeam

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

Description copied from interface: TeamApi

returns a team based on the provided team id string.

Specified by:: getTeam in interface TeamApi

getAllTeams

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

Description copied from interface: TeamApi

returns all teams based on permssions.

Specified by:: getAllTeams in interface TeamApi

getTeamByName

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

Description copied from interface: TeamApi

returns a team based on the provided team name string.

Specified by:: getTeamByName in interface TeamApi

searchTeams
```
public ApiResponse<TeamList> searchTeams(TeamSearch search)
```
Description copied from interface: TeamApi

returns teams matching the provided search term.

Specified by:

searchTeams in interface TeamApi

teamExists

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

Description copied from interface: TeamApi

returns true or false if the team exist or not.

Specified by:: teamExists in interface TeamApi

getTeamsForUser
```
public ApiResponse<TeamList> getTeamsForUser(String userId,
                                             String etag)
```
Description copied from interface: TeamApi

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

getTeamMember

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

Description copied from interface: TeamApi

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

Specified by:: getTeamMember in interface TeamApi

updateTeamMemberRoles

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

Description copied from interface: TeamApi

will update the roles on a team for a user.

Specified by:: updateTeamMemberRoles in interface TeamApi

updateTeam
```
public ApiResponse<Team> updateTeam(Team team)
```
Description copied from interface: TeamApi

will update a team.

Specified by:

updateTeam in interface TeamApi

patchTeam
```
public ApiResponse<Team> patchTeam(String teamId,
                                   TeamPatch patch)
```
Description copied from interface: TeamApi

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

Specified by:

patchTeam in interface TeamApi

deleteTeam
```
public ApiResponse<Boolean> deleteTeam(String teamId)
```
Description copied from interface: TeamApi

deletes the team softly (archive only, not permanent delete).

Specified by:

deleteTeam in interface TeamApi

See Also:

TeamApi.deleteTeam(String, boolean)

deleteTeam
```
public ApiResponse<Boolean> deleteTeam(String teamId,
                                       boolean permanent)
```
Description copied from interface: TeamApi

deletes the team.

Specified by:

deleteTeam in interface TeamApi

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

See Also:

TeamApi.deleteTeam(String)

getTeamMembers

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

Description copied from interface: TeamApi

returns team members based on the provided team id string.

Specified by:: getTeamMembers in interface TeamApi

getTeamMembersForUser

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

Description copied from interface: TeamApi

returns the team member for a user.

Specified by:: getTeamMembersForUser in interface TeamApi

getTeamMembersByIds
```
public ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId,
                                                       String... userIds)
```
Description copied from interface: TeamApi

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

addTeamMember
```
public ApiResponse<TeamMember> addTeamMember(TeamMember teamMemberToAdd)
```
Description copied from interface: TeamApi

add user to a team and return a team member.

Specified by:

addTeamMember in interface TeamApi

addTeamMember

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

Deprecated.

Description copied from interface: TeamApi

Should not use this API because server api changed.

Specified by:: addTeamMember in interface TeamApi

addTeamMember

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

Deprecated.

Description copied from interface: TeamApi

adds user to a team and return a team member.

Specified by:: addTeamMember in interface TeamApi

addTeamMemberFromInvite

public ApiResponse<TeamMember> addTeamMemberFromInvite(String token,
                                                       String inviteId)

Description copied from interface: TeamApi

add user to team from invite.

Specified by:: addTeamMemberFromInvite in interface TeamApi

addTeamMembers

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

Description copied from interface: TeamApi

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

Specified by:: addTeamMembers in interface TeamApi

removeTeamMember

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

Description copied from interface: TeamApi

will remove a user from a team.

Specified by:: removeTeamMember in interface TeamApi

getTeamStats

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

Description copied from interface: TeamApi

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

Specified by:: getTeamStats in interface TeamApi

getTeamIcon
```
public ApiResponse<Path> getTeamIcon(String teamId)
                              throws IOException
```
Description copied from interface: TeamApi

Get the team icon image.

Specified by:

getTeamIcon in interface TeamApi

Throws:

IOException

setTeamIcon

public ApiResponse<Boolean> setTeamIcon(String teamId,
                                        Path iconFilePath)

Description copied from interface: TeamApi

Set the team icon.

Specified by:: setTeamIcon in interface TeamApi

removeTeamIcon
```
public ApiResponse<Boolean> removeTeamIcon(String teamId)
```
Description copied from interface: TeamApi

Remove the team icon.

Specified by:

removeTeamIcon in interface TeamApi

getTeamUnread
```
public ApiResponse<TeamUnread> getTeamUnread(String teamId,
                                             String userId)
```
Description copied from interface: TeamApi

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

importTeam

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

Description copied from interface: TeamApi

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

Specified by:: importTeam in interface TeamApi

inviteUsersToTeam

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

Description copied from interface: TeamApi

invite users by email to the team.

Specified by:: inviteUsersToTeam in interface TeamApi

getInviteInfo
```
public ApiResponse<TeamInviteInfo> getInviteInfo(String inviteId)
```
Description copied from interface: TeamApi

get team info by invite id.

Specified by:

getInviteInfo in interface TeamApi

createChannel
```
public ApiResponse<Channel> createChannel(Channel channel)
```
Description copied from interface: ChannelApi

creates a channel based on the provided channel object.

Specified by:

createChannel in interface ChannelApi

updateChannel
```
public ApiResponse<Channel> updateChannel(Channel channel)
```
Description copied from interface: ChannelApi

update a channel based on the provided channel object.

Specified by:

updateChannel in interface ChannelApi

patchChannel

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

Description copied from interface: ChannelApi

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

Specified by:: patchChannel in interface ChannelApi

createDirectChannel

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

Description copied from interface: ChannelApi

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

Specified by:: createDirectChannel in interface ChannelApi

createGroupChannel
```
public ApiResponse<Channel> createGroupChannel(String... userIds)
```
Description copied from interface: ChannelApi

creates a group message channel based on userIds provided.

Specified by:

createGroupChannel in interface ChannelApi

getChannel

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

Description copied from interface: ChannelApi

returns a channel based on the provided channel id string.

Specified by:: getChannel in interface ChannelApi

getChannelStats

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

Description copied from interface: ChannelApi

returns statistics for a channel.

Specified by:: getChannelStats in interface ChannelApi

getPinnedPosts

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

Description copied from interface: ChannelApi

gets a list of pinned posts.

Specified by:: getPinnedPosts in interface ChannelApi

getPublicChannelsForTeam

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

Description copied from interface: ChannelApi

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

Specified by:: getPublicChannelsForTeam in interface ChannelApi

getPublicChannelsByIdsForTeam

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

Description copied from interface: ChannelApi

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

Specified by:: getPublicChannelsByIdsForTeam in interface ChannelApi

getChannelsForTeamForUser

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

Description copied from interface: ChannelApi

returns a list channels of on a team for user.

Specified by:: getChannelsForTeamForUser in interface ChannelApi

searchChannels

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

Description copied from interface: ChannelApi

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

Specified by:: searchChannels in interface ChannelApi

deleteChannel
```
public ApiResponse<Boolean> deleteChannel(String channelId)
```
Description copied from interface: ChannelApi

deletes channel based on the provided channel id string.

Specified by:

deleteChannel in interface ChannelApi

getChannelByName

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

Description copied from interface: ChannelApi

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

Specified by:: getChannelByName in interface ChannelApi

getChannelByNameForTeamName

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

Description copied from interface: ChannelApi

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

Specified by:: getChannelByNameForTeamName in interface ChannelApi

getChannelMembers

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

Description copied from interface: ChannelApi

gets a page of channel members.

Specified by:: getChannelMembers in interface ChannelApi

getChannelMembersByIds

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

Description copied from interface: ChannelApi

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

Specified by:: getChannelMembersByIds in interface ChannelApi

getChannelMember

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

Description copied from interface: ChannelApi

gets a channel memner.

Specified by:: getChannelMember in interface ChannelApi

getChannelMembersForUser

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

Description copied from interface: ChannelApi

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

Specified by:: getChannelMembersForUser in interface ChannelApi

viewChannel
```
public ApiResponse<ChannelViewResponse> viewChannel(String userId,
                                                    ChannelView view)
```
Description copied from interface: ChannelApi

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

getChannelUnread
```
public ApiResponse<ChannelUnread> getChannelUnread(String channelId,
                                                   String userId)
```
Description copied from interface: ChannelApi

will return a ChannelUnread object that contains the number ofo unread messages and mentions for a user.

Specified by:

getChannelUnread in interface ChannelApi

updateChannelRoles

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

Description copied from interface: ChannelApi

will update the roles on a channel for a user.

Specified by:: updateChannelRoles in interface ChannelApi

updateChannelNotifyProps

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

Description copied from interface: ChannelApi

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

Specified by:: updateChannelNotifyProps in interface ChannelApi

addChannelMember

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

Description copied from interface: ChannelApi

adds user to channel and return a channel memner.

Specified by:: addChannelMember in interface ChannelApi

removeUserFromChannel
```
public ApiResponse<Boolean> removeUserFromChannel(String channelId,
                                                  String userId)
```
Description copied from interface: ChannelApi

will delete the channel member object for a user, effectively removing the user from a channel.

Specified by:

removeUserFromChannel in interface ChannelApi

restoreChannel

public ApiResponse<Channel> restoreChannel(String channelId)

Specified by:: restoreChannel in interface ChannelApi

getDeletedChannels

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

Specified by:: getDeletedChannels in interface ChannelApi

convertChannelToPrivate
```
public ApiResponse<Channel> convertChannelToPrivate(String channelId)
```
Description copied from interface: ChannelApi

convert channel from public to private.

Specified by:

convertChannelToPrivate in interface ChannelApi

autocompleteChannels

public ApiResponse<ChannelList> autocompleteChannels(String teamId,
                                                     String searchTerm)

Description copied from interface: ChannelApi

autocomplete channels in team based on search term.

Specified by:: autocompleteChannels in interface ChannelApi

autocompleteChannelsForSearch

public ApiResponse<ChannelList> autocompleteChannelsForSearch(String teamId,
                                                              String searchTerm)

Description copied from interface: ChannelApi

autocomplete your (joined) channels in team based on search term.

Specified by:: autocompleteChannelsForSearch in interface ChannelApi

createPost
```
public ApiResponse<Post> createPost(Post post)
```
Description copied from interface: PostApi

creates a post based on the provided post object.

Specified by:

createPost in interface PostApi

createEphemeralPost

public ApiResponse<Post> createEphemeralPost(String sendToUserId,
                                             Post post)

Description copied from interface: PostApi

creates an ephemeral post send to targetUserId.

Specified by:: createEphemeralPost in interface PostApi

updatePost
```
public ApiResponse<Post> updatePost(Post post)
```
Description copied from interface: PostApi

updates a post based on the provided post object.

Specified by:

updatePost in interface PostApi

patchPost
```
public ApiResponse<Post> patchPost(String postId,
                                   PostPatch patch)
```
Description copied from interface: PostApi

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

Specified by:

patchPost in interface PostApi

pinPost
```
public ApiResponse<Boolean> pinPost(String postId)
```
Description copied from interface: PostApi

pin a post based on proviced post id string.

Specified by:

pinPost in interface PostApi

unpinPost
```
public ApiResponse<Boolean> unpinPost(String postId)
```
Description copied from interface: PostApi

unpin a post based on provided post id string.

Specified by:

unpinPost in interface PostApi

getPost

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

Description copied from interface: PostApi

gets a single post.

Specified by:: getPost in interface PostApi

deletePost
```
public ApiResponse<Boolean> deletePost(String postId)
```
Description copied from interface: PostApi

deletes a post from the provided post id string.

Specified by:

deletePost in interface PostApi

getPostThread

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

Description copied from interface: PostApi

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

Specified by:: getPostThread in interface PostApi

getPostsForChannel

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

Description copied from interface: PostApi

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

Specified by:: getPostsForChannel in interface PostApi

getFlaggedPostsForUser

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

Description copied from interface: PostApi

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

Specified by:: getFlaggedPostsForUser in interface PostApi

getFlaggedPostsForUserInTeam

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

Description copied from interface: PostApi

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

Specified by:: getFlaggedPostsForUserInTeam in interface PostApi

getFlaggedPostsForUserInChannel

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

Description copied from interface: PostApi

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

Specified by:: getFlaggedPostsForUserInChannel in interface PostApi

getPostsSince
```
public ApiResponse<PostList> getPostsSince(String channelId,
                                           long time)
```
Description copied from interface: PostApi

gets posts created after a specified time as Unix time in milliseconds.

Specified by:

getPostsSince in interface PostApi

getPostsAfter

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

Description copied from interface: PostApi

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

Specified by:: getPostsAfter in interface PostApi

getPostsBefore

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

Description copied from interface: PostApi

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

Specified by:: getPostsBefore in interface PostApi

searchPosts

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

Description copied from interface: PostApi

returns any posts with matching term string.

Specified by:: searchPosts in interface PostApi

getFileInfoForPost
```
public ApiResponse<FileInfo[]> getFileInfoForPost(String postId)
```
Description copied from interface: PostApi

get a list of file info attached the post.

Specified by:

getFileInfoForPost in interface PostApi

uploadFile
```
public ApiResponse<FileUploadResult> uploadFile(String channelId,
                                                Path... filePaths)
                                         throws IOException
```
Description copied from interface: FilesApi

Upload a file to specified channel.

Specified by:

uploadFile in interface FilesApi

Parameters:

channelId - channel id will be upload file to.

filePaths - file path to upload.

Throws:

IOException - If an I/O error occurs

getFile
```
public ApiResponse<Path> getFile(String fileId)
                          throws IOException
```
Description copied from interface: FilesApi

Get a file content.

Specified by:

getFile in interface FilesApi

Parameters:

fileId - the file id to get

Throws:

IOException - If an I/O error occurs

getFileThumbnail
```
public ApiResponse<Path> getFileThumbnail(String fileId)
                                   throws IOException
```
Description copied from interface: FilesApi

Get a file thumbnail.

Specified by:

getFileThumbnail in interface FilesApi

Parameters:

fileId - the file id to get thumbnail

Throws:

IOException - If an I/O error occurs

getFilePreview
```
public ApiResponse<Path> getFilePreview(String fileId)
                                 throws IOException
```
Description copied from interface: FilesApi

Get a file preview.

Specified by:

getFilePreview in interface FilesApi

Parameters:

fileId - the file id to get preview

Throws:

IOException - If an I/O error occurs

getPublicFileLink
```
public ApiResponse<String> getPublicFileLink(String fileId)
```
Description copied from interface: FilesApi

Get a public link can be access without logging in to Mattermost.

Specified by:

getPublicFileLink in interface FilesApi

Parameters:

fileId - the file id to get public link

getFileMetadata
```
public ApiResponse<FileInfo> getFileMetadata(String fileId)
```
Description copied from interface: FilesApi

Get a file metadata.

Specified by:

getFileMetadata in interface FilesApi

Parameters:

fileId - the file id to get metadata

getPing
```
public ApiResponse<Boolean> getPing()
```
Description copied from interface: SystemApi

will ping the server and to see if it is up and running.

Specified by:

getPing in interface SystemApi

testEmail
```
public ApiResponse<Boolean> testEmail()
```
Description copied from interface: SystemApi

will attempt to connect to the configured SMTP server.

Specified by:

testEmail in interface SystemApi

getConfig
```
public ApiResponse<Config> getConfig()
```
Description copied from interface: SystemApi

will retrieve the server config with some sanitized items.

Specified by:

getConfig in interface SystemApi

reloadConfig
```
public ApiResponse<Boolean> reloadConfig()
```
Description copied from interface: SystemApi

will reload the server configuration.

Specified by:

reloadConfig in interface SystemApi

getOldClientConfig
```
public ApiResponse<Map<String,String>> getOldClientConfig(String etag)
```
Description copied from interface: SystemApi

will retrieve the parts of the server configuration needed by the client, formatted in the old format.

Specified by:

getOldClientConfig in interface SystemApi

getOldClientLicense
```
public ApiResponse<Map<String,String>> getOldClientLicense(String etag)
```
Description copied from interface: SystemApi

will retrieve the parts of the server license needed by the client, formatted in the old format.

Specified by:

getOldClientLicense in interface SystemApi

databaseRecycle
```
public ApiResponse<Boolean> databaseRecycle()
```
Description copied from interface: SystemApi

will recycle the connections. Discard current connection and get new one.

Specified by:

databaseRecycle in interface SystemApi

invalidateCaches
```
public ApiResponse<Boolean> invalidateCaches()
```
Description copied from interface: SystemApi

will purge the cache and can affect the performance while is cleaning.

Specified by:

invalidateCaches in interface SystemApi

updateConfig
```
public ApiResponse<Config> updateConfig(Config config)
```
Description copied from interface: SystemApi

will update the server configuration.

Specified by:

updateConfig in interface SystemApi

getAnalytics

public ApiResponse<AnalyticsRows> getAnalytics(AnalyticsCategory category,
                                               String teamId)

Specified by:: getAnalytics in interface SystemApi

uploadLicenseFile

public ApiResponse<Boolean> uploadLicenseFile(Path licenseFile)

Specified by:: uploadLicenseFile in interface SystemApi

removeLicense
```
public ApiResponse<Boolean> removeLicense()
```
Specified by:

removeLicense in interface SystemApi

createIncomingWebhook
```
public ApiResponse<IncomingWebhook> createIncomingWebhook(IncomingWebhook hook)
```
Description copied from interface: WebhookApi

creates an incoming webhook for a channel.

Specified by:

createIncomingWebhook in interface WebhookApi

updateIncomingWebhook
```
public ApiResponse<IncomingWebhook> updateIncomingWebhook(IncomingWebhook hook)
```
Description copied from interface: WebhookApi

updates an incoming webhook for a channel.

Specified by:

updateIncomingWebhook in interface WebhookApi

getIncomingWebhooks

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

Description copied from interface: WebhookApi

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

Specified by:: getIncomingWebhooks in interface WebhookApi

getIncomingWebhooksForTeam

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

Description copied from interface: WebhookApi

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

Specified by:: getIncomingWebhooksForTeam in interface WebhookApi

getIncomingWebhook

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

Description copied from interface: WebhookApi

returns an Incoming webhook given the hook id.

Specified by:: getIncomingWebhook in interface WebhookApi

deleteIncomingWebhook
```
public ApiResponse<Boolean> deleteIncomingWebhook(String hookId)
```
Description copied from interface: WebhookApi

deletes an Incoming Webhook given the hook id.

Specified by:

deleteIncomingWebhook in interface WebhookApi

createOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> createOutgoingWebhook(OutgoingWebhook hook)
```
Description copied from interface: WebhookApi

creates an outgoing webhook for a team or channel.

Specified by:

createOutgoingWebhook in interface WebhookApi

updateOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> updateOutgoingWebhook(OutgoingWebhook hook)
```
Description copied from interface: WebhookApi

updates an outgoing webhook.

Specified by:

updateOutgoingWebhook in interface WebhookApi

getOutgoingWebhooks

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

Description copied from interface: WebhookApi

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

Specified by:: getOutgoingWebhooks in interface WebhookApi

getOutgoingWebhook
```
public ApiResponse<OutgoingWebhook> getOutgoingWebhook(String hookId)
```
Description copied from interface: WebhookApi

outgoing webhooks on the system requested by hook id.

Specified by:

getOutgoingWebhook in interface WebhookApi

getOutgoingWebhooksForChannel

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

Description copied from interface: WebhookApi

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

Specified by:: getOutgoingWebhooksForChannel in interface WebhookApi

getOutgoingWebhooksForTeam

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

Description copied from interface: WebhookApi

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

Specified by:: getOutgoingWebhooksForTeam in interface WebhookApi

regenOutgoingHookToken
```
public ApiResponse<OutgoingWebhook> regenOutgoingHookToken(String hookId)
```
Description copied from interface: WebhookApi

regenerate the outgoing webhook token.

Specified by:

regenOutgoingHookToken in interface WebhookApi

deleteOutgoingWebhook
```
public ApiResponse<Boolean> deleteOutgoingWebhook(String hookId)
```
Description copied from interface: WebhookApi

delete the outgoing webhook on the system requested by hook id.

Specified by:

deleteOutgoingWebhook in interface WebhookApi

getPreferences
```
public ApiResponse<Preferences> getPreferences(String userId)
```
Description copied from interface: PreferencesApi

returns the user's preferences.

Specified by:

getPreferences in interface PreferencesApi

updatePreferences

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

Description copied from interface: PreferencesApi

saves the user's preferences.

Specified by:: updatePreferences in interface PreferencesApi

deletePreferences

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

Description copied from interface: PreferencesApi

deletes the user's preferences.

Specified by:: deletePreferences in interface PreferencesApi

getPreferencesByCategory

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

Description copied from interface: PreferencesApi

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

Specified by:: getPreferencesByCategory in interface PreferencesApi

getPreferenceByCategoryAndName

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

Description copied from interface: PreferencesApi

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

Specified by:: getPreferenceByCategoryAndName in interface PreferencesApi

getSamlMetadata
```
public ApiResponse<Path> getSamlMetadata()
                                  throws IOException
```
Description copied from interface: SamlApi

returns metadata for the SAML configuration.

Specified by:

getSamlMetadata in interface SamlApi

Throws:

IOException

uploadSamlIdpCertificate

public ApiResponse<Boolean> uploadSamlIdpCertificate(Path dataFile,
                                                     String fileName)

Description copied from interface: SamlApi

will upload an IDP certificate for SAML and set the config to use it.

Specified by:: uploadSamlIdpCertificate in interface SamlApi

uploadSamlPublicCertificate

public ApiResponse<Boolean> uploadSamlPublicCertificate(Path dataFile,
                                                        String fileName)

Description copied from interface: SamlApi

will upload a public certificate for SAML and set the config to use it.

Specified by:: uploadSamlPublicCertificate in interface SamlApi

uploadSamlPrivateCertificate

public ApiResponse<Boolean> uploadSamlPrivateCertificate(Path dataFile,
                                                         String fileName)

Description copied from interface: SamlApi

will upload a private key for SAML and set the config to use it.

Specified by:: uploadSamlPrivateCertificate in interface SamlApi

deleteSamlIdpCertificate
```
public ApiResponse<Boolean> deleteSamlIdpCertificate()
```
Description copied from interface: SamlApi

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

deleteSamlPublicCertificate
```
public ApiResponse<Boolean> deleteSamlPublicCertificate()
```
Description copied from interface: SamlApi

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

deleteSamlPrivateCertificate
```
public ApiResponse<Boolean> deleteSamlPrivateCertificate()
```
Description copied from interface: SamlApi

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

getSamlCertificateStatus
```
public ApiResponse<SamlCertificateStatus> getSamlCertificateStatus()
```
Description copied from interface: SamlApi

returns metadata for the SAML configuration.

Specified by:

getSamlCertificateStatus in interface SamlApi

createComplianceReport
```
public ApiResponse<Compliance> createComplianceReport(Compliance report)
```
Description copied from interface: ComplianceApi

creates a compliance report.

Specified by:

createComplianceReport in interface ComplianceApi

getComplianceReports
```
public ApiResponse<Compliances> getComplianceReports(Pager pager)
```
Description copied from interface: ComplianceApi

returns list of compliance reports.

Specified by:

getComplianceReports in interface ComplianceApi

getComplianceReport
```
public ApiResponse<Compliance> getComplianceReport(String reportId)
```
Description copied from interface: ComplianceApi

returns a compliance report.

Specified by:

getComplianceReport in interface ComplianceApi

downloadComplianceReport
```
public ApiResponse<Object> downloadComplianceReport(String reportId)
```
Description copied from interface: ComplianceApi

returns a full compliance report as a file.

Specified by:

downloadComplianceReport in interface ComplianceApi

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

getClusterStatus in interface ClusterApi

syncLdap
```
public ApiResponse<Boolean> syncLdap()
```
Description copied from interface: LdapApi

will force a sync with the configured LDAP server.

Specified by:

syncLdap in interface LdapApi

testLdap
```
public ApiResponse<Boolean> testLdap()
```
Description copied from interface: LdapApi

will attempt to connect to the configured LDAP server and return OK if configured correctly.

Specified by:

testLdap in interface LdapApi

getAudits

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

Description copied from interface: AuditsApi

returns a list of audits for the whole system.

Specified by:: getAudits in interface AuditsApi

getBrandImage
```
public ApiResponse<Path> getBrandImage()
                                throws IOException
```
Description copied from interface: BrandApi

retrieves the previously uploaded brand image.

Specified by:

getBrandImage in interface BrandApi

Throws:

IOException

uploadBrandImage
```
public ApiResponse<Boolean> uploadBrandImage(Path dataFile)
```
Description copied from interface: BrandApi

sets the brand image for the system.

Specified by:

uploadBrandImage in interface BrandApi

deleteBrandImage
```
public ApiResponse<Boolean> deleteBrandImage()
```
Description copied from interface: BrandApi

delete the brand image for the system.

Specified by:

deleteBrandImage in interface BrandApi

getLogs
```
public ApiResponse<List<String>> getLogs(Pager pager)
```
Description copied from interface: LogsApi

page of logs as a string list.

Specified by:

getLogs in interface LogsApi

postLog
```
public ApiResponse<Map<String,String>> postLog(Map<String,String> message)
```
Description copied from interface: LogsApi

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

createOAuthApp
```
public ApiResponse<OAuthApp> createOAuthApp(OAuthApp app)
```
Description copied from interface: OAuthApi

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

getOAuthApps
```
public ApiResponse<List<OAuthApp>> getOAuthApps(Pager pager)
```
Description copied from interface: OAuthApi

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

getOAuthApp
```
public ApiResponse<OAuthApp> getOAuthApp(String appId)
```
Description copied from interface: OAuthApi

gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

Specified by:

getOAuthApp in interface OAuthApi

getOAuthAppInfo
```
public ApiResponse<OAuthApp> getOAuthAppInfo(String appId)
```
Description copied from interface: OAuthApi

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

deleteOAuthApp
```
public ApiResponse<Boolean> deleteOAuthApp(String appId)
```
Description copied from interface: OAuthApi

deletes a registered OAuth 2.0 client application.

Specified by:

deleteOAuthApp in interface OAuthApi

regenerateOAuthAppSecret
```
public ApiResponse<OAuthApp> regenerateOAuthAppSecret(String appId)
```
Description copied from interface: OAuthApi

regenerates the client secret for a registered OAuth 2.0 client application.

Specified by:

regenerateOAuthAppSecret in interface OAuthApi

getAuthorizedOAuthAppsForUser

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

Description copied from interface: OAuthApi

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

Specified by:: getAuthorizedOAuthAppsForUser in interface OAuthApi

authorizeOAuthApp
```
public String authorizeOAuthApp(AuthorizeRequest authRequest)
```
Description copied from interface: OAuthApi

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

deauthorizeOAuthApp
```
public ApiResponse<Boolean> deauthorizeOAuthApp(String appId)
```
Description copied from interface: OAuthApi

will deauthorize an OAuth 2.0 client application from accessing a user's account.

Specified by:

deauthorizeOAuthApp in interface OAuthApi

createCommand
```
public ApiResponse<Command> createCommand(Command cmd)
```
Description copied from interface: CommandsApi

will create a new command if the user have the right permissions.

Specified by:

createCommand in interface CommandsApi

updateCommand
```
public ApiResponse<Command> updateCommand(Command cmd)
```
Description copied from interface: CommandsApi

updates a command based on the provided Command object.

Specified by:

updateCommand in interface CommandsApi

deleteCommand
```
public ApiResponse<Boolean> deleteCommand(String commandId)
```
Description copied from interface: CommandsApi

deletes a command based on the provided command id string.

Specified by:

deleteCommand in interface CommandsApi

listCommands
```
public ApiResponse<CommandList> listCommands(String teamId,
                                             boolean customOnly)
```
Description copied from interface: CommandsApi

will retrieve a list of commands available in the team.

Specified by:

listCommands in interface CommandsApi

executeCommand

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

Description copied from interface: CommandsApi

executes a given command.

Specified by:: executeCommand in interface CommandsApi

listAutocompleteCommands
```
public ApiResponse<CommandList> listAutocompleteCommands(String teamId)
```
Description copied from interface: CommandsApi

will retrieve a list of commands available in the team.

Specified by:

listAutocompleteCommands in interface CommandsApi

regenCommandToken
```
public ApiResponse<String> regenCommandToken(String commandId)
```
Description copied from interface: CommandsApi

will create a new token if the user have the right permissions.

Specified by:

regenCommandToken in interface CommandsApi

getUserStatus

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

Description copied from interface: StatusApi

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

Specified by:: getUserStatus in interface StatusApi

getUsersStatusesByIds
```
public ApiResponse<StatusList> getUsersStatusesByIds(String... userIds)
```
Description copied from interface: StatusApi

returns a list of users status based on the provided user ids.

Specified by:

getUsersStatusesByIds in interface StatusApi

updateUserStatus

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

Description copied from interface: StatusApi

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

Specified by:: updateUserStatus in interface StatusApi

createEmoji
```
public ApiResponse<Emoji> createEmoji(Emoji emoji,
                                      Path imageFile)
```
Description copied from interface: EmojiApi

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

getEmojiList
```
public ApiResponse<EmojiList> getEmojiList(Pager pager)
```
Description copied from interface: EmojiApi

returns a list of custom emoji in the system.

Specified by:

getEmojiList in interface EmojiApi

Parameters:

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

getEmojiListSorted
```
public ApiResponse<EmojiList> getEmojiListSorted(Pager pager)
```
Description copied from interface: EmojiApi

returns a list of custom emoji in the system sorted by name.

Specified by:

getEmojiListSorted in interface EmojiApi

deleteEmoji
```
public ApiResponse<Boolean> deleteEmoji(String emojiId)
```
Description copied from interface: EmojiApi

delete an custom emoji on the provided emoji id string.

Specified by:

deleteEmoji in interface EmojiApi

getEmoji
```
public ApiResponse<Emoji> getEmoji(String emojiId)
```
Description copied from interface: EmojiApi

returns a custom emoji in the system on the provided emoji id string.

Specified by:

getEmoji in interface EmojiApi

getEmojiImage
```
public ApiResponse<Path> getEmojiImage(String emojiId)
                                throws IOException
```
Description copied from interface: EmojiApi

returns the emoji image.

Specified by:

getEmojiImage in interface EmojiApi

Throws:

IOException

getEmojiByName
```
public ApiResponse<Emoji> getEmojiByName(String emojiName)
```
Description copied from interface: EmojiApi

get a custom emoji by name.

Specified by:

getEmojiByName in interface EmojiApi

searchEmoji
```
public ApiResponse<EmojiList> searchEmoji(SearchEmojiRequest searchRequest)
```
Description copied from interface: EmojiApi

search custom emoji based on request.

Specified by:

searchEmoji in interface EmojiApi

autocompleteEmoji
```
public ApiResponse<EmojiList> autocompleteEmoji(String name)
```
Description copied from interface: EmojiApi

get a list of custom emoji that name starts with or matching provided name.

Specified by:

autocompleteEmoji in interface EmojiApi

saveReaction
```
public ApiResponse<Reaction> saveReaction(Reaction reaction)
```
Description copied from interface: ReactionApi

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

getReactions
```
public ApiResponse<ReactionList> getReactions(String postId)
```
Description copied from interface: ReactionApi

returns a list of reactions to a post.

Specified by:

getReactions in interface ReactionApi

deleteReaction
```
public ApiResponse<Boolean> deleteReaction(Reaction reaction)
```
Description copied from interface: ReactionApi

deletes reaction of a user in a post.

Specified by:

deleteReaction in interface ReactionApi

testElasticsearchConfiguration
```
public ApiResponse<Boolean> testElasticsearchConfiguration()
```
Description copied from interface: ElasticsearchApi

test Elasticsearch configuration.

Specified by:

testElasticsearchConfiguration in interface ElasticsearchApi

purgeElasticsearchIndexes
```
public ApiResponse<Boolean> purgeElasticsearchIndexes()
```
Description copied from interface: ElasticsearchApi

deletes all Elasticsearch indexes.

Specified by:

purgeElasticsearchIndexes in interface ElasticsearchApi

uploadPlugin

public ApiResponse<PluginManifest> uploadPlugin(Path plugin,
                                                boolean force)

Specified by:: uploadPlugin in interface PluginApi

getPlugins
```
public ApiResponse<Plugins> getPlugins()
```
Specified by:

getPlugins in interface PluginApi

removePlugin

public ApiResponse<Boolean> removePlugin(String pluginId)

Specified by:: removePlugin in interface PluginApi

enablePlugin

public ApiResponse<Boolean> enablePlugin(String pluginId)

Specified by:: enablePlugin in interface PluginApi

disablePlugin

public ApiResponse<Boolean> disablePlugin(String pluginId)

Specified by:: disablePlugin in interface PluginApi

getWebappPlugins
```
public ApiResponse<PluginManifest[]> getWebappPlugins()
```
Specified by:

getWebappPlugins in interface PluginApi

getOpenGraphMetadata
```
public ApiResponse<net.bis5.opengraph.models.OpenGraph> getOpenGraphMetadata(String url)
```
Description copied from interface: OpenGraphApi

Retrieve the OpenGraph metadata for provided url.

Specified by:

getOpenGraphMetadata in interface OpenGraphApi

createBot
```
public ApiResponse<Bot> createBot(BotPatch bot)
```
Description copied from interface: BotsApi

Create a bot.

Specified by:

createBot in interface BotsApi

patchBot

public ApiResponse<Bot> patchBot(String botUserId,
                                 BotPatch patch)

Description copied from interface: BotsApi

Patch a bot.

Specified by:: patchBot in interface BotsApi

getBot

public ApiResponse<Bot> getBot(String botUserId,
                               boolean includeDeleted)

Description copied from interface: BotsApi

Get a bot.

Specified by:: getBot in interface BotsApi

getBots

public ApiResponse<Bots> getBots(Pager pager,
                                 GetBotsOption option)

Description copied from interface: BotsApi

Get bots.

Specified by:: getBots in interface BotsApi

disableBot
```
public ApiResponse<Bot> disableBot(String botUserId)
```
Description copied from interface: BotsApi

Disable a bot.

Specified by:

disableBot in interface BotsApi

enableBot
```
public ApiResponse<Bot> enableBot(String botUserId)
```
Description copied from interface: BotsApi

Enable a bot.

Specified by:

enableBot in interface BotsApi

assignBotToUser

public ApiResponse<Bot> assignBotToUser(String botUserId,
                                        String ownerUserId)

Description copied from interface: BotsApi

Assign a bot to a user.

Specified by:: assignBotToUser in interface BotsApi

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

Constructor	Description
`MattermostClient(String url)`
`MattermostClient(String url, Level logLevel)`	Create new MattermosClient instance.

Class MattermostClient

Nested Class Summary

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.BotsApi

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.LogsApi

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

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

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.SystemApi

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

builder

buildClient

close

setOAuthToken

clearOAuthToken

setAccessToken

getUsersRoute

getUserRoute

getUserByUsernameRoute

getUserByEmailRoute

getUserSessionsRoute

getUserTokensRoute

getUserTokensRoute

getUserTokenRoute

getTeamsRoute

getTeamRoute

getTeamAutoCompleteCommandsRoute

getTeamByNameRoute

getTeamMemberRoute

getTeamMembersRoute

getTeamStatsRoute

getTeamIconRoute

getTeamImportRoute

getTeamInviteRoute

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