Package io.github.coho04.githubapi.entities

Class GHTeam

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.bases.ClassBase

io.github.coho04.githubapi.entities.GHTeam

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class GHTeam
extends ClassBase

This class represents a GitHub Team. It provides methods for fetching data about the team such as its name, slug, description, privacy, notification setting, permission, members URL, repositories URL, creation date, update date, members count, repos count, and parent team.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

Constructor	Description
GHTeam(org.json.JSONObject jsonObject)	Constructs a new GHTeam instance with the provided JSON object.

Method Summary

Modifier and Type	Method	Description
OffsetDateTime	getCreatedAt()	Returns the members count of the team.
String	getDescription()	Returns the description of the team.
int	getMembersCount()	Returns the members count of the team.
String	getMembersUrl()	Returns the members URL of the team.
String	getName()	Returns the name of the team.
String	getNotificationSetting()	Returns the notification setting of the team.
GHTeam	getParent()	Returns the parent team of the team.
String	getPermission()	Returns the permission of the team.
String	getPrivacy()	Returns the privacy of the team.
int	getReposCount()	Returns the repos count of the team.
String	getRepositoriesUrl()	Returns the repositories URL of the team.
String	getSlug()	Returns the slug of the team.
static GHTeam	getTeamByName(Github github, String name, GHOrganisation organisation)	Returns a GHTeam instance by team name.
OffsetDateTime	getUpdatedAt()	Returns the repos count of the team.
org.json.JSONObject	toJSONObject()	Converts this ClassBase object to a JSONObject.

Methods inherited from class io.github.coho04.githubapi.bases.ClassBase

getEventsUrl, getHtmlUrl, getId, getNodeId, getUrl

Methods inherited from class io.github.coho04.githubapi.bases.GHBase

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.coho04.githubapi.interfaces.HttpRequestInterface

extractNextPageUrl, sendDeleteRequest, sendDeleteRequestWithResponseCode, sendGetRequest, sendGetRequestWithLinkHeader, sendGetRequestWithResponseCode, sendPatchRequest, sendPostRequest, sendPutRequest

Methods inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

getArrayOrNull, getBooleanOrNull, getIntOrNull, getJSONArrayToStringList, getJSONObjectOrNull, getLocalDateOrNull, getLongOrNull, getStringOrNull

Constructor Details

GHTeam

public GHTeam(org.json.JSONObject jsonObject)

Constructs a new GHTeam instance with the provided JSON object.

Parameters:

jsonObject - the JSON object containing the team data

Method Details

toJSONObject

public org.json.JSONObject toJSONObject()

Description copied from class: ClassBase

Converts this ClassBase object to a JSONObject.

Overrides:

toJSONObject in class ClassBase

Returns:

a JSONObject representation of this ClassBase object.

getTeamByName

public static GHTeam getTeamByName(Github github,
 String name,
 GHOrganisation organisation)

Returns a GHTeam instance by team name.

Parameters:

github - the GitHub instance

name - the team name

organisation - the GHOrganisation instance

Returns:

the GHTeam instance

getDescription

public String getDescription()

Returns the description of the team.

Returns:

the description of the team

getMembersUrl

public String getMembersUrl()

Returns the members URL of the team.

Returns:

the members URL of the team

getName

public String getName()

Returns the name of the team.

Returns:

the name of the team

getNotificationSetting

public String getNotificationSetting()

Returns the notification setting of the team.

Returns:

the notification setting of the team

getParent

public GHTeam getParent()

Returns the parent team of the team.

Returns:

the parent team of the team

getPermission

public String getPermission()

Returns the permission of the team.

Returns:

the permission of the team

getPrivacy

public String getPrivacy()

Returns the privacy of the team.

Returns:

the privacy of the team

getRepositoriesUrl

public String getRepositoriesUrl()

Returns the repositories URL of the team.

Returns:

the repositories URL of the team

getSlug

public String getSlug()

Returns the slug of the team.

Returns:

the slug of the team

getCreatedAt

public OffsetDateTime getCreatedAt()

Returns the members count of the team.

Returns:

the members count of the team

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Returns the repos count of the team.

Returns:

the repos count of the team

getMembersCount

public int getMembersCount()

Returns the members count of the team.

Returns:

the members count of the team

getReposCount

public int getReposCount()

Returns the repos count of the team.

Returns:

the repos count of the team