C# Класс Octokit.OrganizationsClient

A client for GitHub's Orgs API.
See the Orgs API documentation for more information.
Наследование: Octokit.ApiClient, IOrganizationsClient
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
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.

Приватные методы

Метод Описание
GetAll ( string user ) : Task>
GetAll ( string user, Octokit.ApiOptions options ) : Task>

Описание методов

Get() публичный Метод

Returns the specified Organization.
Thrown when a general API error occurs.
public Get ( string org ) : Task
org string login of the organization to get
Результат Task

GetAll() публичный Метод

Returns all Organizations.
Thrown when a general API error occurs.
public GetAll ( ) : Task>
Результат Task>

GetAll() публичный Метод

Returns all Organizations.
Thrown when a general API error occurs.
public GetAll ( OrganizationRequest request ) : Task>
request OrganizationRequest Search parameters of the last organization seen
Результат Task>

GetAllForCurrent() публичный Метод

Returns all Organizations for the current user.
Thrown when a general API error occurs.
public GetAllForCurrent ( ) : Task>
Результат Task>

GetAllForCurrent() публичный Метод

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
Результат Task>

GetAllForUser() публичный Метод

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
Результат Task>

GetAllForUser() публичный Метод

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
Результат Task>

OrganizationsClient() публичный Метод

Initializes a new GitHub Orgs API client.
public OrganizationsClient ( IApiConnection apiConnection ) : System
apiConnection IApiConnection An API connection
Результат System

Update() публичный Метод

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
Результат Task