Package org.kohsuke.github

Class GHExternalGroup

java.lang.Object

org.kohsuke.github.GHExternalGroup

All Implemented Interfaces:

Refreshable

public class GHExternalGroup
extends Object
implements Refreshable

An external group available in a GitHub organization.

Author:

Miguel Esteban Gutiérrez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHExternalGroup.GHLinkedExternalMember	A reference of an external member linked to an external group
static class	GHExternalGroup.GHLinkedTeam	A reference of a team linked to an external group

Method Summary

Modifier and Type	Method	Description
long	getId()	Get the external group id.
List<GHExternalGroup.GHLinkedExternalMember>	getMembers()	Get the external members linked to this group.
String	getName()	Get the external group name.
GHOrganization	getOrganization()	Gets organization.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
List<GHExternalGroup.GHLinkedTeam>	getTeams()	Get the teams linked to this group.
Date	getUpdatedAt()	Get the external group last update date.
void	refresh()	Refresh.

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

Method Details

getOrganization

public GHOrganization getOrganization()
                               throws IOException

Gets organization.

Returns:

the organization

Throws:

IOException - the io exception

getId

public long getId()

Get the external group id.

Returns:

the id

getName

public String getName()

Get the external group name.

Returns:

the name

getUpdatedAt

public Date getUpdatedAt()

Get the external group last update date.

Returns:

the date

getTeams

public List<GHExternalGroup.GHLinkedTeam> getTeams()

Get the teams linked to this group.

Returns:

the teams

getMembers

public List<GHExternalGroup.GHLinkedExternalMember> getMembers()

Get the external members linked to this group.

Returns:

the external members

refresh

public void refresh()
             throws IOException

Refresh.

Specified by:

refresh in interface Refreshable

Throws:

IOException - Signals that an I/O exception has occurred.

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance