com.jdroid.github.service

Class TeamService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.TeamService

public class TeamService
extends GitHubService

Service class for working with organization teams

See Also:

GitHub team API documentation

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
TeamService() Create team service
TeamService(GitHubClient client) Create team service

Method Summary

Modifier and Type	Method and Description
void	addMember(int id, java.lang.String user) Add given user to team with given id
TeamMembership	addMembership(int id, java.lang.String user)
void	addRepository(int id, IRepositoryIdProvider repository) Add repository to team
Team	createTeam(java.lang.String organization, Team team) Create the given team
Team	createTeam(java.lang.String organization, Team team, java.util.List<java.lang.String> repoNames) Create the given team
void	deleteTeam(int id) Delete the team with the given id
Team	editTeam(Team team) Edit the given team
java.util.List<User>	getMembers(int id) Get members of team with given id
TeamMembership	getMembership(int id, java.lang.String user)
java.util.List<Repository>	getRepositories(int id) Get all repositories for given team
Team	getTeam(int id) Get team with given id
java.util.List<Team>	getTeams(IRepositoryIdProvider repository) Get teams associated with given repository
java.util.List<Team>	getTeams(java.lang.String organization) Get all teams in the given organization
boolean	isMember(int id, java.lang.String user) Is the given user a member of the team with the given id
boolean	isTeamRepository(int id, IRepositoryIdProvider repository) Is given repository managed by given team
void	removeMember(int id, java.lang.String user) Remove given user from team with given id
void	removeMembership(int id, java.lang.String user)
void	removeRepository(int id, IRepositoryIdProvider repository) Remove repository from team

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TeamService

public TeamService()

Create team service

TeamService

public TeamService(GitHubClient client)

Create team service

Parameters:

client -

Method Detail

getTeam

public Team getTeam(int id)
             throws java.io.IOException

Get team with given id

Parameters:

id -

Returns:

team

Throws:

java.io.IOException

getTeams

public java.util.List<Team> getTeams(java.lang.String organization)
                              throws java.io.IOException

Get all teams in the given organization

Parameters:

organization -

Returns:

list of teams

Throws:

java.io.IOException

createTeam

public Team createTeam(java.lang.String organization,
                       Team team)
                throws java.io.IOException

Create the given team

Parameters:

organization -

team -

Returns:

created team

Throws:

java.io.IOException

createTeam

public Team createTeam(java.lang.String organization,
                       Team team,
                       java.util.List<java.lang.String> repoNames)
                throws java.io.IOException

Create the given team

Parameters:

organization -

team -

repoNames -

Returns:

created team

Throws:

java.io.IOException

editTeam

public Team editTeam(Team team)
              throws java.io.IOException

Edit the given team

Parameters:

team -

Returns:

edited team

Throws:

java.io.IOException

deleteTeam

public void deleteTeam(int id)
                throws java.io.IOException

Delete the team with the given id

Parameters:

id -

Throws:

java.io.IOException

getMembers

public java.util.List<User> getMembers(int id)
                                throws java.io.IOException

Get members of team with given id

Parameters:

id -

Returns:

team members

Throws:

java.io.IOException

isMember

public boolean isMember(int id,
                        java.lang.String user)
                 throws java.io.IOException

Is the given user a member of the team with the given id

Parameters:

id -

user -

Returns:

true if member, false if not member

Throws:

java.io.IOException

addMember

public void addMember(int id,
                      java.lang.String user)
               throws java.io.IOException

Add given user to team with given id

Parameters:

id -

user -

Throws:

java.io.IOException

removeMember

public void removeMember(int id,
                         java.lang.String user)
                  throws java.io.IOException

Remove given user from team with given id

Parameters:

id -

user -

Throws:

java.io.IOException

getMembership

public TeamMembership getMembership(int id,
                                    java.lang.String user)
                             throws java.io.IOException

Throws:

java.io.IOException

addMembership

public TeamMembership addMembership(int id,
                                    java.lang.String user)
                             throws java.io.IOException

Throws:

java.io.IOException

removeMembership

public void removeMembership(int id,
                             java.lang.String user)
                      throws java.io.IOException

Throws:

java.io.IOException

getRepositories

public java.util.List<Repository> getRepositories(int id)
                                           throws java.io.IOException

Get all repositories for given team

Parameters:

id -

Returns:

non-null list of repositories

Throws:

java.io.IOException

isTeamRepository

public boolean isTeamRepository(int id,
                                IRepositoryIdProvider repository)
                         throws java.io.IOException

Is given repository managed by given team

Parameters:

id -

repository -

Returns:

true if managed by team, false otherwise

Throws:

java.io.IOException

addRepository

public void addRepository(int id,
                          IRepositoryIdProvider repository)
                   throws java.io.IOException

Add repository to team

Parameters:

id -

repository -

Throws:

java.io.IOException

removeRepository

public void removeRepository(int id,
                             IRepositoryIdProvider repository)
                      throws java.io.IOException

Remove repository from team

Parameters:

id -

repository -

Throws:

java.io.IOException

getTeams

public java.util.List<Team> getTeams(IRepositoryIdProvider repository)
                              throws java.io.IOException

Get teams associated with given repository

Parameters:

repository -

Returns:

list of teams

Throws:

java.io.IOException