Package edu.sustech.search.engine.github.API

Class GitHubAPI

java.lang.Object

edu.sustech.search.engine.github.API.RestAPI

edu.sustech.search.engine.github.API.GitHubAPI

public class GitHubAPI
extends RestAPI

Provides the entry to interact with the GitHub RestAPI. The class needs to be instantiated with an OAuthToken to unlock all functionalities.

Field Summary

Fields

Modifier and Type	Field	Description
final ContentAPI	contentAPI
final FileAPI	fileAPI
final RepositoryAPI	repositoryAPI
final SearchAPI	searchAPI
final UserAPI	userAPI

Fields inherited from class edu.sustech.search.engine.github.API.RestAPI

TIME_OUT_DURATION

Method Summary

Modifier and Type	Method	Description
static GitHubAPI	registerAPI(String... OAuthTokens)	Initialize a new GitHubAPI instance to interact with.
static GitHubAPI	registerAPI(List<String> OAuthTokens)	Initialize a new GitHubAPI instance to interact with.

Methods inherited from class edu.sustech.search.engine.github.API.RestAPI

addToken, convert, getHttpResponse, getHttpResponse, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseLoopFetching, getHttpResponseRaw, getHttpResponseRaw, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getHttpResponseRawLoopFetching, getNextToken, getRateLimit, getTokenCursor, parseEndPageCount, printRateLimit, setSuppressRateError, setSuppressResponseError, setTokenCursor

Methods inherited from class java.lang.Object

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

Field Details

searchAPI

public final SearchAPI searchAPI

repositoryAPI

public final RepositoryAPI repositoryAPI

userAPI

public final UserAPI userAPI

contentAPI

public final ContentAPI contentAPI

fileAPI

public final FileAPI fileAPI

Method Details

registerAPI

public static GitHubAPI registerAPI(String... OAuthTokens)

Initialize a new GitHubAPI instance to interact with.

Parameters:

OAuthTokens - Array of Personal Access Token, or OAuthToken, which will be used for authentication. If set to null, then no OAuthToken will be used.

Returns:

A new GitHubAPI with specific OAuthToken initialized as the certificate for authentication.

registerAPI

public static GitHubAPI registerAPI(List<String> OAuthTokens)

Initialize a new GitHubAPI instance to interact with.

Parameters:

OAuthTokens - List of Personal Access Token, or OAuthToken, which will be used for authentication. If set to null, then no OAuthToken will be used.

Returns:

A new GitHubAPI with specific OAuthToken initialized as the certificate for authentication.