C# Class Octokit.OrganizationsClient

A client for GitHub's Orgs API.
See the Orgs API documentation for more information.
Inheritance: Octokit.ApiClient, IOrganizationsClient
Show file Open project: octokit/octokit.net Class Usage Examples

Public Methods

Method Description
Get ( string org ) : Task

Returns the specified Organization.
GetAll ( ) : Task>

Returns all Organizations.
GetAll ( OrganizationRequest request ) : Task>

Returns all Organizations.
GetAllForCurrent ( ) : Task>

Returns all Organizations for the current user.
GetAllForCurrent ( Octokit.ApiOptions options ) : Task>

Returns all Organizations for the current user.
GetAllForUser ( string user ) : Task>

Returns all Organizations for the specified user.
GetAllForUser ( string user, Octokit.ApiOptions options ) : Task>

Returns all Organizations for the specified user.
OrganizationsClient ( IApiConnection apiConnection ) : System

Initializes a new GitHub Orgs API client.
Update ( string organizationName, Octokit.OrganizationUpdate updateRequest ) : Task

Update the specified organization with data from OrganizationUpdate.

Private Methods

Method Description
GetAll ( string user ) : Task>
GetAll ( string user, Octokit.ApiOptions options ) : Task>

Method Details

Get() public method

Returns the specified Organization.
Thrown when a general API error occurs.
public Get ( string org ) : Task
org string login of the organization to get
return Task

GetAll() public method

Returns all Organizations.
Thrown when a general API error occurs.
public GetAll ( ) : Task>
return Task>

GetAll() public method

Returns all Organizations.
Thrown when a general API error occurs.
public GetAll ( OrganizationRequest request ) : Task>
request OrganizationRequest Search parameters of the last organization seen
return Task>

GetAllForCurrent() public method

Returns all Organizations for the current user.
Thrown when a general API error occurs.
public GetAllForCurrent ( ) : Task>
return Task>

GetAllForCurrent() public method

Returns all Organizations for the current user.
Thrown when a general API error occurs.
public GetAllForCurrent ( Octokit.ApiOptions options ) : Task>
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForUser() public method

Returns all Organizations for the specified user.
Thrown when a general API error occurs.
public GetAllForUser ( string user ) : Task>
user string The login of the user
return Task>

GetAllForUser() public method

Returns all Organizations for the specified user.
Thrown when a general API error occurs.
public GetAllForUser ( string user, Octokit.ApiOptions options ) : Task>
user string The login of the user
options Octokit.ApiOptions Options for changing the API response
return Task>

OrganizationsClient() public method

Initializes a new GitHub Orgs API client.
public OrganizationsClient ( IApiConnection apiConnection ) : System
apiConnection IApiConnection An API connection
return System

Update() public method

Update the specified organization with data from OrganizationUpdate.
Thrown if the client is not authenticated.
public Update ( string organizationName, Octokit.OrganizationUpdate updateRequest ) : Task
organizationName string The name of the organization to update.
updateRequest Octokit.OrganizationUpdate
return Task