net.bis5.mattermost.client4.api

Interface UserApi

All Known Implementing Classes:

MattermostClient

public interface UserApi

User API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<Boolean>	attachDeviceId(String deviceId)
default ApiResponse<UserAutocomplete>	autocompleteUsers(String username)
ApiResponse<UserAutocomplete>	autocompleteUsers(String username, String etag)
default ApiResponse<UserAutocomplete>	autocompleteUsersInChannel(String teamId, String channelId, String username)
ApiResponse<UserAutocomplete>	autocompleteUsersInChannel(String teamId, String channelId, String username, String etag)
default ApiResponse<UserAutocomplete>	autocompleteUsersInTeam(String teamId, String username)
ApiResponse<UserAutocomplete>	autocompleteUsersInTeam(String teamId, String username, String etag)
boolean	checkUserMfa(String loginId)
ApiResponse<User>	createUser(User user)
ApiResponse<UserAccessToken>	createUserAccessToken(String userId, String description)
ApiResponse<Boolean>	deleteUser(String userId)
ApiResponse<Boolean>	disableUserAccessToken(String tokenId)
ApiResponse<Boolean>	enableUserAccessToken(String tokenId)
ApiResponse<MfaSecret>	generateMfaSecret(String userId)
default ApiResponse<User>	getMe()
ApiResponse<User>	getMe(String etag)
default ApiResponse<byte[]>	getProfileImage(String userId)
ApiResponse<byte[]>	getProfileImage(String userId, String etag)
default ApiResponse<SessionList>	getSessions(String userId)
ApiResponse<SessionList>	getSessions(String userId, String etag)
default ApiResponse<TeamUnreadList>	getTeamUnreadForUser(String userId)
ApiResponse<TeamUnreadList>	getTeamUnreadForUser(String userId, String teamIdToExclude)
default ApiResponse<User>	getUser(String userId)
ApiResponse<User>	getUser(String userId, String etag)
ApiResponse<UserAccessToken>	getUserAccessToken(String tokenId)
default ApiResponse<UserAccessTokenList>	getUserAccessTokens(String userId)
ApiResponse<UserAccessTokenList>	getUserAccessTokens(String userId, Pager pager)
default ApiResponse<UserAccessTokenList>	getUserAccessTokensAllUsers()
ApiResponse<UserAccessTokenList>	getUserAccessTokensAllUsers(Pager pager)
default ApiResponse<Audits>	getUserAudits(String userId)
default ApiResponse<Audits>	getUserAudits(String userId, Pager pager)
ApiResponse<Audits>	getUserAudits(String userId, Pager pager, String etag)
default ApiResponse<User>	getUserByEmail(String email)
ApiResponse<User>	getUserByEmail(String email, String etag)
default ApiResponse<User>	getUserByUsername(String username)
ApiResponse<User>	getUserByUsername(String username, String etag)
default ApiResponse<UserList>	getUsers()
default ApiResponse<UserList>	getUsers(Pager pager)
ApiResponse<UserList>	getUsers(Pager pager, String etag)
default ApiResponse<UserList>	getUsersByIds(Collection<String> userIds)
ApiResponse<UserList>	getUsersByIds(String... userIds)
default ApiResponse<UserList>	getUsersByUsernames(Collection<String> usernames)
ApiResponse<UserList>	getUsersByUsernames(String... usernames)
default ApiResponse<UserList>	getUsersInChannel(String channelId)
default ApiResponse<UserList>	getUsersInChannel(String channelId, Pager pager)
default ApiResponse<UserList>	getUsersInChannel(String channelId, Pager pager, String etag)
default ApiResponse<UserList>	getUsersInChannel(String channelId, UsersOrder.InChannel order, Pager pager)
ApiResponse<UserList>	getUsersInChannel(String channelId, UsersOrder.InChannel order, Pager pager, String etag)
default ApiResponse<UserList>	getUsersInTeam(String teamId)
default ApiResponse<UserList>	getUsersInTeam(String teamId, Pager pager)
default ApiResponse<UserList>	getUsersInTeam(String teamId, Pager pager, String etag)
default ApiResponse<UserList>	getUsersInTeam(String teamId, UsersOrder.InTeam order, Pager pager)
ApiResponse<UserList>	getUsersInTeam(String teamId, UsersOrder.InTeam order, Pager pager, String etag)
default ApiResponse<UserList>	getUsersNotInChannel(String teamId, String channelId)
default ApiResponse<UserList>	getUsersNotInChannel(String teamId, String channelId, Pager pager)
ApiResponse<UserList>	getUsersNotInChannel(String teamId, String channelId, Pager pager, String etag)
default ApiResponse<UserList>	getUsersNotInTeam(String teamId)
default ApiResponse<UserList>	getUsersNotInTeam(String teamId, Pager pager)
ApiResponse<UserList>	getUsersNotInTeam(String teamId, Pager pager, String etag)
default ApiResponse<UserList>	getUsersWithoutTeam()
default ApiResponse<UserList>	getUsersWithoutTeam(Pager pager)
ApiResponse<UserList>	getUsersWithoutTeam(Pager pager, String etag)
ApiResponse<User>	patchUser(String userId, UserPatch patch)
ApiResponse<Boolean>	resetPassword(String token, String newPassword)
default ApiResponse<Boolean>	revokeSession(Session session)
ApiResponse<Boolean>	revokeSession(String userId, String sessionId)
ApiResponse<Boolean>	revokeUserAccessToken(String tokenId)
ApiResponse<UserAccessTokenList>	searchTokens(String term)
ApiResponse<UserList>	searchUsers(UserSearch search)
ApiResponse<Boolean>	sendPasswordResetEmail(String email)
ApiResponse<Boolean>	sendVerificationEmail(String email)
ApiResponse<Boolean>	setProfileImage(String userId, Path imageFilePath)
ApiResponse<User>	updateUser(User user)
ApiResponse<Boolean>	updateUserActive(String userId, boolean active)
ApiResponse<Boolean>	updateUserMfa(String userId, String code, boolean activate)
ApiResponse<Boolean>	updateUserPassword(String userId, String currentPassword, String newPassword)
default ApiResponse<Boolean>	updateUserRoles(String userId, Collection<Role> roles)
ApiResponse<Boolean>	updateUserRoles(String userId, Role... roles)
ApiResponse<Boolean>	verifyUserEmail(String token)

