C# Class Octokit.GitHubClient

A Client for the GitHub API v3. You can read more about the api here: http://developer.github.com.

Inheritance: IGitHubClient

Public Properties

Property	Type	Description
GitHubApiUrl	System.Uri

Method	Description
GetLastApiInfo ( ) : Octokit.ApiInfo	Gets the latest API Info - this will be null if no API calls have been made
GitHubClient ( IConnection connection ) : System	Create a new instance of the GitHub API v3 client using the specified connection.
GitHubClient ( Octokit.ProductHeaderValue productInformation ) : System	Create a new instance of the GitHub API v3 client pointing to https://api.github.com/
GitHubClient ( Octokit.ProductHeaderValue productInformation, ICredentialStore credentialStore ) : System	Create a new instance of the GitHub API v3 client pointing to https://api.github.com/
GitHubClient ( Octokit.ProductHeaderValue productInformation, ICredentialStore credentialStore, Uri baseAddress ) : System	Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
GitHubClient ( Octokit.ProductHeaderValue productInformation, Uri baseAddress ) : System	Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.

Method	Description
FixUpBaseUri ( Uri uri ) : Uri

Gets the latest API Info - this will be null if no API calls have been made

public GetLastApiInfo ( ) : Octokit.ApiInfo
return	Octokit.ApiInfo

Create a new instance of the GitHub API v3 client using the specified connection.

public GitHubClient ( IConnection connection ) : System
connection	IConnection	The underlying used to make requests
return	System

Create a new instance of the GitHub API v3 client pointing to https://api.github.com/

public GitHubClient ( Octokit.ProductHeaderValue productInformation ) : System
productInformation	Octokit.ProductHeaderValue	/// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. ///
return	System

Create a new instance of the GitHub API v3 client pointing to https://api.github.com/

public GitHubClient ( Octokit.ProductHeaderValue productInformation, ICredentialStore credentialStore ) : System
productInformation	Octokit.ProductHeaderValue	/// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. ///
credentialStore	ICredentialStore	Provides credentials to the client when making requests
return	System

Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.

public GitHubClient ( Octokit.ProductHeaderValue productInformation, ICredentialStore credentialStore, Uri baseAddress ) : System
productInformation	Octokit.ProductHeaderValue	/// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. ///
credentialStore	ICredentialStore	Provides credentials to the client when making requests
baseAddress	System.Uri	/// The address to point this client to. Typically used for GitHub Enterprise /// instances
return	System

Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.

public GitHubClient ( Octokit.ProductHeaderValue productInformation, Uri baseAddress ) : System
productInformation	Octokit.ProductHeaderValue	/// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. ///
baseAddress	System.Uri	/// The address to point this client to. Typically used for GitHub Enterprise /// instances
return	System

The base address for the GitHub API

public static Uri,System GitHubApiUrl
return	System.Uri