Skip navigation links
A B C D E G H I L M N O P Q R S T U V W 

A

addChannelMember(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
addChannelMember(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
adds user to channel and return a channel memner.
AddChannelMemberRequest - Class in net.bis5.mattermost.client4.model
Add Channel Member request payload
AddChannelMemberRequest() - Constructor for class net.bis5.mattermost.client4.model.AddChannelMemberRequest
 
addTeamMember(TeamMember) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
addTeamMember(String, String, String, String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
Deprecated.
addTeamMember(String, String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
addTeamMember(TeamMember) - Method in class net.bis5.mattermost.client4.MattermostClient
add user to a team and return a team member.
addTeamMember(String, String, String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
Deprecated.
API Change on Mattermost 4.0
addTeamMember(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
adds user to a team and return a team member.
addTeamMembers(String, Collection<String>) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
addTeamMembers(String, String...) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
addTeamMembers(String, String...) - Method in class net.bis5.mattermost.client4.MattermostClient
adds a number of users to a team and returns the team members.
API_URL_SUFFIX - Static variable in class net.bis5.mattermost.client4.MattermostClient
 
ApiError - Class in net.bis5.mattermost.client4.model
API error response
ApiError() - Constructor for class net.bis5.mattermost.client4.model.ApiError
 
ApiResponse<T> - Class in net.bis5.mattermost.client4
API response
ApiResponse() - Constructor for class net.bis5.mattermost.client4.ApiResponse
 
append(String, String) - Method in class net.bis5.mattermost.client4.QueryBuilder
 
append(String, int) - Method in class net.bis5.mattermost.client4.QueryBuilder
 
append(String, boolean) - Method in class net.bis5.mattermost.client4.QueryBuilder
 
attachDeviceId(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
attachDeviceId(String) - Method in class net.bis5.mattermost.client4.MattermostClient
attaches a mobile device ID to the current session/
AttachDeviceIdRequest - Class in net.bis5.mattermost.client4.model
Attach device id request payload
AttachDeviceIdRequest() - Constructor for class net.bis5.mattermost.client4.model.AttachDeviceIdRequest
 
AuditsApi - Interface in net.bis5.mattermost.client4.api
Audits API
AuthenticationApi - Interface in net.bis5.mattermost.client4.api
Authentication API
authorizeOAuthApp(AuthorizeRequest) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
authorizeOAuthApp(AuthorizeRequest) - Method in class net.bis5.mattermost.client4.MattermostClient
will authorize an OAuth 2.0 client application to access a user's account and provide a redirect link to follow.
AuthType - Enum in net.bis5.mattermost.client4
API Authentication type
autocompleteUsers(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsers(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsers(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the users in the system based on search term.
autocompleteUsersInChannel(String, String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsersInChannel(String, String, String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsersInChannel(String, String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the users in a channel based on search term.
autocompleteUsersInTeam(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsersInTeam(String, String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
autocompleteUsersInTeam(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the users on a team based on search term.

B

BrandApi - Interface in net.bis5.mattermost.client4.api
Branding API
buildClient() - Method in class net.bis5.mattermost.client4.MattermostClient
 

C

ChannelApi - Interface in net.bis5.mattermost.client4.api
Channel API
checkStatusOK() - Method in class net.bis5.mattermost.client4.ApiResponse
a convenience function for checking the standard OK response from the web service.
checkUserMfa(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
checkUserMfa(String) - Method in class net.bis5.mattermost.client4.MattermostClient
checks whether a user has MFA active on their account or not based on the provided login id.
CheckUserMfaRequest - Class in net.bis5.mattermost.client4.model
Check user MFA request payload
CheckUserMfaRequest() - Constructor for class net.bis5.mattermost.client4.model.CheckUserMfaRequest
 
clearOAuthToken() - Method in class net.bis5.mattermost.client4.MattermostClient
 
close() - Method in class net.bis5.mattermost.client4.MattermostClient
 
ClusterApi - Interface in net.bis5.mattermost.client4.api
Cluster API
CommandsApi - Interface in net.bis5.mattermost.client4.api
Command API
ComplianceApi - Interface in net.bis5.mattermost.client4.api
Compliance API
createChannel(Channel) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
createChannel(Channel) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a channel based on the provided channel object.
createCommand(Command) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
createCommand(Command) - Method in class net.bis5.mattermost.client4.MattermostClient
will create a new command if the user have the right permissions.
createComplianceReport(Compliance) - Method in interface net.bis5.mattermost.client4.api.ComplianceApi
 
createComplianceReport(Compliance) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a compliance report.
createDefaultObjectMapper() - Method in class net.bis5.mattermost.jersey.provider.MattermostModelMapperProvider
 
createDirectChannel(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
createDirectChannel(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a direct message channel based on the two user ids provided.
createEmoji(Emoji, Path) - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
createEmoji(Emoji, Path) - Method in class net.bis5.mattermost.client4.MattermostClient
will save an emoji to the server if the current user has permission to do so.
createGroupChannel(Collection<String>) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
createGroupChannel(String...) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
createGroupChannel(String...) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a group message channel based on userIds provided.
createIncomingWebhook(IncomingWebhook) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
createIncomingWebhook(IncomingWebhook) - Method in class net.bis5.mattermost.client4.MattermostClient
creates an incoming webhook for a channel.
createOAuthApp(OAuthApp) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
createOAuthApp(OAuthApp) - Method in class net.bis5.mattermost.client4.MattermostClient
will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
createOutgoingWebhook(OutgoingWebhook) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
createOutgoingWebhook(OutgoingWebhook) - Method in class net.bis5.mattermost.client4.MattermostClient
creates an outgoing webhook for a team or channel.
createPost(Post) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
createPost(Post) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a post based on the provided post object.
createTeam(Team) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
createTeam(Team) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a team in the system based on the provided team object.
createUser(User) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
createUser(User) - Method in class net.bis5.mattermost.client4.MattermostClient
creates a user in the system based on the provided user object.

D

databaseRecycle() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
databaseRecycle() - Method in class net.bis5.mattermost.client4.MattermostClient
will recycle the connections.
deauthorizeOAuthApp(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
deauthorizeOAuthApp(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will deauthorize an OAuth 2.0 client application from accessing a user's account.
DeauthorizeOAuthAppRequest - Class in net.bis5.mattermost.client4.model
Deauthorize OAuth app request payload
DeauthorizeOAuthAppRequest() - Constructor for class net.bis5.mattermost.client4.model.DeauthorizeOAuthAppRequest
 
defaultPager() - Static method in class net.bis5.mattermost.client4.Pager
 
deleteChannel(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
deleteChannel(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes channel based on the provided channel id string.
deleteCommand(String) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
deleteCommand(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes a command based on the provided command id string.
deleteEmoji(String) - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
deleteEmoji(String) - Method in class net.bis5.mattermost.client4.MattermostClient
delete an custom emoji on the provided emoji id string.
deleteIncomingWebhook(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
deleteIncomingWebhook(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes an Incoming Webhook given the hook id.
deleteOAuthApp(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
deleteOAuthApp(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes a registered OAuth 2.0 client application.
deleteOutgoingWebhook(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
deleteOutgoingWebhook(String) - Method in class net.bis5.mattermost.client4.MattermostClient
delete the outgoing webhook on the system requested by hook id.
deletePost(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
deletePost(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes a post from the provided post id string.
deletePreferences(String, Preferences) - Method in interface net.bis5.mattermost.client4.api.PreferencesApi
 
deletePreferences(String, Preferences) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the user's preferences.
deleteReaction(Reaction) - Method in interface net.bis5.mattermost.client4.api.ReactionApi
 
deleteReaction(Reaction) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes reaction of a user in a post.
deleteSamlIdpCertificate() - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
deleteSamlIdpCertificate() - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
deleteSamlPrivateCertificate() - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
deleteSamlPrivateCertificate() - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
deleteSamlPublicCertificate() - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
deleteSamlPublicCertificate() - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the saml IDP certificate from the server and updates the config to not use it and disable SAML.
deleteTeam(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
deleteTeam(String, boolean) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
deleteTeam(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the team softly (archive only, not permanent delete).
deleteTeam(String, boolean) - Method in class net.bis5.mattermost.client4.MattermostClient
deletes the team
deleteUser(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
deleteUser(String) - Method in class net.bis5.mattermost.client4.MattermostClient
deactivates a user in the system based on the provided user id string.
doApiDelete(String, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiDelete(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiGet(String, String, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiGet(String, String, GenericType<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiGet(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPost(String, U, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPost(String, U, GenericType<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPost(String, U) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPostMultiPart(String, MultiPart) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPostMultiPart(String, MultiPart, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPut(String, U, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiPut(String, U) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiRequest(String, String, U, String, Class<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiRequest(String, String, U, String, GenericType<T>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
doApiRequest(String, String, U, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
downloadComplianceReport(String) - Method in interface net.bis5.mattermost.client4.api.ComplianceApi
 
downloadComplianceReport(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a full compliance report as a file/

E

EmojiApi - Interface in net.bis5.mattermost.client4.api
Emoji API
executeCommand(String, String) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
executeCommand(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
executes a given command.

G

GeneralApi - Interface in net.bis5.mattermost.client4.api
General API
generateMfaSecret(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
generateMfaSecret(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.
getAllTeams() - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getAllTeams(Pager) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getAllTeams(Pager, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getAllTeams(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns all teams based on permssions.
getAudits() - Method in interface net.bis5.mattermost.client4.api.AuditsApi
 
getAudits(Pager) - Method in interface net.bis5.mattermost.client4.api.AuditsApi
 
getAudits(Pager, String) - Method in interface net.bis5.mattermost.client4.api.AuditsApi
 
getAudits(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of audits for the whole system.
getAuthorizedOAuthAppsForUser(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getAuthorizedOAuthAppsForUser(String, Pager) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getAuthorizedOAuthAppsForUser(String, Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of OAuth 2.0 client applications the user authorized to use access their account.
getBrandImage() - Method in interface net.bis5.mattermost.client4.api.BrandApi
 
getBrandImage() - Method in class net.bis5.mattermost.client4.MattermostClient
retrieves the previously uploaded brand image.
getBrandRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getCacheRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannel(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannel(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannel(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a channel based on the provided channel id string.
getChannelByName(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelByName(String, String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelByName(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a channel based on the provided channel name and team id strings.
getChannelByNameForTeamName(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelByNameForTeamName(String, String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelByNameForTeamName(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a channel based on the provided channel name and team name strings.
getChannelByNameForTeamNameRoute(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelByNameRoute(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelMember(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMember(String, String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMember(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a channel memner.
getChannelMemberRoute(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelMembers(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembers(String, Pager) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembers(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembers(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of channel members.
getChannelMembersByIds(String, Collection<String>) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembersByIds(String, String...) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembersByIds(String, String...) - Method in class net.bis5.mattermost.client4.MattermostClient
gets the channel members in a channel for a list of user ids.
getChannelMembersForUser(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembersForUser(String, String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelMembersForUser(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets all the channel members for a user on a team.
getChannelMembersRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelsForTeamForUser(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelsForTeamForUser(String, String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelsForTeamForUser(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list channels of on a team for user.
getChannelsForTeamRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getChannelStats(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelStats(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelStats(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns statistics for a channel.
getChannelUnread(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getChannelUnread(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will return a ChannelUnread object that contains the number ofo unread messages and mentions for a user.
getClusterRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getClusterStatus() - Method in interface net.bis5.mattermost.client4.api.ClusterApi
 
getClusterStatus() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getCommandRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getCommandsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getComplianceReport(String) - Method in interface net.bis5.mattermost.client4.api.ComplianceApi
 
getComplianceReport(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a compliance report.
getComplianceReportRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getComplianceReports() - Method in interface net.bis5.mattermost.client4.api.ComplianceApi
 
getComplianceReports(Pager) - Method in interface net.bis5.mattermost.client4.api.ComplianceApi
 
getComplianceReports(Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
returns list of compliance reports.
getComplianceReportsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getConfig() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getConfig() - Method in class net.bis5.mattermost.client4.MattermostClient
will retrieve the server config with some sanitized items.
getConfigRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getContext(Class<?>) - Method in class net.bis5.mattermost.jersey.provider.MattermostModelMapperProvider
 
getDatabaseRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getEmoji(String) - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
getEmoji(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a custom emoji in the system on the provided emoji id string.
getEmojiImage(String) - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
getEmojiImage(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the emoji image.
getEmojiList() - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
getEmojiList(Pager) - Method in interface net.bis5.mattermost.client4.api.EmojiApi
 
getEmojiList(Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of custom emoji in the syste,/
getEmojiRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getEmojisRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getEtag() - Method in class net.bis5.mattermost.client4.ApiResponse
 
getFileRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getFilesRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getFlaggedPostsForUser(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUser(String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUser(String, Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
returns flagges posts of a user based on user id string.
getFlaggedPostsForUserInChannel(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUserInChannel(String, String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUserInChannel(String, String, Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
returns flagged posts in channel of a user based on user id string.
getFlaggedPostsForUserInTeam(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUserInTeam(String, String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getFlaggedPostsForUserInTeam(String, String, Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
returns flagged posts in team of a user based on user id string.
getIncomingWebhook(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhook(String, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhook(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns an Incoming webhook given the hook id.
getIncomingWebhookRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getIncomingWebhooks() - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooks(Pager) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooks(Pager, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooks(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of incoming webhooks on the system.
getIncomingWebhooksForTeam(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooksForTeam(String, Pager) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooksForTeam(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getIncomingWebhooksForTeam(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of incoming webhooks for a team.
getIncomingWebhooksRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getLdapRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getLicenseRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getLogs() - Method in interface net.bis5.mattermost.client4.api.LogsApi
 
getLogs(Pager) - Method in interface net.bis5.mattermost.client4.api.LogsApi
 
getLogs(Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
page of logs as a string list.
getMe() - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getMe(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getMe(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the logged in user.
getOAuthApp(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getOAuthApp(String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
getOAuthAppInfo(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getOAuthAppInfo(String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a sanitized version of a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.
getOAuthAppRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getOAuthApps() - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getOAuthApps(Pager) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
getOAuthApps(Pager) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.
getOAuthAppsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getOldClientConfig() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getOldClientConfig(String) - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getOldClientConfig(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will retrieve the parts of the server configuration needed by the client, formatted in the old format.
getOldClientLicense() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getOldClientLicense(String) - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getOldClientLicense(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will retrieve the parts of the server license needed by the client, formatted in the old format.
getOutgoingWebhook(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhook(String) - Method in class net.bis5.mattermost.client4.MattermostClient
outgoing webhooks on the system requested by hook id.
getOutgoingWebhookRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getOutgoingWebhooks() - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooks(Pager) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooks(Pager, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooks(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of outgoing webhooks ont eh system.
getOutgoingWebhooksForChannel(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForChannel(String, Pager) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForChannel(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForChannel(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of outgoing webhooks for a channel.
getOutgoingWebhooksForTeam(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForTeam(String, Pager) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForTeam(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
getOutgoingWebhooksForTeam(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of outgoing webhooks for a team.
getOutgoingWebhooksRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getPing() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
getPing() - Method in class net.bis5.mattermost.client4.MattermostClient
will ping the server and to see if it is up and running.
getPinnedPosts(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPinnedPosts(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPinnedPosts(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a list of pinned posts.
getPost(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPost(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPost(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a single post.
getPostRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getPostsAfter(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsAfter(String, String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsAfter(String, String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsAfter(String, String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of posts that were posted after the post provided.
getPostsBefore(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsBefore(String, String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsBefore(String, String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsBefore(String, String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of posts that were posted before the post provided.
getPostsForChannel(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsForChannel(String, Pager) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsForChannel(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsForChannel(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a page of posts with an array for ordering for a channel.
getPostsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getPostsSince(String, Date) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsSince(String, OffsetDateTime) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsSince(String, long) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostsSince(String, long) - Method in class net.bis5.mattermost.client4.MattermostClient
gets posts created after a specified time as Unix time in milliseconds.
getPostThread(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostThread(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
getPostThread(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets a post with all the other posts in the same thread.
getPreferenceByCategoryAndName(String, PreferenceCategory, String) - Method in interface net.bis5.mattermost.client4.api.PreferencesApi
 
getPreferenceByCategoryAndName(String, PreferenceCategory, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the user's preferences from the provided category and preference name string.
getPreferences(String) - Method in interface net.bis5.mattermost.client4.api.PreferencesApi
 
getPreferences(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the user's preferences.
getPreferencesByCategory(String, PreferenceCategory) - Method in interface net.bis5.mattermost.client4.api.PreferencesApi
 
getPreferencesByCategory(String, PreferenceCategory) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the user's preferences from the provided category string.
getPreferencesRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getProfileImage(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getProfileImage(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getProfileImage(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
gets user's profile image.
getPublicChannelsByIdsForTeam(String, Collection<String>) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPublicChannelsByIdsForTeam(String, String...) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPublicChannelsByIdsForTeam(String, String...) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of public channeld based on provided team id string.
getPublicChannelsForTeam(String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPublicChannelsForTeam(String, Pager) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPublicChannelsForTeam(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
getPublicChannelsForTeam(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of public channels based on the provided team id string.
getRawResponse() - Method in class net.bis5.mattermost.client4.ApiResponse
 
getReactions(String) - Method in interface net.bis5.mattermost.client4.api.ReactionApi
 
getReactions(String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of reactions to a post.
getReactionsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getSamlCertificateStatus() - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
getSamlCertificateStatus() - Method in class net.bis5.mattermost.client4.MattermostClient
returns metadata for the SAML configuration.
getSamlMetadata() - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
getSamlMetadata() - Method in class net.bis5.mattermost.client4.MattermostClient
returns metadata for the SAML configuration.
getSamlRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getSessions(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getSessions(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getSessions(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of sessions based on the provided user id string.
getSystemRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeam(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeam(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeam(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a team based on the provided team is string/
getTeamAutoCompleteCommandsRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamByName(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamByName(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamByName(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a team based on the provided team name string.
getTeamByNameRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamImportRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamMember(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMember(String, String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMember(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a team member based on the provided team and user id strings.
getTeamMemberRoute(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamMembers(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembers(String, Pager) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembers(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembers(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns team members based on the provided team id string.
getTeamMembersByIds(String, Collection<String>) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembersByIds(String, String...) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembersByIds(String, String...) - Method in class net.bis5.mattermost.client4.MattermostClient
will return an array of team members based on the team id and a list of user ids provided.
getTeamMembersforUser(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembersForUser(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamMembersForUser(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the team member for a user.
getTeamMembersRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamsForUser(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamsForUser(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamsForUser(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of teams a user is on.
getTeamsRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getteamStats(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamStats(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamStats(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a team stats based on the team id string.
getTeamStatsRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getTeamUnread(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
getTeamUnread(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will return a TeamUnread object that contains the amount of unread messages and mentions the user has for the specified team.
getTeamUnreadForUser(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getTeamUnreadForUser(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getTeamUnreadForUser(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
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.
getTestEmailRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUser(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUser(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUser(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a user based on the provided user id string.
getUserAudits(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserAudits(String, Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserAudits(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserAudits(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of audit based on the provided user id string.
getUserByEmail(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserByEmail(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserByEmail(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a user based on the provided user email string.
getUserByEmailRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUserByUsername(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserByUsername(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUserByUsername(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a user based pn the provided user name string.
getUserByUsernameRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUserRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUsers() - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsers(Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsers(Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsers(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users on the system.
getUsersByIds(Collection<String>) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersByIds(String...) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersByIds(String...) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of users based on the provided user ids.
getUsersByUsernames(Collection<String>) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersByUsernames(String...) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersByUsernames(String...) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of users based on the provided usernames.
getUsersInChannel(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInChannel(String, Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInChannel(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInChannel(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users on a team.
getUsersInTeam(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInTeam(String, Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInTeam(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersInTeam(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users on a team.
getUsersNotInChannel(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInChannel(String, String, Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInChannel(String, String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInChannel(String, String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users on a team.
getUsersNotInTeam(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInTeam(String, Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInTeam(String, Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersNotInTeam(String, Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users who are not in a team.
getUsersRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUsersStatusesByIds(Collection<String>) - Method in interface net.bis5.mattermost.client4.api.StatusApi
 
getUsersStatusesByIds(String...) - Method in interface net.bis5.mattermost.client4.api.StatusApi
 
getUsersStatusesByIds(String...) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of users status based on the provided user ids.
getUserStatus(String) - Method in interface net.bis5.mattermost.client4.api.StatusApi
 
getUserStatus(String, String) - Method in interface net.bis5.mattermost.client4.api.StatusApi
 
getUserStatus(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a user status based on the provided user id string.
getUserStatusesRoute() - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUserStatusRoute(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
getUsersWithoutTeam() - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersWithoutTeam(Pager) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersWithoutTeam(Pager, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
getUsersWithoutTeam(Pager, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a page of users on the system that aren't on any teams.
getWebrtcToken() - Method in interface net.bis5.mattermost.client4.api.WebrtcApi
 
getWebrtcToken() - Method in class net.bis5.mattermost.client4.MattermostClient
returns a valid token, stun server and turn server with credentials to use with the Mattermost WebRTC service.

H

hasError() - Method in class net.bis5.mattermost.client4.ApiResponse
 
HEADER_AUTH - Static variable in class net.bis5.mattermost.client4.MattermostClient
 
HEADER_ETAG_CLIENT - Static variable in class net.bis5.mattermost.client4.MattermostClient
 

I

importTeam(byte[], int, String, String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
importTeam(byte[], int, String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will import an exported team from other app into a existing team.
invalidateCaches() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
invalidateCaches() - Method in class net.bis5.mattermost.client4.MattermostClient
will purge the cache and can affect the performance while is cleaning.
inviteUsersToTeam(String, Collection<String>) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
inviteUsersToTeam(String, Collection<String>) - Method in class net.bis5.mattermost.client4.MattermostClient
invite users by email to the team.

L

LdapApi - Interface in net.bis5.mattermost.client4.api
LDAP API
listAutocompleteCommands(String) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
listAutocompleteCommands(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will retrieve a list of commands available in the team.
listCommands(String) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
listCommands(String, boolean) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
listCommands(String, boolean) - Method in class net.bis5.mattermost.client4.MattermostClient
will retrieve a list of commands available in the team.
login(String, String) - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
login(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
authenticates a user by login id, which can be username, email, or some sort of SSO identifier based on server configuration, and a password.
login(LoginRequest) - Method in class net.bis5.mattermost.client4.MattermostClient
 
loginById(String, String) - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
loginById(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
authenticates a user by user id and password.
loginByLdap(String, String) - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
loginByLdap(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
authenticates a user by LDAP id and password.
LoginRequest - Class in net.bis5.mattermost.client4.model
Login request payload
LoginRequest() - Constructor for class net.bis5.mattermost.client4.model.LoginRequest
 
loginWithDevice(String, String, String) - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
loginWithDevice(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
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.
logout() - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
logout() - Method in class net.bis5.mattermost.client4.MattermostClient
terminates the current user's session.
LogsApi - Interface in net.bis5.mattermost.client4.api
Log API

M

MattermostClient - Class in net.bis5.mattermost.client4
 
MattermostClient(String) - Constructor for class net.bis5.mattermost.client4.MattermostClient
 
MattermostModelMapperProvider - Class in net.bis5.mattermost.jersey.provider
Mattermost datamodel mapper
MattermostModelMapperProvider() - Constructor for class net.bis5.mattermost.jersey.provider.MattermostModelMapperProvider
 

N

net.bis5.mattermost.client4 - package net.bis5.mattermost.client4
 
net.bis5.mattermost.client4.api - package net.bis5.mattermost.client4.api
 
net.bis5.mattermost.client4.model - package net.bis5.mattermost.client4.model
 
net.bis5.mattermost.jersey.provider - package net.bis5.mattermost.jersey.provider
 
nextPage() - Method in class net.bis5.mattermost.client4.Pager
 

O

OAuthApi - Interface in net.bis5.mattermost.client4.api
OAuth API
of(Response, Class<T>) - Static method in class net.bis5.mattermost.client4.ApiResponse
 
of(Response, GenericType<T>) - Static method in class net.bis5.mattermost.client4.ApiResponse
 
of(Response, T) - Static method in class net.bis5.mattermost.client4.ApiResponse
 
onLogin(ApiResponse<Void>) - Method in class net.bis5.mattermost.client4.MattermostClient
 
onLogout(ApiResponse<Void>) - Method in class net.bis5.mattermost.client4.MattermostClient
 

P

Pager - Class in net.bis5.mattermost.client4
Paging Options
Pager() - Constructor for class net.bis5.mattermost.client4.Pager
 
patchChannel(String, ChannelPatch) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
patchChannel(String, ChannelPatch) - Method in class net.bis5.mattermost.client4.MattermostClient
partially updates a channel.
patchPost(String, PostPatch) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
patchPost(String, PostPatch) - Method in class net.bis5.mattermost.client4.MattermostClient
partially updates a post.
patchTeam(String, TeamPatch) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
patchTeam(String, TeamPatch) - Method in class net.bis5.mattermost.client4.MattermostClient
partially updates a team.
patchUser(String, UserPatch) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
patchUser(String, UserPatch) - Method in class net.bis5.mattermost.client4.MattermostClient
partially updates a user in the system.
pinPost(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
pinPost(String) - Method in class net.bis5.mattermost.client4.MattermostClient
pin a post based on proviced post id string.
PostApi - Interface in net.bis5.mattermost.client4.api
Post API
postLog(Map<String, String>) - Method in interface net.bis5.mattermost.client4.api.LogsApi
 
postLog(Map<String, String>) - Method in class net.bis5.mattermost.client4.MattermostClient
This method is a convenience Web Service call so clients can log messages into the server-side logs.
PreferencesApi - Interface in net.bis5.mattermost.client4.api
Preferences API

Q

QueryBuilder - Class in net.bis5.mattermost.client4
Query parameter builder
QueryBuilder() - Constructor for class net.bis5.mattermost.client4.QueryBuilder
 

R

ReactionApi - Interface in net.bis5.mattermost.client4.api
Reaction API
readEntity() - Method in class net.bis5.mattermost.client4.ApiResponse
 
readError() - Method in class net.bis5.mattermost.client4.ApiResponse
 
regenCommandToken(String) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
regenCommandToken(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will create a new token if the user have the right permissions.
regenerateOAuthAppSecret(String) - Method in interface net.bis5.mattermost.client4.api.OAuthApi
 
regenerateOAuthAppSecret(String) - Method in class net.bis5.mattermost.client4.MattermostClient
regenerates the client secret for a registered OAuth 2.0 client application.
regenOutgoingHookToken(String) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
regenOutgoingHookToken(String) - Method in class net.bis5.mattermost.client4.MattermostClient
regenerate the outgoing webhook token.
reloadConfig() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
reloadConfig() - Method in class net.bis5.mattermost.client4.MattermostClient
will reload the server configuration.
removeTeamMember(TeamMember) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
removeTeamMember(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
removeTeamMember(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will remove a user from a team.
removeUserFromChannel(String, String) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
removeUserFromChannel(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will delete the channel member object for a user, effectively removing the user from a channel.
resetPassword(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
resetPassword(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
uses a recovery code to update reset a user's password.
ResetPasswordRequest - Class in net.bis5.mattermost.client4.model
Reset password request payload
ResetPasswordRequest() - Constructor for class net.bis5.mattermost.client4.model.ResetPasswordRequest
 
response - Variable in class net.bis5.mattermost.client4.ApiResponse
 
revokeSession(Session) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
revokeSession(String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
revokeSession(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
revokes a user session based on the provided user id and session id strings.
RevokeSessionRequest - Class in net.bis5.mattermost.client4.model
Revoke session request payload
RevokeSessionRequest() - Constructor for class net.bis5.mattermost.client4.model.RevokeSessionRequest
 

S

SamlApi - Interface in net.bis5.mattermost.client4.api
SAML API
samlFileToMultipart(Path, String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
saveReaction(Reaction) - Method in interface net.bis5.mattermost.client4.api.ReactionApi
 
saveReaction(Reaction) - Method in class net.bis5.mattermost.client4.MattermostClient
saves an emoji reaction for a post.
searchChannels(String, ChannelSearch) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
searchChannels(String, ChannelSearch) - Method in class net.bis5.mattermost.client4.MattermostClient
returns the channels on a team matching the provided search term.
searchPosts(String, String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
searchPosts(String, String, boolean) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
searchPosts(String, String, boolean) - Method in class net.bis5.mattermost.client4.MattermostClient
returns any posts with matching term string.
SearchPostsRequest - Class in net.bis5.mattermost.client4.model
Search posts request payload
SearchPostsRequest() - Constructor for class net.bis5.mattermost.client4.model.SearchPostsRequest
 
searchTeams(TeamSearch) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
searchTeams(TeamSearch) - Method in class net.bis5.mattermost.client4.MattermostClient
returns teams matching the provided search term.
searchUsers(UserSearch) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
searchUsers(UserSearch) - Method in class net.bis5.mattermost.client4.MattermostClient
returns a list of users based on some search criteria.
sendPasswordResetEmail(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
sendPasswordResetEmail(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will send a link for password resetting to a user with the provided email.
SendPasswordResetEmailRequest - Class in net.bis5.mattermost.client4.model
Send password reset email request payload
SendPasswordResetEmailRequest() - Constructor for class net.bis5.mattermost.client4.model.SendPasswordResetEmailRequest
 
sendVerificationEmail(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
sendVerificationEmail(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will send an email to the user with the provided email addresses, if that user exists.
SendVerificationEmailRequest - Class in net.bis5.mattermost.client4.model
Send verification email request payload
SendVerificationEmailRequest() - Constructor for class net.bis5.mattermost.client4.model.SendVerificationEmailRequest
 
setAccessToken(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
setOAuthToken(String) - Method in class net.bis5.mattermost.client4.MattermostClient
 
setProfileImage(String, Path) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
setProfileImage(String, Path) - Method in class net.bis5.mattermost.client4.MattermostClient
sets profile image of the user.
STATUS - Static variable in class net.bis5.mattermost.client4.ApiResponse
 
STATUS_OK - Static variable in class net.bis5.mattermost.client4.ApiResponse
 
StatusApi - Interface in net.bis5.mattermost.client4.api
Status API
switchAccountType(SwitchRequest) - Method in interface net.bis5.mattermost.client4.api.AuthenticationApi
 
switchAccountType(SwitchRequest) - Method in class net.bis5.mattermost.client4.MattermostClient
changes a user's login type from one type to another.
SwitchAccountTypeResult - Class in net.bis5.mattermost.client4.model
Switch account type request payload
SwitchAccountTypeResult() - Constructor for class net.bis5.mattermost.client4.model.SwitchAccountTypeResult
 
syncLdap() - Method in interface net.bis5.mattermost.client4.api.LdapApi
 
syncLdap() - Method in class net.bis5.mattermost.client4.MattermostClient
will force a sync with the configured LDAP server.

T

TeamApi - Interface in net.bis5.mattermost.client4.api
Team API
teamExists(String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
teamExists(String, String) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
teamExists(String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
returns true or false if the team exist or not.
testEmail() - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
testEmail() - Method in class net.bis5.mattermost.client4.MattermostClient
will attempt to connect to the configured SMTP server.
testLdap() - Method in interface net.bis5.mattermost.client4.api.LdapApi
 
testLdap() - Method in class net.bis5.mattermost.client4.MattermostClient
will attempt to connect to the configured LDAP server and return OK if configured correctly.
toQuery() - Method in class net.bis5.mattermost.client4.Pager
 
toQuery(boolean) - Method in class net.bis5.mattermost.client4.Pager
 
toString() - Method in class net.bis5.mattermost.client4.QueryBuilder
 

U

unpinPost(String) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
unpinPost(String) - Method in class net.bis5.mattermost.client4.MattermostClient
unpin a post based on provided post id string.
updateChannel(Channel) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
updateChannel(Channel) - Method in class net.bis5.mattermost.client4.MattermostClient
update a channel based on the provided channel object.
updateChannelNotifyProps(String, String, Map<String, String>) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
updateChannelNotifyProps(String, String, Map<String, String>) - Method in class net.bis5.mattermost.client4.MattermostClient
will update the notification properties on a channel for a user.
updateChannelRoles(String, String, Collection<Role>) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
updateChannelRoles(String, String, Role...) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
updateChannelRoles(String, String, Role...) - Method in class net.bis5.mattermost.client4.MattermostClient
will update the roles on a channel for a user.
updateCommand(Command) - Method in interface net.bis5.mattermost.client4.api.CommandsApi
 
updateCommand(Command) - Method in class net.bis5.mattermost.client4.MattermostClient
updates a command based on the provided Command object.
updateConfig(Config) - Method in interface net.bis5.mattermost.client4.api.GeneralApi
 
updateConfig(Config) - Method in class net.bis5.mattermost.client4.MattermostClient
will update the server configuration.
updateIncomingWebhook(IncomingWebhook) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
updateIncomingWebhook(IncomingWebhook) - Method in class net.bis5.mattermost.client4.MattermostClient
updates an incoming webhook for a channel.
updateOutgoingWebhook(OutgoingWebhook) - Method in interface net.bis5.mattermost.client4.api.WebhookApi
 
updateOutgoingWebhook(OutgoingWebhook) - Method in class net.bis5.mattermost.client4.MattermostClient
updates an outgoing webhook.
updatePost(Post) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
updatePost(String, Post) - Method in interface net.bis5.mattermost.client4.api.PostApi
 
updatePost(String, Post) - Method in class net.bis5.mattermost.client4.MattermostClient
updates a post based on the provided post object.
updatePreferences(String, Preferences) - Method in interface net.bis5.mattermost.client4.api.PreferencesApi
 
updatePreferences(String, Preferences) - Method in class net.bis5.mattermost.client4.MattermostClient
saves the user's preferences.
UpdateRolesRequest - Class in net.bis5.mattermost.client4.model
Update user roles request payload
UpdateRolesRequest(Role...) - Constructor for class net.bis5.mattermost.client4.model.UpdateRolesRequest
 
updateTeam(Team) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
updateTeam(Team) - Method in class net.bis5.mattermost.client4.MattermostClient
will update a team.
updateTeamMemberRoles(String, String, Collection<Role>) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
updateTeamMemberRoles(String, String, Role...) - Method in interface net.bis5.mattermost.client4.api.TeamApi
 
updateTeamMemberRoles(String, String, Role...) - Method in class net.bis5.mattermost.client4.MattermostClient
will update the roles on a team for a user.
updateUser(User) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUser(User) - Method in class net.bis5.mattermost.client4.MattermostClient
updates a user in the system based on the provided user object.
updateUserActive(String, boolean) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUserActive(String, boolean) - Method in class net.bis5.mattermost.client4.MattermostClient
updates status of a user whether active or not.
UpdateUserActiveRequest - Class in net.bis5.mattermost.client4.model
Update user active request payload
UpdateUserActiveRequest() - Constructor for class net.bis5.mattermost.client4.model.UpdateUserActiveRequest
 
updateUserMfa(String, String, boolean) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUserMfa(String, String, boolean) - Method in class net.bis5.mattermost.client4.MattermostClient
activates multi-factor authentication for a user if activate is true and a valid code is provided.
UpdateUserMfaRequest - Class in net.bis5.mattermost.client4.model
Update user MFA request payload
UpdateUserMfaRequest() - Constructor for class net.bis5.mattermost.client4.model.UpdateUserMfaRequest
 
updateUserPassword(String, String, String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUserPassword(String, String, String) - Method in class net.bis5.mattermost.client4.MattermostClient
updates a user's password.
UpdateUserPasswordRequest - Class in net.bis5.mattermost.client4.model
Update user password request payload
UpdateUserPasswordRequest() - Constructor for class net.bis5.mattermost.client4.model.UpdateUserPasswordRequest
 
updateUserRoles(String, Collection<Role>) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUserRoles(String, Role...) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
updateUserRoles(String, Role...) - Method in class net.bis5.mattermost.client4.MattermostClient
updates a user's roles in the system.
updateUserStatus(String, Status) - Method in interface net.bis5.mattermost.client4.api.StatusApi
 
updateUserStatus(String, Status) - Method in class net.bis5.mattermost.client4.MattermostClient
sets a user's status based on the provided user id string.
uploadBrandImage(Path) - Method in interface net.bis5.mattermost.client4.api.BrandApi
 
uploadBrandImage(Path) - Method in class net.bis5.mattermost.client4.MattermostClient
sets the brand image for the system.
uploadSamlIdpCertificate(Path, String) - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
uploadSamlIdpCertificate(Path, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will upload an IDP certificate for SAML and set the config to use it.
uploadSamlPrivateCertificate(Path, String) - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
uploadSamlPrivateCertificate(Path, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will upload a private key for SAML and set the config to use it.
uploadSamlPublicCertificate(Path, String) - Method in interface net.bis5.mattermost.client4.api.SamlApi
 
uploadSamlPublicCertificate(Path, String) - Method in class net.bis5.mattermost.client4.MattermostClient
will upload a public certificate for SAML and set the config to use it.
UserApi - Interface in net.bis5.mattermost.client4.api
User API

V

valueOf(String) - Static method in enum net.bis5.mattermost.client4.AuthType
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.bis5.mattermost.client4.AuthType
Returns an array containing the constants of this enum type, in the order they are declared.
verifyUserEmail(String) - Method in interface net.bis5.mattermost.client4.api.UserApi
 
verifyUserEmail(String) - Method in class net.bis5.mattermost.client4.MattermostClient
will verify a user's email using the supplied token.
VerifyUserEmailRequest - Class in net.bis5.mattermost.client4.model
Verify user email request payload
VerifyUserEmailRequest() - Constructor for class net.bis5.mattermost.client4.model.VerifyUserEmailRequest
 
viewChannel(String, ChannelView) - Method in interface net.bis5.mattermost.client4.api.ChannelApi
 
viewChannel(String, ChannelView) - Method in class net.bis5.mattermost.client4.MattermostClient
performs a view action for a user.

W

WebhookApi - Interface in net.bis5.mattermost.client4.api
Webhook API
WebrtcApi - Interface in net.bis5.mattermost.client4.api
WebRTC API
A B C D E G H I L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2018. All rights reserved.