Method Detail

createUser

ApiResponse<User> createUser(User user)

getMe

default ApiResponse<User> getMe()

getMe

ApiResponse<User> getMe(String etag)

getUser

default ApiResponse<User> getUser(String userId)

getUser

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

getUserByUsername

default ApiResponse<User> getUserByUsername(String username)

getUserByUsername

ApiResponse<User> getUserByUsername(String username,
                                    String etag)

getUserByEmail

default ApiResponse<User> getUserByEmail(String email)

getUserByEmail

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

autocompleteUsersInTeam

default ApiResponse<UserAutocomplete> autocompleteUsersInTeam(String teamId,
                                                              String username)

autocompleteUsersInTeam

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

autocompleteUsersInChannel

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

autocompleteUsersInChannel

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

autocompleteUsers

default ApiResponse<UserAutocomplete> autocompleteUsers(String username)

autocompleteUsers

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

getProfileImage

default ApiResponse<byte[]> getProfileImage(String userId)

getProfileImage

ApiResponse<byte[]> getProfileImage(String userId,
                                    String etag)

getUsers

default ApiResponse<UserList> getUsers()

getUsers

default ApiResponse<UserList> getUsers(Pager pager)

getUsers

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

getUsersInTeam

default ApiResponse<UserList> getUsersInTeam(String teamId)

getUsersInTeam

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

getUsersInTeam

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

getUsersInTeam

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

getUsersInTeam

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

getUsersNotInTeam

default ApiResponse<UserList> getUsersNotInTeam(String teamId)

