net.bis5.mattermost.client4.api

Interface TeamApi

All Known Implementing Classes:

MattermostClient

public interface TeamApi

Team API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<TeamMember>	addTeamMember(String hash, String dataToHash, String inviteId)
ApiResponse<TeamMember>	addTeamMember(String teamId, String userId, String hash, String dataToHash, String inviteId) Deprecated.
ApiResponse<TeamMember>	addTeamMember(TeamMember teamMemberToAdd)
default ApiResponse<TeamMemberList>	addTeamMembers(String teamId, Collection<String> userIds)
ApiResponse<TeamMemberList>	addTeamMembers(String teamId, String... userIds)
ApiResponse<Team>	createTeam(Team team)
default ApiResponse<Boolean>	deleteTeam(String teamId)
ApiResponse<Boolean>	deleteTeam(String teamId, boolean permanent)
default ApiResponse<TeamList>	getAllTeams()
default ApiResponse<TeamList>	getAllTeams(Pager pager)
ApiResponse<TeamList>	getAllTeams(Pager pager, String etag)
default ApiResponse<Team>	getTeam(String teamId)
ApiResponse<Team>	getTeam(String teamId, String etag)
default ApiResponse<Team>	getTeamByName(String name)
ApiResponse<Team>	getTeamByName(String name, String etag)
default ApiResponse<TeamMember>	getTeamMember(String teamId, String userId)
ApiResponse<TeamMember>	getTeamMember(String teamId, String userId, String etag)
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>	getTeamMembersByIds(String teamId, Collection<String> userIds)
ApiResponse<TeamMemberList>	getTeamMembersByIds(String teamId, String... userIds)
default ApiResponse<TeamMemberList>	getTeamMembersforUser(String userId)
ApiResponse<TeamMemberList>	getTeamMembersForUser(String userId, String etag)
default ApiResponse<TeamList>	getTeamsForUser(String userId)
ApiResponse<TeamList>	getTeamsForUser(String userId, String etag)
default ApiResponse<TeamStats>	getteamStats(String teamId)
ApiResponse<TeamStats>	getTeamStats(String teamId, String etag)
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<Team>	patchTeam(String teamId, TeamPatch patch)
ApiResponse<Boolean>	removeTeamMember(String teamId, String userId)
default ApiResponse<Boolean>	removeTeamMember(TeamMember teamMember)
ApiResponse<TeamList>	searchTeams(TeamSearch search)
default ApiResponse<TeamExists>	teamExists(String name)
ApiResponse<TeamExists>	teamExists(String name, String etag)
ApiResponse<Team>	updateTeam(Team team)
default ApiResponse<Boolean>	updateTeamMemberRoles(String teamId, String userId, Collection<Role> newRoles)
ApiResponse<Boolean>	updateTeamMemberRoles(String teamId, String userId, Role... newROles)

Method Detail

createTeam

ApiResponse<Team> createTeam(Team team)

getTeam

default ApiResponse<Team> getTeam(String teamId)

getTeam

ApiResponse<Team> getTeam(String teamId,
                          String etag)

getAllTeams

default ApiResponse<TeamList> getAllTeams()

getAllTeams

default ApiResponse<TeamList> getAllTeams(Pager pager)

getAllTeams

ApiResponse<TeamList> getAllTeams(Pager pager,
                                  String etag)

getTeamByName

default ApiResponse<Team> getTeamByName(String name)

getTeamByName

ApiResponse<Team> getTeamByName(String name,
                                String etag)

searchTeams

ApiResponse<TeamList> searchTeams(TeamSearch search)

teamExists

default ApiResponse<TeamExists> teamExists(String name)

teamExists

ApiResponse<TeamExists> teamExists(String name,
                                   String etag)

getTeamsForUser

default ApiResponse<TeamList> getTeamsForUser(String userId)

getTeamsForUser

ApiResponse<TeamList> getTeamsForUser(String userId,
                                      String etag)

getTeamMember

default ApiResponse<TeamMember> getTeamMember(String teamId,
                                              String userId)

getTeamMember

ApiResponse<TeamMember> getTeamMember(String teamId,
                                      String userId,
                                      String etag)

updateTeamMemberRoles

default ApiResponse<Boolean> updateTeamMemberRoles(String teamId,
                                                   String userId,
                                                   Collection<Role> newRoles)

updateTeamMemberRoles

ApiResponse<Boolean> updateTeamMemberRoles(String teamId,
                                           String userId,
                                           Role... newROles)

updateTeam

ApiResponse<Team> updateTeam(Team team)

patchTeam

ApiResponse<Team> patchTeam(String teamId,
                            TeamPatch patch)

deleteTeam

default ApiResponse<Boolean> deleteTeam(String teamId)

deleteTeam

ApiResponse<Boolean> deleteTeam(String teamId,
                                boolean permanent)

getTeamMembers

default ApiResponse<TeamMemberList> getTeamMembers(String teamId)

getTeamMembers

default ApiResponse<TeamMemberList> getTeamMembers(String teamId,
                                                   Pager pager)

getTeamMembers

ApiResponse<TeamMemberList> getTeamMembers(String teamId,
                                           Pager pager,
                                           String etag)

getTeamMembersforUser

default ApiResponse<TeamMemberList> getTeamMembersforUser(String userId)

getTeamMembersForUser

ApiResponse<TeamMemberList> getTeamMembersForUser(String userId,
                                                  String etag)

getTeamMembersByIds

default ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId,
                                                        Collection<String> userIds)

getTeamMembersByIds

ApiResponse<TeamMemberList> getTeamMembersByIds(String teamId,
                                                String... userIds)

addTeamMember

ApiResponse<TeamMember> addTeamMember(TeamMember teamMemberToAdd)

addTeamMember

@Deprecated
ApiResponse<TeamMember> addTeamMember(String teamId,
                                                  String userId,
                                                  String hash,
                                                  String dataToHash,
                                                  String inviteId)

Deprecated.

addTeamMember

ApiResponse<TeamMember> addTeamMember(String hash,
                                      String dataToHash,
                                      String inviteId)

addTeamMembers

default ApiResponse<TeamMemberList> addTeamMembers(String teamId,
                                                   Collection<String> userIds)

addTeamMembers

ApiResponse<TeamMemberList> addTeamMembers(String teamId,
                                           String... userIds)

removeTeamMember

default ApiResponse<Boolean> removeTeamMember(TeamMember teamMember)

removeTeamMember

ApiResponse<Boolean> removeTeamMember(String teamId,
                                      String userId)

getteamStats

default ApiResponse<TeamStats> getteamStats(String teamId)

getTeamStats

ApiResponse<TeamStats> getTeamStats(String teamId,
                                    String etag)

getTeamUnread

ApiResponse<TeamUnread> getTeamUnread(String teamId,
                                      String userId)

importTeam

ApiResponse<byte[]> importTeam(byte[] data,
                               int filesize,
                               String importFrom,
                               String fileName,
                               String teamId)

inviteUsersToTeam

ApiResponse<Boolean> inviteUsersToTeam(String teamId,
                                       Collection<String> userEmails)