Package org.kohsuke.github

Class GHTeam

java.lang.Object

org.kohsuke.github.GHTeam

All Implemented Interfaces:

Refreshable

public class GHTeam
extends Object
implements Refreshable

A team in GitHub organization.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected GitHub	root

Constructor Summary

Constructors

Constructor	Description
GHTeam()

Method Summary

Modifier and Type	Method	Description
void	add(GHRepository r)	Add.
void	add(GHRepository r, GHOrganization.Permission permission)	Add.
void	add(GHUser u)	Adds a member to the team.
void	add(GHUser user, GHTeam.Role role)	Adds a member to the team
void	delete()	Deletes this team.
String	getDescription()	Gets description.
int	getId()	Gets id.
Set<GHUser>	getMembers()	Gets members.
String	getName()	Gets name.
GHOrganization	getOrganization()	Gets organization.
String	getPermission()	Gets permission.
Map<String,GHRepository>	getRepositories()	Gets repositories.
String	getSlug()	Gets slug.
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()	List repositories paged iterable.
void	refresh()	Opens a connection to the given URL.
void	remove(GHRepository r)	Remove.
void	remove(GHUser u)	Removes a member to the team.
void	setDescription(String description)	Sets description.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kohsuke.github.Refreshable

refresh

Field Detail

root

protected GitHub root

Constructor Detail

GHTeam

public GHTeam()

Method Detail

getName

public String getName()

Gets name.

Returns:

the name

getPermission

public String getPermission()

Gets permission.

Returns:

the permission

getSlug

public String getSlug()

Gets slug.

Returns:

the slug

getDescription

public String getDescription()

Gets description.

Returns:

the description

setDescription

public void setDescription(String description)
                    throws IOException

Sets description.

Parameters:

description - the description

Throws:

IOException - the io exception

getId

public int getId()

Gets id.

Returns:

the id

listMembers

public PagedIterable<GHUser> listMembers()
                                  throws IOException

Retrieves the current members.

Returns:

the paged iterable

Throws:

IOException - the io exception

getMembers

public Set<GHUser> getMembers()
                       throws IOException

Gets members.

Returns:

the members

Throws:

IOException - the io exception

hasMember

public boolean hasMember(GHUser user)

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

Parameters:

user - the user

Returns:

the boolean

getRepositories

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

Gets repositories.

Returns:

the repositories

Throws:

IOException - the io exception

listRepositories

public PagedIterable<GHRepository> listRepositories()

List repositories paged iterable.

Returns:

the paged iterable

add

public void add(GHUser u)
         throws IOException

Adds a member to the team.

The user will be invited to the organization if required.

Parameters:

u - the u

Throws:

IOException - the io exception

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 - the io exception

remove

public void remove(GHUser u)
            throws IOException

Removes a member to the team.

Parameters:

u - the u

Throws:

IOException - the io exception

add

public void add(GHRepository r)
         throws IOException

Add.

Parameters:

r - the r

Throws:

IOException - the io exception

add

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

Add.

Parameters:

r - the r

permission - the permission

Throws:

IOException - the io exception

remove

public void remove(GHRepository r)
            throws IOException

Remove.

Parameters:

r - the r

Throws:

IOException - the io exception

delete

public void delete()
            throws IOException

Deletes this team.

Throws:

IOException - the io exception

getOrganization

public GHOrganization getOrganization()
                               throws IOException

Gets organization.

Returns:

the organization

Throws:

IOException - the io exception

refresh

public void refresh()
             throws IOException

Description copied from interface: Refreshable

Opens a connection to the given URL.

Specified by:

refresh in interface Refreshable

Throws:

IOException - the io exception