C# Class Octokit.PullRequestsClient

Inheritance: Octokit.ApiClient, IPullRequestsClient
Show file Open project: octokit/octokit.net Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Commits ( long repositoryId, int number ) : Task>

Get the list of commits on a pull request.

http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

Commits ( string owner, string name, int number ) : Task>

Get the list of commits on a pull request.

http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

Create ( long repositoryId, Octokit.NewPullRequest newPullRequest ) : Task

Create a pull request for the specified repository.

http://developer.github.com/v3/pulls/#create-a-pull-request

Create ( string owner, string name, Octokit.NewPullRequest newPullRequest ) : Task

Create a pull request for the specified repository.

http://developer.github.com/v3/pulls/#create-a-pull-request

Files ( long repositoryId, int number ) : Task>

Get the list of files on a pull request.

https://developer.github.com/v3/pulls/#list-pull-requests-files

Files ( string owner, string name, int number ) : Task>

Get the list of files on a pull request.

https://developer.github.com/v3/pulls/#list-pull-requests-files

Get ( long repositoryId, int number ) : Task

Get a pull request by number.

http://developer.github.com/v3/pulls/#get-a-single-pull-request

Get ( string owner, string name, int number ) : Task

Get a pull request by number.

http://developer.github.com/v3/pulls/#get-a-single-pull-request

GetAllForRepository ( long repositoryId ) : Task>

Get all open pull requests for the repository.

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( long repositoryId, Octokit.ApiOptions options ) : Task>

Get all open pull requests for the repository.

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( long repositoryId, Octokit.PullRequestRequest request ) : Task>

Query pull requests for the repository based on criteria

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( long repositoryId, Octokit.PullRequestRequest request, Octokit.ApiOptions options ) : Task>

Query pull requests for the repository based on criteria

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( string owner, string name ) : Task>

Get all open pull requests for the repository.

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( string owner, string name, Octokit.ApiOptions options ) : Task>

Get all open pull requests for the repository.

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( string owner, string name, Octokit.PullRequestRequest request ) : Task>

Query pull requests for the repository based on criteria

http://developer.github.com/v3/pulls/#list-pull-requests

GetAllForRepository ( string owner, string name, Octokit.PullRequestRequest request, Octokit.ApiOptions options ) : Task>

Query pull requests for the repository based on criteria

http://developer.github.com/v3/pulls/#list-pull-requests

Merge ( long repositoryId, int number, Octokit.MergePullRequest mergePullRequest ) : Task

Merge a pull request.

http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade

Merge ( string owner, string name, int number, Octokit.MergePullRequest mergePullRequest ) : Task

Merge a pull request.

http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade

Merged ( long repositoryId, int number ) : Task

Get the pull request merge status.

http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

Merged ( string owner, string name, int number ) : Task

Get the pull request merge status.

http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

PullRequestsClient ( IApiConnection apiConnection ) : System
Update ( long repositoryId, int number, Octokit.PullRequestUpdate pullRequestUpdate ) : Task

Create a pull request for the specified repository.

http://developer.github.com/v3/pulls/#update-a-pull-request

Update ( string owner, string name, int number, Octokit.PullRequestUpdate pullRequestUpdate ) : Task

Create a pull request for the specified repository.

http://developer.github.com/v3/pulls/#update-a-pull-request

Method Details

Commits() public method

Get the list of commits on a pull request.
http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
public Commits ( long repositoryId, int number ) : Task>
repositoryId long The Id of the repository
number int The pull request number
return Task>

Commits() public method

Get the list of commits on a pull request.
http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
public Commits ( string owner, string name, int number ) : Task>
owner string The owner of the repository
name string The name of the repository
number int The pull request number
return Task>

Create() public method

Create a pull request for the specified repository.
http://developer.github.com/v3/pulls/#create-a-pull-request
public Create ( long repositoryId, Octokit.NewPullRequest newPullRequest ) : Task
repositoryId long The Id of the repository
newPullRequest Octokit.NewPullRequest A instance describing the new PullRequest to create
return Task

Create() public method

Create a pull request for the specified repository.
http://developer.github.com/v3/pulls/#create-a-pull-request
public Create ( string owner, string name, Octokit.NewPullRequest newPullRequest ) : Task
owner string The owner of the repository
name string The name of the repository
newPullRequest Octokit.NewPullRequest A instance describing the new PullRequest to create
return Task

Files() public method

Get the list of files on a pull request.
https://developer.github.com/v3/pulls/#list-pull-requests-files
public Files ( long repositoryId, int number ) : Task>
repositoryId long The Id of the repository
number int The pull request number
return Task>