getUsersNotInTeam

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

getUsersNotInTeam

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

getUsersInChannel

default ApiResponse<UserList> getUsersInChannel(String channelId)

getUsersInChannel

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

getUsersInChannel

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

getUsersInChannel

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

getUsersInChannel

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

getUsersNotInChannel

default ApiResponse<UserList> getUsersNotInChannel(String teamId,
                                                   String channelId)

getUsersNotInChannel

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

getUsersNotInChannel

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

getUsersWithoutTeam

default ApiResponse<UserList> getUsersWithoutTeam()

getUsersWithoutTeam

default ApiResponse<UserList> getUsersWithoutTeam(Pager pager)

getUsersWithoutTeam

ApiResponse<UserList> getUsersWithoutTeam(Pager pager,
                                          String etag)

getUsersByIds

default ApiResponse<UserList> getUsersByIds(Collection<String> userIds)

getUsersByIds

ApiResponse<UserList> getUsersByIds(String... userIds)

getUsersByUsernames

default ApiResponse<UserList> getUsersByUsernames(Collection<String> usernames)

getUsersByUsernames

ApiResponse<UserList> getUsersByUsernames(String... usernames)

searchUsers

ApiResponse<UserList> searchUsers(UserSearch search)

updateUser

ApiResponse<User> updateUser(User user)

patchUser

ApiResponse<User> patchUser(String userId,
                            UserPatch patch)

updateUserMfa

ApiResponse<Boolean> updateUserMfa(String userId,
                                   String code,
                                   boolean activate)

checkUserMfa

boolean checkUserMfa(String loginId)

generateMfaSecret

ApiResponse<MfaSecret> generateMfaSecret(String userId)

updateUserPassword

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

updateUserRoles

default ApiResponse<Boolean> updateUserRoles(String userId,
                                             Collection<Role> roles)

updateUserRoles

ApiResponse<Boolean> updateUserRoles(String userId,
                                     Role... roles)

updateUserActive

ApiResponse<Boolean> updateUserActive(String userId,
                                      boolean active)

deleteUser

ApiResponse<Boolean> deleteUser(String userId)

sendPasswordResetEmail

ApiResponse<Boolean> sendPasswordResetEmail(String email)

resetPassword

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

getSessions

default ApiResponse<SessionList> getSessions(String userId)

getSessions

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

revokeSession

default ApiResponse<Boolean> revokeSession(Session session)

revokeSession

ApiResponse<Boolean> revokeSession(String userId,
                                   String sessionId)

attachDeviceId

ApiResponse<Boolean> attachDeviceId(String deviceId)

getTeamUnreadForUser

default ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId)

getTeamUnreadForUser

ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId,
                                                 String teamIdToExclude)

getUserAudits

default ApiResponse<Audits> getUserAudits(String userId)

getUserAudits

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

getUserAudits

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

verifyUserEmail

ApiResponse<Boolean> verifyUserEmail(String token)

sendVerificationEmail

ApiResponse<Boolean> sendVerificationEmail(String email)

setProfileImage

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

createUserAccessToken

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

getUserAccessTokens

default ApiResponse<UserAccessTokenList> getUserAccessTokens(String userId)

getUserAccessTokens

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

getUserAccessTokensAllUsers

default ApiResponse<UserAccessTokenList> getUserAccessTokensAllUsers()

getUserAccessTokensAllUsers

ApiResponse<UserAccessTokenList> getUserAccessTokensAllUsers(Pager pager)

revokeUserAccessToken

ApiResponse<Boolean> revokeUserAccessToken(String tokenId)

getUserAccessToken

ApiResponse<UserAccessToken> getUserAccessToken(String tokenId)

disableUserAccessToken

ApiResponse<Boolean> disableUserAccessToken(String tokenId)

enableUserAccessToken

ApiResponse<Boolean> enableUserAccessToken(String tokenId)

searchTokens

ApiResponse<UserAccessTokenList> searchTokens(String term)