GitHttpClientBase.GetPullRequestAsync Method
Definition
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
GetPullRequestAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(Guid repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>Parameters
- repositoryId
- Guid
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(string repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>Parameters
- repositoryId
- String
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestAsync(Guid, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(Guid project, Guid repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : Guid * Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : Guid * Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestAsync(Guid, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(Guid project, string repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : Guid * string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : Guid * string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestAsync(String, Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(string project, Guid repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : string * Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : string * Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<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.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestAsync(String, String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Retrieve a pull request.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest> GetPullRequestAsync(string project, string repositoryId, int pullRequestId, Nullable<int> maxCommentLength = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includeCommits = null, Nullable<bool> includeWorkItemRefs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestAsync : string * string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequest>
override this.GetPullRequestAsync : string * string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<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.
- pullRequestId
- Int32
The ID of the pull request to retrieve.
If true, the pull request will be returned with the associated commits.
If true, the pull request will be returned with the associated work item references.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.