public interface TeamApi
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<TeamMember> |
addTeamMember(String hash,
String dataToHash,
String inviteId)
adds user to a team and return a team member.
|
ApiResponse<TeamMember> |
addTeamMember(String teamId,
String userId,
String hash,
String dataToHash,
String inviteId)
Deprecated.
API Change on Mattermost 4.0
|
ApiResponse<TeamMember> |
addTeamMember(TeamMember teamMemberToAdd)
add user to a team and return a team member.
|
default ApiResponse<TeamMemberList> |
addTeamMembers(String teamId,
Collection<String> userIds)
adds a number of users to a team and returns the team members.
|
ApiResponse<TeamMemberList> |
addTeamMembers(String teamId,
String... userIds)
adds a number of users to a team and returns the team members.
|
ApiResponse<Team> |
createTeam(Team team)
creates a team in the system based on the provided team object.
|
default ApiResponse<Boolean> |
deleteTeam(String teamId)
deletes the team softly (archive only, not permanent delete).
|
ApiResponse<Boolean> |
deleteTeam(String teamId,
boolean permanent)
deletes the team.
|
default ApiResponse<TeamList> |
getAllTeams()
returns all teams based on permssions.
|
default ApiResponse<TeamList> |
getAllTeams(Pager pager)
returns all teams based on permssions.
|
ApiResponse<TeamList> |
getAllTeams(Pager pager,
String etag)
returns all teams based on permssions.
|
ApiResponse<TeamInviteInfo> |
getInviteInfo(String inviteId)
get team info by invite id.
|
default ApiResponse<Team> |
getTeam(String teamId)
returns a team based on the provided team id string.
|
ApiResponse<Team> |
getTeam(String teamId,
String etag)
returns a team based on the provided team id string.
|
default ApiResponse<Team> |
getTeamByName(String name)
returns a team based on the provided team name string.
|
ApiResponse<Team> |
getTeamByName(String name,
String etag)
returns a team based on the provided team name string.
|
ApiResponse<Path> |
getTeamIcon(String teamId)
Get the team icon image.
|
default ApiResponse<TeamMember> |
getTeamMember(String teamId,
String userId)
returns a team member based on the provided team and user id strings.
|
ApiResponse<TeamMember> |
getTeamMember(String teamId,
String userId,
String etag)
returns a team member based on the provided team and user id strings.
|
default ApiResponse<TeamMemberList> |
getTeamMembers(String teamId)
returns team members based on the provided team id string.
|
default ApiResponse<TeamMemberList> |
getTeamMembers(String teamId,
Pager pager)
returns team members based on the provided team id string.
|
ApiResponse<TeamMemberList> |
getTeamMembers(String teamId,
Pager pager,
String etag)
returns team members based on the provided team id string.
|
default ApiResponse<TeamMemberList> |
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> |
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> |
getTeamMembersforUser(String userId)
returns the team member for a user.
|
ApiResponse<TeamMemberList> |
getTeamMembersForUser(String userId,
String etag)
returns the team member for a user.
|
default ApiResponse<TeamList> |
getTeamsForUser(String userId)
returns a list of teams a user is on.
|
ApiResponse<TeamList> |
getTeamsForUser(String userId,
String etag)
returns a list of teams a user is on.
|
default ApiResponse<TeamStats> |
getteamStats(String teamId)
returns a team stats based on the team id string.
|
ApiResponse<TeamStats> |
getTeamStats(String teamId,
String etag)
returns a team stats based on the team id string.
|
ApiResponse<TeamUnread> |
getTeamUnread(String teamId,
String userId)
will return a TeamUnread object that contains the amount of unread messages and mentions the
user has for the specified team.
|
ApiResponse<byte[]> |
importTeam(byte[] data,
int filesize,
String importFrom,
String fileName,
String teamId)
will import an exported team from other app into a existing team.
|
ApiResponse<Boolean> |
inviteUsersToTeam(String teamId,
Collection<String> userEmails)
invite users by email to the team.
|
ApiResponse<Team> |
patchTeam(String teamId,
TeamPatch patch)
partially updates a team.
|
ApiResponse<Boolean> |
removeTeamIcon(String teamId)
Remove the team icon.
|
ApiResponse<Boolean> |
removeTeamMember(String teamId,
String userId)
will remove a user from a team.
|
default ApiResponse<Boolean> |
removeTeamMember(TeamMember teamMember)
will remove a user from a team.
|
ApiResponse<TeamList> |
searchTeams(TeamSearch search)
returns teams matching the provided search term.
|
ApiResponse<Boolean> |
setTeamIcon(String teamId,
Path iconFilePath)
Set the team icon.
|
default ApiResponse<TeamExists> |
teamExists(String name)
returns true or false if the team exist or not.
|
ApiResponse<TeamExists> |
teamExists(String name,
String etag)
returns true or false if the team exist or not.
|
ApiResponse<Team> |
updateTeam(Team team)
will update a team.
|
default ApiResponse<Boolean> |
updateTeamMemberRoles(String teamId,
String userId,
Collection<Role> newRoles)
will update the roles on a team for a user.
|
ApiResponse<Boolean> |
updateTeamMemberRoles(String teamId,
String userId,
Role... newROles)
will update the roles on a team for a user.
|
ApiResponse<Team> createTeam(Team team)
default ApiResponse<Team> getTeam(String teamId)
ApiResponse<Team> getTeam(String teamId, String etag)
default ApiResponse<TeamList> getAllTeams()
default ApiResponse<TeamList> getAllTeams(Pager pager)
ApiResponse<TeamList> getAllTeams(Pager pager, String etag)
default ApiResponse<Team> getTeamByName(String name)
ApiResponse<Team> getTeamByName(String name, String etag)
ApiResponse<TeamList> searchTeams(TeamSearch search)
default ApiResponse<TeamExists> teamExists(String name)
ApiResponse<TeamExists> teamExists(String name, String etag)
default ApiResponse<TeamList> getTeamsForUser(String userId)
ApiResponse<TeamList> getTeamsForUser(String userId, String etag)
default ApiResponse<TeamMember> getTeamMember(String teamId, String userId)
ApiResponse<TeamMember> getTeamMember(String teamId, String userId, String etag)
default ApiResponse<Boolean> updateTeamMemberRoles(String teamId, String userId, Collection<Role> newRoles)
ApiResponse<Boolean> updateTeamMemberRoles(String teamId, String userId, Role... newROles)
ApiResponse<Team> updateTeam(Team team)
ApiResponse<Team> patchTeam(String teamId, TeamPatch patch)
default ApiResponse<Boolean> deleteTeam(String teamId)
deleteTeam(String, boolean)ApiResponse<Boolean> deleteTeam(String teamId, boolean permanent)
permanent - true: Permanently delete the team, to be used for compliance reasons
only.deleteTeam(String)default ApiResponse<TeamMemberList> getTeamMembers(String teamId)
default ApiResponse<TeamMemberList> getTeamMembers(String teamId, Pager pager)
ApiResponse<TeamMemberList> getTeamMembers(String teamId, Pager pager, String etag)
default ApiResponse<TeamMemberList> getTeamMembersforUser(String userId)
ApiResponse<TeamMemberList> getTeamMembersForUser(String userId, String etag)
default ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId, Collection<String> userIds)
ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId, String... userIds)
ApiResponse<TeamMember> addTeamMember(TeamMember teamMemberToAdd)
@Deprecated ApiResponse<TeamMember> addTeamMember(String teamId, String userId, String hash, String dataToHash, String inviteId)
ApiResponse<TeamMember> addTeamMember(String hash, String dataToHash, String inviteId)
default ApiResponse<TeamMemberList> addTeamMembers(String teamId, Collection<String> userIds)
ApiResponse<TeamMemberList> addTeamMembers(String teamId, String... userIds)
default ApiResponse<Boolean> removeTeamMember(TeamMember teamMember)
ApiResponse<Boolean> removeTeamMember(String teamId, String userId)
default ApiResponse<TeamStats> getteamStats(String teamId)
ApiResponse<TeamStats> getTeamStats(String teamId, String etag)
ApiResponse<Path> getTeamIcon(String teamId) throws IOException
IOExceptionApiResponse<Boolean> setTeamIcon(String teamId, Path iconFilePath)
ApiResponse<Boolean> removeTeamIcon(String teamId)
ApiResponse<TeamUnread> getTeamUnread(String teamId, String userId)
ApiResponse<byte[]> importTeam(byte[] data, int filesize, String importFrom, String fileName, String teamId)
ApiResponse<Boolean> inviteUsersToTeam(String teamId, Collection<String> userEmails)
ApiResponse<TeamInviteInfo> getInviteInfo(String inviteId)
Copyright © 2019. All rights reserved.