| Package | Description |
|---|---|
| net.bis5.mattermost.client4 | |
| net.bis5.mattermost.client4.api | |
| net.bis5.mattermost.client4.api.hook | |
| net.bis5.mattermost.client4.hook |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<ChannelMember> |
MattermostClient.addChannelMember(String channelId,
String userId)
adds user to channel and return a channel memner.
|
ApiResponse<TeamMember> |
MattermostClient.addTeamMember(String hash,
String dataToHash,
String inviteId)
adds user to a team and return a team member.
|
ApiResponse<TeamMember> |
MattermostClient.addTeamMember(String teamId,
String userId,
String hash,
String dataToHash,
String inviteId)
Deprecated.
API Change on Mattermost 4.0
|
ApiResponse<TeamMember> |
MattermostClient.addTeamMember(TeamMember teamMemberToAdd)
add user to a team and return a team member.
|
ApiResponse<TeamMemberList> |
MattermostClient.addTeamMembers(String teamId,
String... userIds)
adds a number of users to a team and returns the team members.
|
ApiResponse<Boolean> |
MattermostClient.attachDeviceId(String deviceId)
attaches a mobile device ID to the current session.
|
ApiResponse<UserAutocomplete> |
MattermostClient.autocompleteUsers(String username,
String etag)
returns the users in the system based on search term.
|
ApiResponse<UserAutocomplete> |
MattermostClient.autocompleteUsersInChannel(String teamId,
String channelId,
String username,
String etag)
returns the users in a channel based on search term.
|
ApiResponse<UserAutocomplete> |
MattermostClient.autocompleteUsersInTeam(String teamId,
String username,
String etag)
returns the users on a team based on search term.
|
protected ApiResponse<Boolean> |
ApiResponse.checkJsonStatusOk(javax.ws.rs.core.Response response) |
protected ApiResponse<Boolean> |
ApiResponse.checkPlainStatusOk(javax.ws.rs.core.Response response) |
ApiResponse<Boolean> |
ApiResponse.checkStatusOk()
a convenience function for checking the standard OK response from the web service.
|
ApiResponse<Channel> |
MattermostClient.createChannel(Channel channel)
creates a channel based on the provided channel object.
|
ApiResponse<Command> |
MattermostClient.createCommand(Command cmd)
will create a new command if the user have the right permissions.
|
ApiResponse<Compliance> |
MattermostClient.createComplianceReport(Compliance report)
creates a compliance report.
|
ApiResponse<Channel> |
MattermostClient.createDirectChannel(String userId1,
String userId2)
creates a direct message channel based on the two user ids provided.
|
ApiResponse<Emoji> |
MattermostClient.createEmoji(Emoji emoji,
Path imageFile)
will save an emoji to the server if the current user has permission to do so.
|
ApiResponse<Channel> |
MattermostClient.createGroupChannel(String... userIds)
creates a group message channel based on userIds provided.
|
ApiResponse<IncomingWebhook> |
MattermostClient.createIncomingWebhook(IncomingWebhook hook)
creates an incoming webhook for a channel.
|
ApiResponse<OAuthApp> |
MattermostClient.createOAuthApp(OAuthApp app)
will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service
provider.
|
ApiResponse<OutgoingWebhook> |
MattermostClient.createOutgoingWebhook(OutgoingWebhook hook)
creates an outgoing webhook for a team or channel.
|
ApiResponse<Post> |
MattermostClient.createPost(Post post)
creates a post based on the provided post object.
|
ApiResponse<Team> |
MattermostClient.createTeam(Team team)
creates a team in the system based on the provided team object.
|
ApiResponse<User> |
MattermostClient.createUser(User user)
creates a user in the system based on the provided user object.
|
ApiResponse<UserAccessToken> |
MattermostClient.createUserAccessToken(String userId,
String description) |
ApiResponse<Boolean> |
MattermostClient.databaseRecycle()
will recycle the connections.
|
ApiResponse<Boolean> |
MattermostClient.deauthorizeOAuthApp(String appId)
will deauthorize an OAuth 2.0 client application from accessing a user's account.
|
ApiResponse<Boolean> |
MattermostClient.deleteChannel(String channelId)
deletes channel based on the provided channel id string.
|
ApiResponse<Boolean> |
MattermostClient.deleteCommand(String commandId)
deletes a command based on the provided command id string.
|
ApiResponse<Boolean> |
MattermostClient.deleteEmoji(String emojiId)
delete an custom emoji on the provided emoji id string.
|
ApiResponse<Boolean> |
MattermostClient.deleteIncomingWebhook(String hookId)
deletes an Incoming Webhook given the hook id.
|
ApiResponse<Boolean> |
MattermostClient.deleteOAuthApp(String appId)
deletes a registered OAuth 2.0 client application.
|
ApiResponse<Boolean> |
MattermostClient.deleteOutgoingWebhook(String hookId)
delete the outgoing webhook on the system requested by hook id.
|
ApiResponse<Boolean> |
MattermostClient.deletePost(String postId)
deletes a post from the provided post id string.
|
ApiResponse<Boolean> |
MattermostClient.deletePreferences(String userId,
Preferences preferences)
deletes the user's preferences.
|
ApiResponse<Boolean> |
MattermostClient.deleteReaction(Reaction reaction)
deletes reaction of a user in a post.
|
ApiResponse<Boolean> |
MattermostClient.deleteSamlIdpCertificate()
deletes the SAML IDP certificate from the server and updates the config to not use it and
disable SAML.
|
ApiResponse<Boolean> |
MattermostClient.deleteSamlPrivateCertificate()
deletes the SAML IDP certificate from the server and updates the config to not use it and
disable SAML.
|
ApiResponse<Boolean> |
MattermostClient.deleteSamlPublicCertificate()
deletes the saml IDP certificate from the server and updates the config to not use it and
disable SAML.
|
ApiResponse<Boolean> |
MattermostClient.deleteTeam(String teamId)
deletes the team softly (archive only, not permanent delete).
|
ApiResponse<Boolean> |
MattermostClient.deleteTeam(String teamId,
boolean permanent)
deletes the team.
|
ApiResponse<Boolean> |
MattermostClient.deleteUser(String userId)
deactivates a user in the system based on the provided user id string.
|
ApiResponse<Boolean> |
MattermostClient.disableUserAccessToken(String tokenId) |
protected ApiResponse<Void> |
MattermostClient.doApiDelete(String url) |
protected <T> ApiResponse<T> |
MattermostClient.doApiDelete(String url,
Class<T> responseType) |
protected ApiResponse<Void> |
MattermostClient.doApiGet(String url,
String etag) |
protected <T> ApiResponse<T> |
MattermostClient.doApiGet(String url,
String etag,
Class<T> responseType) |
protected <T> ApiResponse<T> |
MattermostClient.doApiGet(String url,
String etag,
javax.ws.rs.core.GenericType<T> responseType) |
protected <U> ApiResponse<Void> |
MattermostClient.doApiPost(String url,
U data) |
protected <T,U> ApiResponse<T> |
MattermostClient.doApiPost(String url,
U data,
Class<T> responseType) |
protected <T,U> ApiResponse<T> |
MattermostClient.doApiPost(String url,
U data,
javax.ws.rs.core.GenericType<T> responseType) |
protected ApiResponse<Void> |
MattermostClient.doApiPostMultiPart(String url,
org.glassfish.jersey.media.multipart.MultiPart multiPart) |
protected <T> ApiResponse<T> |
MattermostClient.doApiPostMultiPart(String url,
org.glassfish.jersey.media.multipart.MultiPart multiPart,
Class<T> responseType) |
protected <U> ApiResponse<Void> |
MattermostClient.doApiPut(String url,
U data) |
protected <T,U> ApiResponse<T> |
MattermostClient.doApiPut(String url,
U data,
Class<T> responseType) |
protected <U> ApiResponse<Void> |
MattermostClient.doApiRequest(String method,
String url,
U data,
String etag) |
protected <T,U> ApiResponse<T> |
MattermostClient.doApiRequest(String method,
String url,
U data,
String etag,
Class<T> responseType) |
protected <T,U> ApiResponse<T> |
MattermostClient.doApiRequest(String method,
String url,
U data,
String etag,
javax.ws.rs.core.GenericType<T> responseType) |
ApiResponse<Object> |
MattermostClient.downloadComplianceReport(String reportId)
returns a full compliance report as a file.
|
ApiResponse<Boolean> |
MattermostClient.enableUserAccessToken(String tokenId) |
ApiResponse<CommandResponse> |
MattermostClient.executeCommand(String channelId,
String command)
executes a given command.
|
ApiResponse<MfaSecret> |
MattermostClient.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> |
MattermostClient.getAllTeams(Pager pager,
String etag)
returns all teams based on permssions.
|
ApiResponse<AnalyticsRows> |
MattermostClient.getAnalytics(AnalyticsCategory category,
String teamId) |
ApiResponse<Audits> |
MattermostClient.getAudits(Pager pager,
String etag)
returns a list of audits for the whole system.
|
ApiResponse<List<OAuthApp>> |
MattermostClient.getAuthorizedOAuthAppsForUser(String userId,
Pager pager)
gets a page of OAuth 2.0 client applications the user authorized to use access their account.
|
ApiResponse<Object> |
MattermostClient.getBrandImage()
retrieves the previously uploaded brand image.
|
ApiResponse<Channel> |
MattermostClient.getChannel(String channelId,
String etag)
returns a channel based on the provided channel id string.
|
ApiResponse<Channel> |
MattermostClient.getChannelByName(String channelName,
String teamId,
String etag)
returns a channel based on the provided channel name and team id strings.
|
ApiResponse<Channel> |
MattermostClient.getChannelByNameForTeamName(String channelName,
String teamName,
String etag)
returns a channel based on the provided channel name and team name strings.
|
ApiResponse<ChannelMember> |
MattermostClient.getChannelMember(String channelId,
String userId,
String etag)
gets a channel memner.
|
ApiResponse<ChannelMembers> |
MattermostClient.getChannelMembers(String channelId,
Pager pager,
String etag)
gets a page of channel members.
|
ApiResponse<ChannelMembers> |
MattermostClient.getChannelMembersByIds(String channelId,
String... userIds)
gets the channel members in a channel for a list of user ids.
|
ApiResponse<ChannelMembers> |
MattermostClient.getChannelMembersForUser(String userId,
String teamId,
String etag)
gets all the channel members for a user on a team.
|
ApiResponse<ChannelList> |
MattermostClient.getChannelsForTeamForUser(String teamId,
String userId,
String etag)
returns a list channels of on a team for user.
|
ApiResponse<ChannelStats> |
MattermostClient.getChannelStats(String channelId,
String etag)
returns statistics for a channel.
|
ApiResponse<ChannelUnread> |
MattermostClient.getChannelUnread(String channelId,
String userId)
will return a ChannelUnread object that contains the number ofo unread messages and mentions
for a user.
|
ApiResponse<List<ClusterInfo>> |
MattermostClient.getClusterStatus() |
ApiResponse<Compliance> |
MattermostClient.getComplianceReport(String reportId)
returns a compliance report.
|
ApiResponse<Compliances> |
MattermostClient.getComplianceReports(Pager pager)
returns list of compliance reports.
|
ApiResponse<Config> |
MattermostClient.getConfig()
will retrieve the server config with some sanitized items.
|
ApiResponse<ChannelList> |
MattermostClient.getDeletedChannels(String teamId,
Pager pager) |
ApiResponse<Emoji> |
MattermostClient.getEmoji(String emojiId)
returns a custom emoji in the system on the provided emoji id string.
|
ApiResponse<Path> |
MattermostClient.getEmojiImage(String emojiId)
returns the emoji image.
|
ApiResponse<EmojiList> |
MattermostClient.getEmojiList(Pager pager)
returns a list of custom emoji in the system.
|
ApiResponse<PostList> |
MattermostClient.getFlaggedPostsForUser(String userId,
Pager pager)
returns flagges posts of a user based on user id string.
|
ApiResponse<PostList> |
MattermostClient.getFlaggedPostsForUserInChannel(String userId,
String channelId,
Pager pager)
returns flagged posts in channel of a user based on user id string.
|
ApiResponse<PostList> |
MattermostClient.getFlaggedPostsForUserInTeam(String userId,
String teamId,
Pager pager)
returns flagged posts in team of a user based on user id string.
|
ApiResponse<IncomingWebhook> |
MattermostClient.getIncomingWebhook(String hookId,
String etag)
returns an Incoming webhook given the hook id.
|
ApiResponse<IncomingWebhookList> |
MattermostClient.getIncomingWebhooks(Pager pager,
String etag)
returns a page of incoming webhooks on the system.
|
ApiResponse<IncomingWebhookList> |
MattermostClient.getIncomingWebhooksForTeam(String teamId,
Pager pager,
String etag)
returns a page of incoming webhooks for a team.
|
ApiResponse<List<String>> |
MattermostClient.getLogs(Pager pager)
page of logs as a string list.
|
ApiResponse<User> |
MattermostClient.getMe(String etag)
returns the logged in user.
|
ApiResponse<OAuthApp> |
MattermostClient.getOAuthApp(String appId)
gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service
provider.
|
ApiResponse<OAuthApp> |
MattermostClient.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.
|
ApiResponse<List<OAuthApp>> |
MattermostClient.getOAuthApps(Pager pager)
gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0
service provider.
|
ApiResponse<Map<String,String>> |
MattermostClient.getOldClientConfig(String etag)
will retrieve the parts of the server configuration needed by the client, formatted in the old
format.
|
ApiResponse<Map<String,String>> |
MattermostClient.getOldClientLicense(String etag)
will retrieve the parts of the server license needed by the client, formatted in the old
format.
|
ApiResponse<OutgoingWebhook> |
MattermostClient.getOutgoingWebhook(String hookId)
outgoing webhooks on the system requested by hook id.
|
ApiResponse<OutgoingWebhookList> |
MattermostClient.getOutgoingWebhooks(Pager pager,
String etag)
returns a page of outgoing webhooks ont eh system.
|
ApiResponse<OutgoingWebhookList> |
MattermostClient.getOutgoingWebhooksForChannel(String channelId,
Pager pager,
String etag)
returns a page of outgoing webhooks for a channel.
|
ApiResponse<OutgoingWebhookList> |
MattermostClient.getOutgoingWebhooksForTeam(String teamId,
Pager pager,
String etag)
returns a page of outgoing webhooks for a team.
|
ApiResponse<Boolean> |
MattermostClient.getPing()
will ping the server and to see if it is up and running.
|
ApiResponse<PostList> |
MattermostClient.getPinnedPosts(String channelId,
String etag)
gets a list of pinned posts.
|
ApiResponse<Post> |
MattermostClient.getPost(String postId,
String etag)
gets a single post.
|
ApiResponse<PostList> |
MattermostClient.getPostsAfter(String channelId,
String postId,
Pager pager,
String etag)
gets a page of posts that were posted after the post provided.
|
ApiResponse<PostList> |
MattermostClient.getPostsBefore(String channelId,
String postId,
Pager pager,
String etag)
gets a page of posts that were posted before the post provided.
|
ApiResponse<PostList> |
MattermostClient.getPostsForChannel(String channelId,
Pager pager,
String etag)
gets a page of posts with an array for ordering for a channel.
|
ApiResponse<PostList> |
MattermostClient.getPostsSince(String channelId,
long time)
gets posts created after a specified time as Unix time in milliseconds.
|
ApiResponse<PostList> |
MattermostClient.getPostThread(String postId,
String etag)
gets a post with all the other posts in the same thread.
|
ApiResponse<Preference> |
MattermostClient.getPreferenceByCategoryAndName(String userId,
PreferenceCategory category,
String preferenceName)
returns the user's preferences from the provided category and preference name string.
|
ApiResponse<Preferences> |
MattermostClient.getPreferences(String userId)
returns the user's preferences.
|
ApiResponse<Preferences> |
MattermostClient.getPreferencesByCategory(String userId,
PreferenceCategory category)
returns the user's preferences from the provided category string.
|
ApiResponse<byte[]> |
MattermostClient.getProfileImage(String userId,
String etag)
gets user's profile image.
|
ApiResponse<ChannelList> |
MattermostClient.getPublicChannelsByIdsForTeam(String teamId,
String... channelIds)
returns a list of public channeld based on provided team id string.
|
ApiResponse<ChannelList> |
MattermostClient.getPublicChannelsForTeam(String teamId,
Pager pager,
String etag)
returns a list of public channels based on the provided team id string.
|
ApiResponse<List<Reaction>> |
MattermostClient.getReactions(String postId)
returns a list of reactions to a post.
|
ApiResponse<SamlCertificateStatus> |
MattermostClient.getSamlCertificateStatus()
returns metadata for the SAML configuration.
|
ApiResponse<String> |
MattermostClient.getSamlMetadata()
returns metadata for the SAML configuration.
|
ApiResponse<SessionList> |
MattermostClient.getSessions(String userId,
String etag)
returns a list of sessions based on the provided user id string.
|
ApiResponse<Team> |
MattermostClient.getTeam(String teamId,
String etag)
returns a team based on the provided team id string.
|
ApiResponse<Team> |
MattermostClient.getTeamByName(String name,
String etag)
returns a team based on the provided team name string.
|
ApiResponse<TeamMember> |
MattermostClient.getTeamMember(String teamId,
String userId,
String etag)
returns a team member based on the provided team and user id strings.
|
ApiResponse<TeamMemberList> |
MattermostClient.getTeamMembers(String teamId,
Pager pager,
String etag)
returns team members based on the provided team id string.
|
ApiResponse<TeamMemberList> |
MattermostClient.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> |
MattermostClient.getTeamMembersForUser(String userId,
String etag)
returns the team member for a user.
|
ApiResponse<TeamList> |
MattermostClient.getTeamsForUser(String userId,
String etag)
returns a list of teams a user is on.
|
ApiResponse<TeamStats> |
MattermostClient.getTeamStats(String teamId,
String etag)
returns a team stats based on the team id string.
|
ApiResponse<TeamUnread> |
MattermostClient.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> |
MattermostClient.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.
|
ApiResponse<User> |
MattermostClient.getUser(String userId,
String etag)
returns a user based on the provided user id string.
|
ApiResponse<UserAccessToken> |
MattermostClient.getUserAccessToken(String tokenId) |
ApiResponse<UserAccessTokenList> |
MattermostClient.getUserAccessTokens(String userId,
Pager pager) |
ApiResponse<UserAccessTokenList> |
MattermostClient.getUserAccessTokensAllUsers(Pager pager) |
ApiResponse<Audits> |
MattermostClient.getUserAudits(String userId,
Pager pager,
String etag)
returns a list of audit based on the provided user id string.
|
ApiResponse<User> |
MattermostClient.getUserByEmail(String email,
String etag)
returns a user based on the provided user email string.
|
ApiResponse<User> |
MattermostClient.getUserByUsername(String userName,
String etag)
returns a user based pn the provided user name string.
|
ApiResponse<UserList> |
MattermostClient.getUsers(Pager pager,
String etag)
returns a page of users on the system.
|
ApiResponse<UserList> |
MattermostClient.getUsersByIds(String... userIds)
returns a list of users based on the provided user ids.
|
ApiResponse<UserList> |
MattermostClient.getUsersByUsernames(String... usernames)
returns a list of users based on the provided usernames.
|
ApiResponse<UserList> |
MattermostClient.getUsersInChannel(String channelId,
UsersOrder.InChannel order,
Pager pager,
String etag)
returns a page of users on a team.
|
ApiResponse<UserList> |
MattermostClient.getUsersInTeam(String teamId,
UsersOrder.InTeam order,
Pager pager,
String etag)
returns a page of users on a team.
|
ApiResponse<UserList> |
MattermostClient.getUsersNotInChannel(String teamId,
String channelId,
Pager pager,
String etag)
returns a page of users on a team.
|
ApiResponse<UserList> |
MattermostClient.getUsersNotInTeam(String teamId,
Pager pager,
String etag)
returns a page of users who are not in a team.
|
ApiResponse<List<Status>> |
MattermostClient.getUsersStatusesByIds(String... userIds)
returns a list of users status based on the provided user ids.
|
ApiResponse<Status> |
MattermostClient.getUserStatus(String userId,
String etag)
returns a user status based on the provided user id string.
|
ApiResponse<UserList> |
MattermostClient.getUsersWithoutTeam(Pager pager,
String etag)
returns a page of users on the system that aren't on any teams.
|
ApiResponse<WebrtcInfoResponse> |
MattermostClient.getWebrtcToken()
returns a valid token, stun server and turn server with credentials to use with the Mattermost
WebRTC service.
|
ApiResponse<byte[]> |
MattermostClient.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> |
MattermostClient.invalidateCaches()
will purge the cache and can affect the performance while is cleaning.
|
ApiResponse<Boolean> |
MattermostClient.inviteUsersToTeam(String teamId,
Collection<String> userEmails)
invite users by email to the team.
|
ApiResponse<CommandList> |
MattermostClient.listAutocompleteCommands(String teamId)
will retrieve a list of commands available in the team.
|
ApiResponse<CommandList> |
MattermostClient.listCommands(String teamId,
boolean customOnly)
will retrieve a list of commands available in the team.
|
ApiResponse<Boolean> |
MattermostClient.logout()
terminates the current user's session.
|
static <T> ApiResponse<T> |
ApiResponse.of(javax.ws.rs.core.Response response,
Class<T> entityClass) |
static <T> ApiResponse<T> |
ApiResponse.of(javax.ws.rs.core.Response response,
javax.ws.rs.core.GenericType<T> genericType) |
static <T> ApiResponse<T> |
ApiResponse.of(javax.ws.rs.core.Response response,
T data) |
protected ApiResponse<User> |
MattermostClient.onLogin(ApiResponse<Void> loginResponse) |
protected ApiResponse<Boolean> |
MattermostClient.onLogout(ApiResponse<Void> logoutResponse) |
ApiResponse<Channel> |
MattermostClient.patchChannel(String channelId,
ChannelPatch patch)
partially updates a channel.
|
ApiResponse<Post> |
MattermostClient.patchPost(String postId,
PostPatch patch)
partially updates a post.
|
ApiResponse<Team> |
MattermostClient.patchTeam(String teamId,
TeamPatch patch)
partially updates a team.
|
ApiResponse<User> |
MattermostClient.patchUser(String userId,
UserPatch patch)
partially updates a user in the system.
|
ApiResponse<Boolean> |
MattermostClient.pinPost(String postId)
pin a post based on proviced post id string.
|
ApiResponse<Map<String,String>> |
MattermostClient.postLog(Map<String,String> message)
This method is a convenience Web Service call so clients can log messages into the server-side
logs.
|
ApiResponse<String> |
MattermostClient.regenCommandToken(String commandId)
will create a new token if the user have the right permissions.
|
ApiResponse<OAuthApp> |
MattermostClient.regenerateOAuthAppSecret(String appId)
regenerates the client secret for a registered OAuth 2.0 client application.
|
ApiResponse<OutgoingWebhook> |
MattermostClient.regenOutgoingHookToken(String hookId)
regenerate the outgoing webhook token.
|
ApiResponse<Boolean> |
MattermostClient.reloadConfig()
will reload the server configuration.
|
ApiResponse<Boolean> |
MattermostClient.removeLicense() |
ApiResponse<Boolean> |
MattermostClient.removeTeamMember(String teamId,
String userId)
will remove a user from a team.
|
ApiResponse<Boolean> |
MattermostClient.removeUserFromChannel(String channelId,
String userId)
will delete the channel member object for a user, effectively removing the user from a channel.
|
ApiResponse<Boolean> |
MattermostClient.resetPassword(String token,
String newPassword)
uses a recovery code to update reset a user's password.
|
ApiResponse<Channel> |
MattermostClient.restoreChannel(String channelId) |
ApiResponse<Boolean> |
MattermostClient.revokeSession(String userId,
String sessionId)
revokes a user session based on the provided user id and session id strings.
|
ApiResponse<Boolean> |
MattermostClient.revokeUserAccessToken(String tokenId) |
ApiResponse<Reaction> |
MattermostClient.saveReaction(Reaction reaction)
saves an emoji reaction for a post.
|
ApiResponse<ChannelList> |
MattermostClient.searchChannels(String teamId,
ChannelSearch search)
returns the channels on a team matching the provided search term.
|
ApiResponse<PostSearchResults> |
MattermostClient.searchPosts(String teamId,
String terms,
boolean isOrSearch)
returns any posts with matching term string.
|
ApiResponse<TeamList> |
MattermostClient.searchTeams(TeamSearch search)
returns teams matching the provided search term.
|
ApiResponse<UserAccessTokenList> |
MattermostClient.searchTokens(String term) |
ApiResponse<UserList> |
MattermostClient.searchUsers(UserSearch search)
returns a list of users based on some search criteria.
|
ApiResponse<Boolean> |
MattermostClient.sendPasswordResetEmail(String email)
will send a link for password resetting to a user with the provided email.
|
ApiResponse<Boolean> |
MattermostClient.sendVerificationEmail(String email)
will send an email to the user with the provided email addresses, if that user exists.
|
ApiResponse<Boolean> |
MattermostClient.setProfileImage(String userId,
Path imageFilePath)
sets profile image of the user.
|
ApiResponse<SwitchAccountTypeResult> |
MattermostClient.switchAccountType(SwitchRequest switchRequest)
changes a user's login type from one type to another.
|
ApiResponse<Boolean> |
MattermostClient.syncLdap()
will force a sync with the configured LDAP server.
|
ApiResponse<TeamExists> |
MattermostClient.teamExists(String name,
String etag)
returns true or false if the team exist or not.
|
ApiResponse<Boolean> |
MattermostClient.testEmail()
will attempt to connect to the configured SMTP server.
|
ApiResponse<Boolean> |
MattermostClient.testLdap()
will attempt to connect to the configured LDAP server and return OK if configured correctly.
|
ApiResponse<Boolean> |
MattermostClient.unpinPost(String postId)
unpin a post based on provided post id string.
|
ApiResponse<Channel> |
MattermostClient.updateChannel(Channel channel)
update a channel based on the provided channel object.
|
ApiResponse<Boolean> |
MattermostClient.updateChannelNotifyProps(String channelId,
String userId,
Map<String,String> props)
will update the notification properties on a channel for a user.
|
ApiResponse<Boolean> |
MattermostClient.updateChannelRoles(String channelId,
String userId,
Role... roles)
will update the roles on a channel for a user.
|
ApiResponse<Command> |
MattermostClient.updateCommand(Command cmd)
updates a command based on the provided Command object.
|
ApiResponse<Config> |
MattermostClient.updateConfig(Config config)
will update the server configuration.
|
ApiResponse<IncomingWebhook> |
MattermostClient.updateIncomingWebhook(IncomingWebhook hook)
updates an incoming webhook for a channel.
|
ApiResponse<OutgoingWebhook> |
MattermostClient.updateOutgoingWebhook(OutgoingWebhook hook)
updates an outgoing webhook.
|
ApiResponse<Post> |
MattermostClient.updatePost(String postId,
Post post)
updates a post based on the provided post object.
|
ApiResponse<Boolean> |
MattermostClient.updatePreferences(String userId,
Preferences preferences)
saves the user's preferences.
|
ApiResponse<Team> |
MattermostClient.updateTeam(Team team)
will update a team.
|
ApiResponse<Boolean> |
MattermostClient.updateTeamMemberRoles(String teamId,
String userId,
Role... newRoles)
will update the roles on a team for a user.
|
ApiResponse<User> |
MattermostClient.updateUser(User user)
updates a user in the system based on the provided user object.
|
ApiResponse<Boolean> |
MattermostClient.updateUserActive(String userId,
boolean active)
updates status of a user whether active or not.
|
ApiResponse<Boolean> |
MattermostClient.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> |
MattermostClient.updateUserPassword(String userId,
String currentPassword,
String newPassword)
updates a user's password.
|
ApiResponse<Boolean> |
MattermostClient.updateUserRoles(String userId,
Role... roles)
updates a user's roles in the system.
|
ApiResponse<Status> |
MattermostClient.updateUserStatus(String userId,
Status userStatus)
sets a user's status based on the provided user id string.
|
ApiResponse<Boolean> |
MattermostClient.uploadLicenseFile(Path licenseFile) |
ApiResponse<Boolean> |
MattermostClient.verifyUserEmail(String token)
will verify a user's email using the supplied token.
|
ApiResponse<ChannelViewResponse> |
MattermostClient.viewChannel(String userId,
ChannelView view)
performs a view action for a user.
|
| Modifier and Type | Method and Description |
|---|---|
protected ApiResponse<User> |
MattermostClient.onLogin(ApiResponse<Void> loginResponse) |
protected ApiResponse<Boolean> |
MattermostClient.onLogout(ApiResponse<Void> logoutResponse) |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<Boolean> |
IncomingWebhook.postByIncomingWebhook(IncomingWebhookRequest payload) |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<Boolean> |
IncomingWebhookClient.postByIncomingWebhook(IncomingWebhookRequest payload) |
Copyright © 2019. All rights reserved.