Files() public method

Get the list of files on a pull request.
https://developer.github.com/v3/pulls/#list-pull-requests-files
public Files ( string owner, string name, int number ) : Task>
owner string The owner of the repository
name string The name of the repository
number int The pull request number
return Task>

Get() public method

Get a pull request by number.
http://developer.github.com/v3/pulls/#get-a-single-pull-request
public Get ( long repositoryId, int number ) : Task
repositoryId long
number int
return Task

Get() public method

Get a pull request by number.
http://developer.github.com/v3/pulls/#get-a-single-pull-request
public Get ( string owner, string name, int number ) : Task
owner string
name string
number int
return Task

GetAllForRepository() public method

Get all open pull requests for the repository.
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( long repositoryId ) : Task>
repositoryId long The Id of the repository
return Task>

GetAllForRepository() public method

Get all open pull requests for the repository.
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( long repositoryId, Octokit.ApiOptions options ) : Task>
repositoryId long The Id of the repository
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Query pull requests for the repository based on criteria
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( long repositoryId, Octokit.PullRequestRequest request ) : Task>
repositoryId long The Id of the repository
request Octokit.PullRequestRequest Used to filter and sort the list of pull requests returned
return Task>

GetAllForRepository() public method

Query pull requests for the repository based on criteria
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( long repositoryId, Octokit.PullRequestRequest request, Octokit.ApiOptions options ) : Task>
repositoryId long The Id of the repository
request Octokit.PullRequestRequest Used to filter and sort the list of pull requests returned
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Get all open pull requests for the repository.
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( string owner, string name ) : Task>
owner string The owner of the repository
name string The name of the repository
return Task>

GetAllForRepository() public method

Get all open pull requests for the repository.
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( string owner, string name, Octokit.ApiOptions options ) : Task>
owner string The owner of the repository
name string The name of the repository
options Octokit.ApiOptions Options for changing the API response
return Task>

GetAllForRepository() public method

Query pull requests for the repository based on criteria
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( string owner, string name, Octokit.PullRequestRequest request ) : Task>
owner string The owner of the repository
name string The name of the repository
request Octokit.PullRequestRequest Used to filter and sort the list of pull requests returned
return Task>

GetAllForRepository() public method

Query pull requests for the repository based on criteria
http://developer.github.com/v3/pulls/#list-pull-requests
public GetAllForRepository ( string owner, string name, Octokit.PullRequestRequest request, Octokit.ApiOptions options ) : Task>
owner string The owner of the repository
name string The name of the repository
request Octokit.PullRequestRequest Used to filter and sort the list of pull requests returned
options Octokit.ApiOptions Options for changing the API response
return Task>

Merge() public method

Merge a pull request.
http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
public Merge ( long repositoryId, int number, Octokit.MergePullRequest mergePullRequest ) : Task
repositoryId long The Id of the repository
number int The pull request number
mergePullRequest Octokit.MergePullRequest A instance describing a pull request merge
return Task

Merge() public method

Merge a pull request.
http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
public Merge ( string owner, string name, int number, Octokit.MergePullRequest mergePullRequest ) : Task
owner string The owner of the repository
name string The name of the repository
number int The pull request number
mergePullRequest Octokit.MergePullRequest A instance describing a pull request merge
return Task

Merged() public method

Get the pull request merge status.
http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
public Merged ( long repositoryId, int number ) : Task
repositoryId long The Id of the repository
number int The pull request number
return Task

Merged() public method

Get the pull request merge status.
http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
public Merged ( string owner, string name, int number ) : Task
owner string The owner of the repository
name string The name of the repository
number int The pull request number
return Task

PullRequestsClient() public method

public PullRequestsClient ( IApiConnection apiConnection ) : System
apiConnection IApiConnection
return System

Update() public method

Create a pull request for the specified repository.
http://developer.github.com/v3/pulls/#update-a-pull-request
public Update ( long repositoryId, int number, Octokit.PullRequestUpdate pullRequestUpdate ) : Task
repositoryId long The Id of the repository
number int The PullRequest number
pullRequestUpdate Octokit.PullRequestUpdate An instance describing the changes to make to the PullRequest ///
return Task

Update() public method

Create a pull request for the specified repository.
http://developer.github.com/v3/pulls/#update-a-pull-request
public Update ( string owner, string name, int number, Octokit.PullRequestUpdate pullRequestUpdate ) : Task
owner string The owner of the repository
name string The name of the repository
number int The PullRequest number
pullRequestUpdate Octokit.PullRequestUpdate An instance describing the changes to make to the PullRequest ///
return Task