org.kohsuke.github

Class GHTeam

java.lang.Object

org.kohsuke.github.GHTeam

public class GHTeam
extends Object

A team in GitHub organization.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHTeam.Role Member's role in a team

Field Summary

Fields

Modifier and Type	Field and Description
protected GHOrganization	org

Constructor Summary

Constructors

Constructor and Description
GHTeam()

Method Summary

Modifier and Type	Method and Description
void	add(GHRepository r)
void	add(GHRepository r, GHOrganization.Permission permission)
void	add(GHUser u) Adds a member to the team.
void	add(GHUser user, GHTeam.Role role) Adds a member to the team The user will be invited to the organization if required.
void	delete() Deletes this team.
int	getId()
Set<GHUser>	getMembers()
String	getName()
GHOrganization	getOrganization()
String	getPermission()
Map<String,GHRepository>	getRepositories()
String	getSlug()
boolean	hasMember(GHUser user) Checks if this team has the specified user as a member.
PagedIterable<GHUser>	listMembers() Retrieves the current members.
PagedIterable<GHRepository>	listRepositories()
void	remove(GHRepository r)
void	remove(GHUser u) Removes a member to the team.

Methods inherited from class java.lang.Object

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

Field Detail

org

protected GHOrganization org

Constructor Detail

GHTeam

public GHTeam()

Method Detail

getName

public String getName()

getPermission

public String getPermission()

getSlug

public String getSlug()

getId

public int getId()

listMembers

public PagedIterable<GHUser> listMembers()
                                  throws IOException

Retrieves the current members.

Throws:

IOException

getMembers

public Set<GHUser> getMembers()
                       throws IOException

Throws:

IOException

hasMember

public boolean hasMember(GHUser user)

Checks if this team has the specified user as a member.

getRepositories

public Map<String,GHRepository> getRepositories()
                                         throws IOException

Throws:

IOException

listRepositories

public PagedIterable<GHRepository> listRepositories()

add

public void add(GHUser u)
         throws IOException

Adds a member to the team. The user will be invited to the organization if required.

Throws:

IOException

Since:

1.59

add

public void add(GHUser user,
                GHTeam.Role role)
         throws IOException

Adds a member to the team The user will be invited to the organization if required.

Parameters:

user - github user

role - role for the new member

Throws:

IOException

remove

public void remove(GHUser u)
            throws IOException

Removes a member to the team.

Throws:

IOException

add

public void add(GHRepository r)
         throws IOException

Throws:

IOException

add

public void add(GHRepository r,
                GHOrganization.Permission permission)
         throws IOException

Throws:

IOException

remove

public void remove(GHRepository r)
            throws IOException

Throws:

IOException

delete

public void delete()
            throws IOException

Deletes this team.

Throws:

IOException

getOrganization

public GHOrganization getOrganization()