Files
octokit.net/Octokit/IGitHubClient.cs
2019-10-30 13:51:20 -03:00

162 lines
5.6 KiB
C#

using System;
namespace Octokit
{
/// <summary>
/// A Client for the GitHub API v3. You can read more about the API here: http://developer.github.com.
/// </summary>
public interface IGitHubClient : IApiInfoProvider
{
/// <summary>
/// Set the GitHub API request timeout.
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
/// </summary>
/// <remarks>
/// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
/// </remarks>
/// <param name="timeout">The Timeout value</param>
void SetRequestTimeout(TimeSpan timeout);
/// <summary>
/// Provides a client connection to make rest requests to HTTP endpoints.
/// </summary>
IConnection Connection { get; }
/// <summary>
/// Access GitHub's Authorization API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/oauth_authorizations/
/// </remarks>
IAuthorizationsClient Authorization { get; }
/// <summary>
/// Access GitHub's Activity API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/activity/
/// </remarks>
IActivitiesClient Activity { get; }
/// <summary>
/// Access GitHub's Application API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/apps/
/// </remarks>
IGitHubAppsClient GitHubApps { get; }
/// <summary>
/// Access GitHub's Issue API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/issues/
/// </remarks>
IIssuesClient Issue { get; }
/// <summary>
/// Access GitHub's Migration API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/migration/
/// </remarks>
IMigrationClient Migration { get; }
/// <summary>
/// Access GitHub's Miscellaneous API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/misc/
/// </remarks>
IMiscellaneousClient Miscellaneous { get; }
/// <summary>
/// Access GitHub's OAuth API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/oauth/
/// </remarks>
IOauthClient Oauth { get; }
/// <summary>
/// Access GitHub's Organizations API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/orgs/
/// </remarks>
IOrganizationsClient Organization { get; }
/// <summary>
/// Access GitHub's Pull Requests API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/pulls/
/// </remarks>
IPullRequestsClient PullRequest { get; }
/// <summary>
/// Access GitHub's Repositories API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/repos/
/// </remarks>
IRepositoriesClient Repository { get; }
/// <summary>
/// Access GitHub's Gists API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/gists/
/// </remarks>
IGistsClient Gist { get; }
/// <summary>
/// Access GitHub's Users API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/users/
/// </remarks>
IUsersClient User { get; }
/// <summary>
/// Access GitHub's Git Data API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/git/
/// </remarks>
IGitDatabaseClient Git { get; }
/// <summary>
/// Access GitHub's Search API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/search/
/// </remarks>
ISearchClient Search { get; }
/// <summary>
/// Access GitHub's Enterprise API
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/enterprise/
/// </remarks>
IEnterpriseClient Enterprise { get; }
/// <summary>
/// Access GitHub's Reactions API
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/reactions/
/// </remarks>
IReactionsClient Reaction { get; }
/// <summary>
/// Access GitHub's Checks API.
/// </summary>
/// <remarks>
/// Refer to the API documentation for more information: https://developer.github.com/v3/checks/
/// </remarks>
IChecksClient Check { get; }
}
}