Module net.bis5.mattermost4j.core

Package 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	Description
ApiResponse<TeamMember>	addTeamMember(String hash, String dataToHash, String inviteId)	Deprecated. API Changed on Mattermost 4.10
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.
ApiResponse<TeamMember>	addTeamMemberFromInvite(String token, String inviteId)	add user to team from invite.
ApiResponse<TeamMemberList>	addTeamMembers(String teamId, String... userIds)	adds a number of users to a team and returns the team members.
default ApiResponse<TeamMemberList>	addTeamMembers(String teamId, Collection<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.
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>	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.
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.

Method Detail

createTeam

ApiResponse<Team> createTeam(Team team)

creates a team in the system based on the provided team object.

getTeam

default ApiResponse<Team> getTeam(String teamId)

returns a team based on the provided team id string.

getTeam

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

returns a team based on the provided team id string.

getAllTeams

default ApiResponse<TeamList> getAllTeams()

returns all teams based on permssions.

getAllTeams

default ApiResponse<TeamList> getAllTeams(Pager pager)

returns all teams based on permssions.

getAllTeams

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

returns all teams based on permssions.

getTeamByName

default ApiResponse<Team> getTeamByName(String name)

returns a team based on the provided team name string.

getTeamByName

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

returns a team based on the provided team name string.

searchTeams

ApiResponse<TeamList> searchTeams(TeamSearch search)

returns teams matching the provided search term.

teamExists

default ApiResponse<TeamExists> teamExists(String name)

returns true or false if the team exist or not.

teamExists

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

returns true or false if the team exist or not.

getTeamsForUser

default ApiResponse<TeamList> getTeamsForUser(String userId)

returns a list of teams a user is on. Must be logged in as the user or be a system administrator.

getTeamsForUser

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

returns a list of teams a user is on. Must be logged in as the user or be a system administrator.

getTeamMember

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

returns a team member based on the provided team and user id strings.

getTeamMember

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

returns a team member based on the provided team and user id strings.

updateTeamMemberRoles

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

will update the roles on a team for a user.

updateTeamMemberRoles

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

will update the roles on a team for a user.

updateTeam

ApiResponse<Team> updateTeam(Team team)

will update a team.

patchTeam

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

partially updates a team. Any missing fields are not updated.

deleteTeam

default ApiResponse<Boolean> deleteTeam(String teamId)

deletes the team softly (archive only, not permanent delete).

See Also:

deleteTeam(String, boolean)

deleteTeam

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

deletes the team.

Parameters:

permanent - true: Permanently delete the team, to be used for compliance reasons only.

See Also:

deleteTeam(String)

getTeamMembers

default ApiResponse<TeamMemberList> getTeamMembers(String teamId)

returns team members based on the provided team id string.

getTeamMembers

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

returns team members based on the provided team id string.

getTeamMembers

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

returns team members based on the provided team id string.

getTeamMembersForUser

default ApiResponse<TeamMemberList> getTeamMembersForUser(String userId)

returns the team member for a user.

getTeamMembersForUser

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

returns the team member for a user.

getTeamMembersByIds

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. Must be authenticated.

getTeamMembersByIds

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. Must be authenticated.

addTeamMember

ApiResponse<TeamMember> addTeamMember(TeamMember teamMemberToAdd)

add user to a team and return a team member.

addTeamMember

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

Deprecated.

API Change on Mattermost 4.0

Should not use this API because server api changed.

addTeamMember

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

Deprecated.

API Changed on Mattermost 4.10

adds user to a team and return a team member.

Since:

Mattermost 4.0

addTeamMemberFromInvite

ApiResponse<TeamMember> addTeamMemberFromInvite(String token,
                                                String inviteId)

add user to team from invite.

Since:

Mattermost 4.10

addTeamMembers

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

adds a number of users to a team and returns the team members.

addTeamMembers

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

adds a number of users to a team and returns the team members.

removeTeamMember

default ApiResponse<Boolean> removeTeamMember(TeamMember teamMember)

will remove a user from a team.

removeTeamMember

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

will remove a user from a team.

getTeamStats

default ApiResponse<TeamStats> getTeamStats(String teamId)

returns a team stats based on the team id string. Must be authenticated.

getTeamStats

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

returns a team stats based on the team id string. Must be authenticated.

getTeamIcon

ApiResponse<Path> getTeamIcon(String teamId)
                       throws IOException

Get the team icon image.

Throws:

IOException

setTeamIcon

ApiResponse<Boolean> setTeamIcon(String teamId,
                                 Path iconFilePath)

Set the team icon.

removeTeamIcon

ApiResponse<Boolean> removeTeamIcon(String teamId)

Remove the team icon.

getTeamUnread

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. Must be authenticated.

importTeam

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.

inviteUsersToTeam

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

invite users by email to the team.

getInviteInfo

ApiResponse<TeamInviteInfo> getInviteInfo(String inviteId)

get team info by invite id.