| 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 |
|---|---|
protected ApiResponse<User> |
MattermostClient.onLogin(ApiResponse<Void> loginResponse) |
protected ApiResponse<Boolean> |
MattermostClient.onLogout(ApiResponse<Void> logoutResponse) |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<ChannelMember> |
ChannelApi.addChannelMember(String channelId,
String userId)
adds user to channel and return a channel memner.
|
ApiResponse<TeamMember> |
TeamApi.addTeamMember(String hash,
String dataToHash,
String inviteId)
adds user to a team and return a team member.
|
ApiResponse<TeamMember> |
TeamApi.addTeamMember(String teamId,
String userId,
String hash,
String dataToHash,
String inviteId)
Deprecated.
API Change on Mattermost 4.0
|
ApiResponse<TeamMember> |
TeamApi.addTeamMember(TeamMember teamMemberToAdd)
add user to a team and return a team member.
|
default ApiResponse<TeamMemberList> |
TeamApi.addTeamMembers(String teamId,
Collection<String> userIds)
adds a number of users to a team and returns the team members.
|
ApiResponse<TeamMemberList> |
TeamApi.addTeamMembers(String teamId,
String... userIds)
adds a number of users to a team and returns the team members.
|
ApiResponse<Boolean> |
UserApi.attachDeviceId(String deviceId)
attaches a mobile device ID to the current session.
|
ApiResponse<EmojiList> |
EmojiApi.autocompleteEmoji(String name)
get a list of custom emoji that name starts with or matching provided name.
|
default ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsers(String username)
returns the users in the system based on search term.
|
ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsers(String username,
String etag)
returns the users in the system based on search term.
|
default ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsersInChannel(String teamId,
String channelId,
String username)
returns the users in a channel based on search term.
|
ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsersInChannel(String teamId,
String channelId,
String username,
String etag)
returns the users in a channel based on search term.
|
default ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsersInTeam(String teamId,
String username)
returns the users on a team based on search term.
|
ApiResponse<UserAutocomplete> |
UserApi.autocompleteUsersInTeam(String teamId,
String username,
String etag)
returns the users on a team based on search term.
|
ApiResponse<Channel> |
ChannelApi.convertChannelToPrivate(String channelId)
convert channel from public to private.
|
ApiResponse<Channel> |
ChannelApi.createChannel(Channel channel)
creates a channel based on the provided channel object.
|
ApiResponse<Command> |
CommandsApi.createCommand(Command cmd)
will create a new command if the user have the right permissions.
|
ApiResponse<Compliance> |
ComplianceApi.createComplianceReport(Compliance report)
creates a compliance report.
|
ApiResponse<Channel> |
ChannelApi.createDirectChannel(String userId1,
String userId2)
creates a direct message channel based on the two user ids provided.
|
ApiResponse<Emoji> |
EmojiApi.createEmoji(Emoji emoji,
Path imageFile)
will save an emoji to the server if the current user has permission to do so.
|
ApiResponse<Post> |
PostApi.createEphemeralPost(String targetUserId,
Post post)
creates an ephemeral post send to
targetUserId. |
default ApiResponse<Channel> |
ChannelApi.createGroupChannel(Collection<String> userIds)
creates a group message channel based on userIds provided.
|
ApiResponse<Channel> |
ChannelApi.createGroupChannel(String... userIds)
creates a group message channel based on userIds provided.
|
ApiResponse<IncomingWebhook> |
WebhookApi.createIncomingWebhook(IncomingWebhook hook)
creates an incoming webhook for a channel.
|
ApiResponse<OAuthApp> |
OAuthApi.createOAuthApp(OAuthApp app)
will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service
provider.
|
ApiResponse<OutgoingWebhook> |
WebhookApi.createOutgoingWebhook(OutgoingWebhook hook)
creates an outgoing webhook for a team or channel.
|
ApiResponse<Post> |
PostApi.createPost(Post post)
creates a post based on the provided post object.
|
ApiResponse<Team> |
TeamApi.createTeam(Team team)
creates a team in the system based on the provided team object.
|
ApiResponse<User> |
UserApi.createUser(User user)
creates a user in the system based on the provided user object.
|
ApiResponse<UserAccessToken> |
UserApi.createUserAccessToken(String userId,
String description) |
ApiResponse<Boolean> |
SystemApi.databaseRecycle()
will recycle the connections.
|
ApiResponse<Boolean> |
OAuthApi.deauthorizeOAuthApp(String appId)
will deauthorize an OAuth 2.0 client application from accessing a user's account.
|
ApiResponse<Boolean> |
BrandApi.deleteBrandImage()
delete the brand image for the system.
|
ApiResponse<Boolean> |
ChannelApi.deleteChannel(String channelId)
deletes channel based on the provided channel id string.
|
ApiResponse<Boolean> |
CommandsApi.deleteCommand(String commandId)
deletes a command based on the provided command id string.
|
ApiResponse<Boolean> |
EmojiApi.deleteEmoji(String emojiId)
delete an custom emoji on the provided emoji id string.
|
ApiResponse<Boolean> |
WebhookApi.deleteIncomingWebhook(String hookId)
deletes an Incoming Webhook given the hook id.
|
ApiResponse<Boolean> |
OAuthApi.deleteOAuthApp(String appId)
deletes a registered OAuth 2.0 client application.
|
ApiResponse<Boolean> |
WebhookApi.deleteOutgoingWebhook(String hookId)
delete the outgoing webhook on the system requested by hook id.
|
ApiResponse<Boolean> |
PostApi.deletePost(String postId)
deletes a post from the provided post id string.
|
ApiResponse<Boolean> |
PreferencesApi.deletePreferences(String userId,
Preferences preferences)
deletes the user's preferences.
|
ApiResponse<Boolean> |
UserApi.deleteProfileImage(String userId)
delete user profile image.
|
ApiResponse<Boolean> |
ReactionApi.deleteReaction(Reaction reaction)
deletes reaction of a user in a post.
|
ApiResponse<Boolean> |
SamlApi.deleteSamlIdpCertificate()
deletes the SAML IDP certificate from the server and updates the config to not use it and
disable SAML.
|
ApiResponse<Boolean> |
SamlApi.deleteSamlPrivateCertificate()
deletes the SAML IDP certificate from the server and updates the config to not use it and
disable SAML.
|
ApiResponse<Boolean> |
SamlApi.deleteSamlPublicCertificate()
deletes the saml IDP certificate from the server and updates the config to not use it and
disable SAML.
|
default ApiResponse<Boolean> |
TeamApi.deleteTeam(String teamId)
deletes the team softly (archive only, not permanent delete).
|
ApiResponse<Boolean> |
TeamApi.deleteTeam(String teamId,
boolean permanent)
deletes the team.
|
ApiResponse<Boolean> |
UserApi.deleteUser(String userId)
deactivates a user in the system based on the provided user id string.
|
ApiResponse<Boolean> |
PluginApi.disablePlugin(String pluginId) |
ApiResponse<Boolean> |
UserApi.disableUserAccessToken(String tokenId) |
ApiResponse<Object> |
ComplianceApi.downloadComplianceReport(String reportId)
returns a full compliance report as a file.
|
ApiResponse<Boolean> |
PluginApi.enablePlugin(String pluginId) |
ApiResponse<Boolean> |
UserApi.enableUserAccessToken(String tokenId) |
ApiResponse<CommandResponse> |
CommandsApi.executeCommand(String channelId,
String command)
executes a given command.
|
ApiResponse<MfaSecret> |
UserApi.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.
|
default ApiResponse<TeamList> |
TeamApi.getAllTeams()
returns all teams based on permssions.
|
default ApiResponse<TeamList> |
TeamApi.getAllTeams(Pager pager)
returns all teams based on permssions.
|
ApiResponse<TeamList> |
TeamApi.getAllTeams(Pager pager,
String etag)
returns all teams based on permssions.
|
default ApiResponse<AnalyticsRows> |
SystemApi.getAnalytics() |
default ApiResponse<AnalyticsRows> |
SystemApi.getAnalytics(AnalyticsCategory category) |
ApiResponse<AnalyticsRows> |
SystemApi.getAnalytics(AnalyticsCategory category,
String teamId) |
default ApiResponse<AnalyticsRows> |
SystemApi.getAnalytics(String teamId) |
default ApiResponse<Audits> |
AuditsApi.getAudits()
returns a list of audits for the whole system.
|
default ApiResponse<Audits> |
AuditsApi.getAudits(Pager pager)
returns a list of audits for the whole system.
|
ApiResponse<Audits> |
AuditsApi.getAudits(Pager pager,
String etag)
returns a list of audits for the whole system.
|
default ApiResponse<List<OAuthApp>> |
OAuthApi.getAuthorizedOAuthAppsForUser(String userId)
gets a page of OAuth 2.0 client applications the user authorized to use access their account.
|
ApiResponse<List<OAuthApp>> |
OAuthApi.getAuthorizedOAuthAppsForUser(String userId,
Pager pager)
gets a page of OAuth 2.0 client applications the user authorized to use access their account.
|
ApiResponse<Path> |
BrandApi.getBrandImage()
retrieves the previously uploaded brand image.
|
default ApiResponse<Channel> |
ChannelApi.getChannel(String channelId)
returns a channel based on the provided channel id string.
|
ApiResponse<Channel> |
ChannelApi.getChannel(String channelId,
String etag)
returns a channel based on the provided channel id string.
|
default ApiResponse<Channel> |
ChannelApi.getChannelByName(String channelName,
String teamId)
returns a channel based on the provided channel name and team id strings.
|
ApiResponse<Channel> |
ChannelApi.getChannelByName(String channelName,
String teamId,
String etag)
returns a channel based on the provided channel name and team id strings.
|
default ApiResponse<Channel> |
ChannelApi.getChannelByNameForTeamName(String channelName,
String teamName)
returns a channel based on the provided channel name and team name strings.
|
ApiResponse<Channel> |
ChannelApi.getChannelByNameForTeamName(String channelName,
String teamName,
String etag)
returns a channel based on the provided channel name and team name strings.
|
default ApiResponse<ChannelMember> |
ChannelApi.getChannelMember(String channelId,
String userId)
gets a channel memner.
|
ApiResponse<ChannelMember> |
ChannelApi.getChannelMember(String channelId,
String userId,
String etag)
gets a channel memner.
|
default ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembers(String channelId)
gets a page of channel members.
|
default ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembers(String channelId,
Pager pager)
gets a page of channel members.
|
ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembers(String channelId,
Pager pager,
String etag)
gets a page of channel members.
|
default ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembersByIds(String channelId,
Collection<String> userIds)
gets the channel members in a channel for a list of user ids.
|
ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembersByIds(String channelId,
String... userIds)
gets the channel members in a channel for a list of user ids.
|
default ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembersForUser(String userId,
String teamId)
gets all the channel members for a user on a team.
|
ApiResponse<ChannelMembers> |
ChannelApi.getChannelMembersForUser(String userId,
String teamId,
String etag)
gets all the channel members for a user on a team.
|
default ApiResponse<ChannelList> |
ChannelApi.getChannelsForTeamForUser(String teamId,
String userId)
returns a list channels of on a team for user.
|
ApiResponse<ChannelList> |
ChannelApi.getChannelsForTeamForUser(String teamId,
String userId,
String etag)
returns a list channels of on a team for user.
|
default ApiResponse<ChannelStats> |
ChannelApi.getChannelStats(String channelId)
returns statistics for a channel.
|
ApiResponse<ChannelStats> |
ChannelApi.getChannelStats(String channelId,
String etag)
returns statistics for a channel.
|
ApiResponse<ChannelUnread> |
ChannelApi.getChannelUnread(String channelId,
String userId)
will return a ChannelUnread object that contains the number ofo unread messages and mentions
for a user.
|
ApiResponse<ClusterInfo[]> |
ClusterApi.getClusterStatus() |
ApiResponse<Compliance> |
ComplianceApi.getComplianceReport(String reportId)
returns a compliance report.
|
default ApiResponse<Compliances> |
ComplianceApi.getComplianceReports()
returns list of compliance reports.
|
ApiResponse<Compliances> |
ComplianceApi.getComplianceReports(Pager pager)
returns list of compliance reports.
|
ApiResponse<Config> |
SystemApi.getConfig()
will retrieve the server config with some sanitized items.
|
default ApiResponse<ChannelList> |
ChannelApi.getDeletedChannels(String teamId) |
ApiResponse<ChannelList> |
ChannelApi.getDeletedChannels(String teamId,
Pager pager) |
ApiResponse<Emoji> |
EmojiApi.getEmoji(String emojiId)
returns a custom emoji in the system on the provided emoji id string.
|
ApiResponse<Emoji> |
EmojiApi.getEmojiByName(String emojiName)
get a custom emoji by name.
|
ApiResponse<Path> |
EmojiApi.getEmojiImage(String emojiId)
returns the emoji image.
|
default ApiResponse<EmojiList> |
EmojiApi.getEmojiList()
returns a list of custom emoji in the system.
|
ApiResponse<EmojiList> |
EmojiApi.getEmojiList(Pager pager)
returns a list of custom emoji in the system.
|
ApiResponse<Path> |
FilesApi.getFile(String fileId)
Get a file content.
|
ApiResponse<FileInfo[]> |
PostApi.getFileInfoForPost(String postId)
get a list of file info attached the post.
|
ApiResponse<FileInfo> |
FilesApi.getFileMetadata(String fileId)
Get a file metadata.
|
ApiResponse<Path> |
FilesApi.getFilePreview(String fileId)
Get a file preview.
|
ApiResponse<Path> |
FilesApi.getFileThumbnail(String fileId)
Get a file thumbnail.
|
default ApiResponse<PostList> |
PostApi.getFlaggedPostsForUser(String userId)
returns flagges posts of a user based on user id string.
|
ApiResponse<PostList> |
PostApi.getFlaggedPostsForUser(String userId,
Pager pager)
returns flagges posts of a user based on user id string.
|
default ApiResponse<PostList> |
PostApi.getFlaggedPostsForUserInChannel(String userId,
String channelId)
returns flagged posts in channel of a user based on user id string.
|
ApiResponse<PostList> |
PostApi.getFlaggedPostsForUserInChannel(String userId,
String channelId,
Pager pager)
returns flagged posts in channel of a user based on user id string.
|
default ApiResponse<PostList> |
PostApi.getFlaggedPostsForUserInTeam(String userId,
String teamId)
returns flagged posts in team of a user based on user id string.
|
ApiResponse<PostList> |
PostApi.getFlaggedPostsForUserInTeam(String userId,
String teamId,
Pager pager)
returns flagged posts in team of a user based on user id string.
|
default ApiResponse<IncomingWebhook> |
WebhookApi.getIncomingWebhook(String hookId)
returns an Incoming webhook given the hook id.
|
ApiResponse<IncomingWebhook> |
WebhookApi.getIncomingWebhook(String hookId,
String etag)
returns an Incoming webhook given the hook id.
|
default ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooks()
returns a page of incoming webhooks on the system.
|
default ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooks(Pager pager)
returns a page of incoming webhooks on the system.
|
ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooks(Pager pager,
String etag)
returns a page of incoming webhooks on the system.
|
default ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooksForTeam(String teamId)
returns a page of incoming webhooks for a team.
|
default ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooksForTeam(String teamId,
Pager pager)
returns a page of incoming webhooks for a team.
|
ApiResponse<IncomingWebhookList> |
WebhookApi.getIncomingWebhooksForTeam(String teamId,
Pager pager,
String etag)
returns a page of incoming webhooks for a team.
|
ApiResponse<TeamInviteInfo> |
TeamApi.getInviteInfo(String inviteId)
get team info by invite id.
|
default ApiResponse<List<String>> |
LogsApi.getLogs()
page of logs as a string list.
|
ApiResponse<List<String>> |
LogsApi.getLogs(Pager pager)
page of logs as a string list.
|
default ApiResponse<User> |
UserApi.getMe()
returns the logged in user.
|
ApiResponse<User> |
UserApi.getMe(String etag)
returns the logged in user.
|
ApiResponse<OAuthApp> |
OAuthApi.getOAuthApp(String appId)
gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service
provider.
|
ApiResponse<OAuthApp> |
OAuthApi.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.
|
default ApiResponse<List<OAuthApp>> |
OAuthApi.getOAuthApps()
gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0
service provider.
|
ApiResponse<List<OAuthApp>> |
OAuthApi.getOAuthApps(Pager pager)
gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0
service provider.
|
default ApiResponse<Map<String,String>> |
SystemApi.getOldClientConfig()
will retrieve the parts of the server configuration needed by the client, formatted in the old
format.
|
ApiResponse<Map<String,String>> |
SystemApi.getOldClientConfig(String etag)
will retrieve the parts of the server configuration needed by the client, formatted in the old
format.
|
default ApiResponse<Map<String,String>> |
SystemApi.getOldClientLicense()
will retrieve the parts of the server license needed by the client, formatted in the old
format.
|
ApiResponse<Map<String,String>> |
SystemApi.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> |
OpenGraphApi.getOpenGraphMetadata(String url)
Retrieve the OpenGraph metadata for provided url.
|
ApiResponse<OutgoingWebhook> |
WebhookApi.getOutgoingWebhook(String hookId)
outgoing webhooks on the system requested by hook id.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooks()
returns a page of outgoing webhooks ont eh system.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooks(Pager pager)
returns a page of outgoing webhooks ont eh system.
|
ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooks(Pager pager,
String etag)
returns a page of outgoing webhooks ont eh system.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForChannel(String channelId)
returns a page of outgoing webhooks for a channel.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForChannel(String channelId,
Pager pager)
returns a page of outgoing webhooks for a channel.
|
ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForChannel(String channelId,
Pager pager,
String etag)
returns a page of outgoing webhooks for a channel.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForTeam(String teamId)
returns a page of outgoing webhooks for a team.
|
default ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForTeam(String teamId,
Pager pager)
returns a page of outgoing webhooks for a team.
|
ApiResponse<OutgoingWebhookList> |
WebhookApi.getOutgoingWebhooksForTeam(String teamId,
Pager pager,
String etag)
returns a page of outgoing webhooks for a team.
|
ApiResponse<Boolean> |
SystemApi.getPing()
will ping the server and to see if it is up and running.
|
default ApiResponse<PostList> |
ChannelApi.getPinnedPosts(String channelId)
gets a list of pinned posts.
|
ApiResponse<PostList> |
ChannelApi.getPinnedPosts(String channelId,
String etag)
gets a list of pinned posts.
|
ApiResponse<Plugins> |
PluginApi.getPlugins() |
default ApiResponse<Post> |
PostApi.getPost(String postId)
gets a single post.
|
ApiResponse<Post> |
PostApi.getPost(String postId,
String etag)
gets a single post.
|
default ApiResponse<PostList> |
PostApi.getPostsAfter(String channelId,
String postId)
gets a page of posts that were posted after the post provided.
|
default ApiResponse<PostList> |
PostApi.getPostsAfter(String channelId,
String postId,
Pager pager)
gets a page of posts that were posted after the post provided.
|
ApiResponse<PostList> |
PostApi.getPostsAfter(String channelId,
String postId,
Pager pager,
String etag)
gets a page of posts that were posted after the post provided.
|
default ApiResponse<PostList> |
PostApi.getPostsBefore(String channelId,
String postId)
gets a page of posts that were posted before the post provided.
|
default ApiResponse<PostList> |
PostApi.getPostsBefore(String channelId,
String postId,
Pager pager)
gets a page of posts that were posted before the post provided.
|
ApiResponse<PostList> |
PostApi.getPostsBefore(String channelId,
String postId,
Pager pager,
String etag)
gets a page of posts that were posted before the post provided.
|
default ApiResponse<PostList> |
PostApi.getPostsForChannel(String channelId)
gets a page of posts with an array for ordering for a channel.
|
default ApiResponse<PostList> |
PostApi.getPostsForChannel(String channelId,
Pager pager)
gets a page of posts with an array for ordering for a channel.
|
ApiResponse<PostList> |
PostApi.getPostsForChannel(String channelId,
Pager pager,
String etag)
gets a page of posts with an array for ordering for a channel.
|
default ApiResponse<PostList> |
PostApi.getPostsSince(String channelId,
Date since)
gets posts created after a specified time as Unix time in milliseconds.
|
ApiResponse<PostList> |
PostApi.getPostsSince(String channelId,
long since)
gets posts created after a specified time as Unix time in milliseconds.
|
default ApiResponse<PostList> |
PostApi.getPostsSince(String channelId,
ZonedDateTime since)
gets posts created after a specified time as Unix time in milliseconds.
|
default ApiResponse<PostList> |
PostApi.getPostThread(String postId)
gets a post with all the other posts in the same thread.
|
ApiResponse<PostList> |
PostApi.getPostThread(String postId,
String etag)
gets a post with all the other posts in the same thread.
|
ApiResponse<Preference> |
PreferencesApi.getPreferenceByCategoryAndName(String userId,
PreferenceCategory category,
String preferenceName)
returns the user's preferences from the provided category and preference name string.
|
ApiResponse<Preferences> |
PreferencesApi.getPreferences(String userId)
returns the user's preferences.
|
ApiResponse<Preferences> |
PreferencesApi.getPreferencesByCategory(String userId,
PreferenceCategory category)
returns the user's preferences from the provided category string.
|
default ApiResponse<byte[]> |
UserApi.getProfileImage(String userId)
gets user's profile image.
|
ApiResponse<byte[]> |
UserApi.getProfileImage(String userId,
String etag)
gets user's profile image.
|
default ApiResponse<ChannelList> |
ChannelApi.getPublicChannelsByIdsForTeam(String teamId,
Collection<String> channelIds)
returns a list of public channeld based on provided team id string.
|
ApiResponse<ChannelList> |
ChannelApi.getPublicChannelsByIdsForTeam(String teamId,
String... channelIds)
returns a list of public channeld based on provided team id string.
|
default ApiResponse<ChannelList> |
ChannelApi.getPublicChannelsForTeam(String teamId)
returns a list of public channels based on the provided team id string.
|
default ApiResponse<ChannelList> |
ChannelApi.getPublicChannelsForTeam(String teamId,
Pager pager)
returns a list of public channels based on the provided team id string.
|
ApiResponse<ChannelList> |
ChannelApi.getPublicChannelsForTeam(String teamId,
Pager pager,
String etag)
returns a list of public channels based on the provided team id string.
|
ApiResponse<String> |
FilesApi.getPublicFileLink(String fileId)
Get a public link can be access without logging in to Mattermost.
|
ApiResponse<ReactionList> |
ReactionApi.getReactions(String postId)
returns a list of reactions to a post.
|
ApiResponse<SamlCertificateStatus> |
SamlApi.getSamlCertificateStatus()
returns metadata for the SAML configuration.
|
ApiResponse<Path> |
SamlApi.getSamlMetadata()
returns metadata for the SAML configuration.
|
default ApiResponse<SessionList> |
UserApi.getSessions(String userId)
returns a list of sessions based on the provided user id string.
|
ApiResponse<SessionList> |
UserApi.getSessions(String userId,
String etag)
returns a list of sessions based on the provided user id string.
|
default ApiResponse<Team> |
TeamApi.getTeam(String teamId)
returns a team based on the provided team id string.
|
ApiResponse<Team> |
TeamApi.getTeam(String teamId,
String etag)
returns a team based on the provided team id string.
|
default ApiResponse<Team> |
TeamApi.getTeamByName(String name)
returns a team based on the provided team name string.
|
ApiResponse<Team> |
TeamApi.getTeamByName(String name,
String etag)
returns a team based on the provided team name string.
|
ApiResponse<Path> |
TeamApi.getTeamIcon(String teamId)
Get the team icon image.
|
default ApiResponse<TeamMember> |
TeamApi.getTeamMember(String teamId,
String userId)
returns a team member based on the provided team and user id strings.
|
ApiResponse<TeamMember> |
TeamApi.getTeamMember(String teamId,
String userId,
String etag)
returns a team member based on the provided team and user id strings.
|
default ApiResponse<TeamMemberList> |
TeamApi.getTeamMembers(String teamId)
returns team members based on the provided team id string.
|
default ApiResponse<TeamMemberList> |
TeamApi.getTeamMembers(String teamId,
Pager pager)
returns team members based on the provided team id string.
|
ApiResponse<TeamMemberList> |
TeamApi.getTeamMembers(String teamId,
Pager pager,
String etag)
returns team members based on the provided team id string.
|
default ApiResponse<TeamMemberList> |
TeamApi.getTeamMembersByIds(String teamId,
Collection<String> userIds)
will return an array of team members based on the team id and a list of user ids provided.
|
ApiResponse<TeamMemberList> |
TeamApi.getTeamMembersByIds(String teamId,
String... userIds)
will return an array of team members based on the team id and a list of user ids provided.
|
default ApiResponse<TeamMemberList> |
TeamApi.getTeamMembersForUser(String userId)
returns the team member for a user.
|
ApiResponse<TeamMemberList> |
TeamApi.getTeamMembersForUser(String userId,
String etag)
returns the team member for a user.
|
default ApiResponse<TeamList> |
TeamApi.getTeamsForUser(String userId)
returns a list of teams a user is on.
|
ApiResponse<TeamList> |
TeamApi.getTeamsForUser(String userId,
String etag)
returns a list of teams a user is on.
|
default ApiResponse<TeamStats> |
TeamApi.getTeamStats(String teamId)
returns a team stats based on the team id string.
|
ApiResponse<TeamStats> |
TeamApi.getTeamStats(String teamId,
String etag)
returns a team stats based on the team id string.
|
ApiResponse<TeamUnread> |
TeamApi.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.
|
default ApiResponse<TeamUnreadList> |
UserApi.getTeamUnreadForUser(String userId)
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<TeamUnreadList> |
UserApi.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.
|
default ApiResponse<User> |
UserApi.getUser(String userId)
returns a user based on the provided user id string.
|
ApiResponse<User> |
UserApi.getUser(String userId,
String etag)
returns a user based on the provided user id string.
|
ApiResponse<UserAccessToken> |
UserApi.getUserAccessToken(String tokenId) |
default ApiResponse<UserAccessTokenList> |
UserApi.getUserAccessTokens(String userId) |
ApiResponse<UserAccessTokenList> |
UserApi.getUserAccessTokens(String userId,
Pager pager) |
default ApiResponse<UserAccessTokenList> |
UserApi.getUserAccessTokensAllUsers() |
ApiResponse<UserAccessTokenList> |
UserApi.getUserAccessTokensAllUsers(Pager pager) |
default ApiResponse<Audits> |
UserApi.getUserAudits(String userId)
returns a list of audit based on the provided user id string.
|
default ApiResponse<Audits> |
UserApi.getUserAudits(String userId,
Pager pager)
returns a list of audit based on the provided user id string.
|
ApiResponse<Audits> |
UserApi.getUserAudits(String userId,
Pager pager,
String etag)
returns a list of audit based on the provided user id string.
|
default ApiResponse<User> |
UserApi.getUserByEmail(String email)
returns a user based on the provided user email string.
|
ApiResponse<User> |
UserApi.getUserByEmail(String email,
String etag)
returns a user based on the provided user email string.
|
default ApiResponse<User> |
UserApi.getUserByUsername(String username)
returns a user based pn the provided user name string.
|
ApiResponse<User> |
UserApi.getUserByUsername(String username,
String etag)
returns a user based pn the provided user name string.
|
default ApiResponse<UserList> |
UserApi.getUsers()
returns a page of users on the system.
|
default ApiResponse<UserList> |
UserApi.getUsers(Pager pager)
returns a page of users on the system.
|
ApiResponse<UserList> |
UserApi.getUsers(Pager pager,
String etag)
returns a page of users on the system.
|
default ApiResponse<UserList> |
UserApi.getUsersByIds(Collection<String> userIds)
returns a list of users based on the provided user ids.
|
ApiResponse<UserList> |
UserApi.getUsersByIds(String... userIds)
returns a list of users based on the provided user ids.
|
default ApiResponse<UserList> |
UserApi.getUsersByUsernames(Collection<String> usernames)
returns a list of users based on the provided usernames.
|
ApiResponse<UserList> |
UserApi.getUsersByUsernames(String... usernames)
returns a list of users based on the provided usernames.
|
default ApiResponse<UserList> |
UserApi.getUsersInChannel(String channelId)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInChannel(String channelId,
Pager pager)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInChannel(String channelId,
Pager pager,
String etag)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInChannel(String channelId,
UsersOrder.InChannel order,
Pager pager)
returns a page of users on a team.
|
ApiResponse<UserList> |
UserApi.getUsersInChannel(String channelId,
UsersOrder.InChannel order,
Pager pager,
String etag)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInTeam(String teamId)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInTeam(String teamId,
Pager pager)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInTeam(String teamId,
Pager pager,
String etag)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersInTeam(String teamId,
UsersOrder.InTeam order,
Pager pager)
returns a page of users on a team.
|
ApiResponse<UserList> |
UserApi.getUsersInTeam(String teamId,
UsersOrder.InTeam order,
Pager pager,
String etag)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersNotInChannel(String teamId,
String channelId)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersNotInChannel(String teamId,
String channelId,
Pager pager)
returns a page of users on a team.
|
ApiResponse<UserList> |
UserApi.getUsersNotInChannel(String teamId,
String channelId,
Pager pager,
String etag)
returns a page of users on a team.
|
default ApiResponse<UserList> |
UserApi.getUsersNotInTeam(String teamId)
returns a page of users who are not in a team.
|
default ApiResponse<UserList> |
UserApi.getUsersNotInTeam(String teamId,
Pager pager)
returns a page of users who are not in a team.
|
ApiResponse<UserList> |
UserApi.getUsersNotInTeam(String teamId,
Pager pager,
String etag)
returns a page of users who are not in a team.
|
default ApiResponse<StatusList> |
StatusApi.getUsersStatusesByIds(Collection<String> userIds)
returns a list of users status based on the provided user ids.
|
ApiResponse<StatusList> |
StatusApi.getUsersStatusesByIds(String... userIds)
returns a list of users status based on the provided user ids.
|
default ApiResponse<Status> |
StatusApi.getUserStatus(String userId)
returns a user status based on the provided user id string.
|
ApiResponse<Status> |
StatusApi.getUserStatus(String userId,
String etag)
returns a user status based on the provided user id string.
|
default ApiResponse<UserList> |
UserApi.getUsersWithoutTeam()
returns a page of users on the system that aren't on any teams.
|
default ApiResponse<UserList> |
UserApi.getUsersWithoutTeam(Pager pager)
returns a page of users on the system that aren't on any teams.
|
ApiResponse<UserList> |
UserApi.getUsersWithoutTeam(Pager pager,
String etag)
returns a page of users on the system that aren't on any teams.
|
ApiResponse<PluginManifest[]> |
PluginApi.getWebappPlugins() |
ApiResponse<WebrtcInfoResponse> |
WebrtcApi.getWebrtcToken()
Deprecated.
returns a valid token, stun server and turn server with credentials to use with the Mattermost
WebRTC service.
|
ApiResponse<byte[]> |
TeamApi.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> |
SystemApi.invalidateCaches()
will purge the cache and can affect the performance while is cleaning.
|
ApiResponse<Boolean> |
TeamApi.inviteUsersToTeam(String teamId,
Collection<String> userEmails)
invite users by email to the team.
|
ApiResponse<CommandList> |
CommandsApi.listAutocompleteCommands(String teamId)
will retrieve a list of commands available in the team.
|
default ApiResponse<CommandList> |
CommandsApi.listCommands(String teamId)
will retrieve a list of commands available in the team.
|
ApiResponse<CommandList> |
CommandsApi.listCommands(String teamId,
boolean customOnly)
will retrieve a list of commands available in the team.
|
ApiResponse<Boolean> |
AuthenticationApi.logout()
terminates the current user's session.
|
ApiResponse<Channel> |
ChannelApi.patchChannel(String channelId,
ChannelPatch patch)
partially updates a channel.
|
ApiResponse<Post> |
PostApi.patchPost(String postId,
PostPatch patch)
partially updates a post.
|
ApiResponse<Team> |
TeamApi.patchTeam(String teamId,
TeamPatch patch)
partially updates a team.
|
ApiResponse<User> |
UserApi.patchUser(String userId,
UserPatch patch)
partially updates a user in the system.
|
ApiResponse<Boolean> |
PostApi.pinPost(String postId)
pin a post based on proviced post id string.
|
ApiResponse<Map<String,String>> |
LogsApi.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> |
ElasticsearchApi.purgeElasticsearchIndexes()
deletes all Elasticsearch indexes.
|
ApiResponse<String> |
CommandsApi.regenCommandToken(String commandId)
will create a new token if the user have the right permissions.
|
ApiResponse<OAuthApp> |
OAuthApi.regenerateOAuthAppSecret(String appId)
regenerates the client secret for a registered OAuth 2.0 client application.
|
ApiResponse<OutgoingWebhook> |
WebhookApi.regenOutgoingHookToken(String hookId)
regenerate the outgoing webhook token.
|
ApiResponse<Boolean> |
SystemApi.reloadConfig()
will reload the server configuration.
|
ApiResponse<Boolean> |
SystemApi.removeLicense() |
ApiResponse<Boolean> |
PluginApi.removePlugin(String pluginId) |
ApiResponse<Boolean> |
TeamApi.removeTeamIcon(String teamId)
Remove the team icon.
|
ApiResponse<Boolean> |
TeamApi.removeTeamMember(String teamId,
String userId)
will remove a user from a team.
|
default ApiResponse<Boolean> |
TeamApi.removeTeamMember(TeamMember teamMember)
will remove a user from a team.
|
ApiResponse<Boolean> |
ChannelApi.removeUserFromChannel(String channelId,
String userId)
will delete the channel member object for a user, effectively removing the user from a channel.
|
ApiResponse<Boolean> |
UserApi.resetPassword(String token,
String newPassword)
uses a recovery code to update reset a user's password.
|
ApiResponse<Channel> |
ChannelApi.restoreChannel(String channelId) |
ApiResponse<Boolean> |
UserApi.revokeAllActiveSessionForUser(String userId) |
default ApiResponse<Boolean> |
UserApi.revokeSession(Session session)
revokes a user session based on the provided user id and session id strings.
|
ApiResponse<Boolean> |
UserApi.revokeSession(String userId,
String sessionId)
revokes a user session based on the provided user id and session id strings.
|
ApiResponse<Boolean> |
UserApi.revokeUserAccessToken(String tokenId) |
ApiResponse<Reaction> |
ReactionApi.saveReaction(Reaction reaction)
saves an emoji reaction for a post.
|
ApiResponse<ChannelList> |
ChannelApi.searchChannels(String teamId,
ChannelSearch search)
returns the channels on a team matching the provided search term.
|
ApiResponse<EmojiList> |
EmojiApi.searchEmoji(SearchEmojiRequest searchRequest)
search custom emoji based on request.
|
default ApiResponse<PostSearchResults> |
PostApi.searchPosts(String teamId,
String terms)
returns any posts with matching term string.
|
ApiResponse<PostSearchResults> |
PostApi.searchPosts(String teamId,
String terms,
boolean isOrSearch)
returns any posts with matching term string.
|
ApiResponse<TeamList> |
TeamApi.searchTeams(TeamSearch search)
returns teams matching the provided search term.
|
ApiResponse<UserAccessTokenList> |
UserApi.searchTokens(String term) |
ApiResponse<UserList> |
UserApi.searchUsers(UserSearch search)
returns a list of users based on some search criteria.
|
ApiResponse<Boolean> |
UserApi.sendPasswordResetEmail(String email)
will send a link for password resetting to a user with the provided email.
|
ApiResponse<Boolean> |
UserApi.sendVerificationEmail(String email)
will send an email to the user with the provided email addresses, if that user exists.
|
ApiResponse<Boolean> |
UserApi.setProfileImage(String userId,
Path imageFilePath)
sets profile image of the user.
|
ApiResponse<Boolean> |
TeamApi.setTeamIcon(String teamId,
Path iconFilePath)
Set the team icon.
|
ApiResponse<SwitchAccountTypeResult> |
AuthenticationApi.switchAccountType(SwitchRequest switchRequest)
changes a user's login type from one type to another.
|
ApiResponse<Boolean> |
LdapApi.syncLdap()
will force a sync with the configured LDAP server.
|
default ApiResponse<TeamExists> |
TeamApi.teamExists(String name)
returns true or false if the team exist or not.
|
ApiResponse<TeamExists> |
TeamApi.teamExists(String name,
String etag)
returns true or false if the team exist or not.
|
ApiResponse<Boolean> |
ElasticsearchApi.testElasticsearchConfiguration()
test Elasticsearch configuration.
|
ApiResponse<Boolean> |
SystemApi.testEmail()
will attempt to connect to the configured SMTP server.
|
ApiResponse<Boolean> |
LdapApi.testLdap()
will attempt to connect to the configured LDAP server and return OK if configured correctly.
|
ApiResponse<Boolean> |
PostApi.unpinPost(String postId)
unpin a post based on provided post id string.
|
ApiResponse<Channel> |
ChannelApi.updateChannel(Channel channel)
update a channel based on the provided channel object.
|
ApiResponse<Boolean> |
ChannelApi.updateChannelNotifyProps(String channeLId,
String userId,
Map<String,String> props)
will update the notification properties on a channel for a user.
|
default ApiResponse<Boolean> |
ChannelApi.updateChannelRoles(String channelId,
String userId,
Collection<Role> roles)
will update the roles on a channel for a user.
|
ApiResponse<Boolean> |
ChannelApi.updateChannelRoles(String channelId,
String userId,
Role... roles)
will update the roles on a channel for a user.
|
ApiResponse<Command> |
CommandsApi.updateCommand(Command cmd)
updates a command based on the provided Command object.
|
ApiResponse<Config> |
SystemApi.updateConfig(Config config)
will update the server configuration.
|
ApiResponse<IncomingWebhook> |
WebhookApi.updateIncomingWebhook(IncomingWebhook hook)
updates an incoming webhook for a channel.
|
ApiResponse<OutgoingWebhook> |
WebhookApi.updateOutgoingWebhook(OutgoingWebhook hook)
updates an outgoing webhook.
|
default ApiResponse<Post> |
PostApi.updatePost(Post post)
updates a post based on the provided post object.
|
ApiResponse<Post> |
PostApi.updatePost(String postId,
Post post)
updates a post based on the provided post object.
|
ApiResponse<Boolean> |
PreferencesApi.updatePreferences(String userId,
Preferences perferences)
saves the user's preferences.
|
ApiResponse<Team> |
TeamApi.updateTeam(Team team)
will update a team.
|
default ApiResponse<Boolean> |
TeamApi.updateTeamMemberRoles(String teamId,
String userId,
Collection<Role> newRoles)
will update the roles on a team for a user.
|
ApiResponse<Boolean> |
TeamApi.updateTeamMemberRoles(String teamId,
String userId,
Role... newROles)
will update the roles on a team for a user.
|
ApiResponse<User> |
UserApi.updateUser(User user)
updates a user in the system based on the provided user object.
|
ApiResponse<Boolean> |
UserApi.updateUserActive(String userId,
boolean active)
updates status of a user whether active or not.
|
ApiResponse<Boolean> |
UserApi.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> |
UserApi.updateUserPassword(String userId,
String currentPassword,
String newPassword)
updates a user's password.
|
default ApiResponse<Boolean> |
UserApi.updateUserRoles(String userId,
Collection<Role> roles)
updates a user's roles in the system.
|
ApiResponse<Boolean> |
UserApi.updateUserRoles(String userId,
Role... roles)
updates a user's roles in the system.
|
ApiResponse<Status> |
StatusApi.updateUserStatus(String userId,
Status userStatus)
sets a user's status based on the provided user id string.
|
ApiResponse<Boolean> |
BrandApi.uploadBrandImage(Path dataFIle)
sets the brand image for the system.
|
ApiResponse<FileUploadResult> |
FilesApi.uploadFile(String channelId,
Path... filePath)
Upload a file to specified channel.
|
ApiResponse<Boolean> |
SystemApi.uploadLicenseFile(Path licenseFile) |
default ApiResponse<PluginManifest> |
PluginApi.uploadPlugin(Path plugin) |
ApiResponse<PluginManifest> |
PluginApi.uploadPlugin(Path plugin,
boolean force) |
ApiResponse<Boolean> |
SamlApi.uploadSamlIdpCertificate(Path dataFile,
String fileName)
will upload an IDP certificate for SAML and set the config to use it.
|
ApiResponse<Boolean> |
SamlApi.uploadSamlPrivateCertificate(Path dataFile,
String fileName)
will upload a private key for SAML and set the config to use it.
|
ApiResponse<Boolean> |
SamlApi.uploadSamlPublicCertificate(Path dataFile,
String fileName)
will upload a public certificate for SAML and set the config to use it.
|
ApiResponse<Boolean> |
UserApi.verifyUserEmail(String token)
will verify a user's email using the supplied token.
|
ApiResponse<ChannelViewResponse> |
ChannelApi.viewChannel(String userId,
ChannelView view)
performs a view action for a user.
|
| 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.