GitHttpClientBase.GetPullRequestsAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:: Microsoft.TeamFoundation.SourceControl.WebApi.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetPullRequestsAsync(Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.
GetPullRequestsAsync(String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.
GetPullRequestsAsync(Guid, Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.
GetPullRequestsAsync(Guid, String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.
GetPullRequestsAsync(String, Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.
GetPullRequestsAsync(String, String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)	[Preview API] Retrieve all pull requests matching a specified criteria.

GetPullRequestsAsync(Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

repositoryId: Guid

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

GetPullRequestsAsync(String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

repositoryId: String

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

GetPullRequestsAsync(Guid, Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(Guid project, Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : Guid * Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : Guid * Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

project: Guid

Project ID

repositoryId: Guid

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

GetPullRequestsAsync(Guid, String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(Guid project, string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : Guid * string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : Guid * string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

project: Guid

Project ID

repositoryId: String

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

GetPullRequestsAsync(String, Guid, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(string project, Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : string * Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : string * Guid * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

project: String

Project ID or project name

repositoryId: Guid

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

GetPullRequestsAsync(String, String, GitPullRequestSearchCriteria, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Retrieve all pull requests matching a specified criteria.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>> GetPullRequestsAsync(string project, string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria searchCriteria, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPullRequestsAsync : string * string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>
override this.GetPullRequestsAsync : string * string * Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestSearchCriteria * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>>

Parameters

project: String

Project ID or project name

repositoryId: String

The repository ID of the pull request's target branch.

searchCriteria: GitPullRequestSearchCriteria

Pull requests will be returned that match this search criteria.

maxCommentLength: Nullable<Int32>

Not used.

skip: Nullable<Int32>

The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

top: Nullable<Int32>

The number of pull requests to retrieve.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitPullRequest>>

Applies to

Feedback

Was this page helpful?