GitHttpClientBase.GetPullRequestIterationChangesAsync 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
GetPullRequestIterationChangesAsync(Guid, String, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(Guid project, string repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : Guid * string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : Guid * string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestIterationChangesAsync(Guid, Guid, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(Guid project, Guid repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : Guid * Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : Guid * Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestIterationChangesAsync(String, Guid, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(string project, Guid repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : string * Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : string * Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestIterationChangesAsync(Guid, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(Guid repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : Guid * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- repositoryId
- Guid
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestIterationChangesAsync(String, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(string repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- repositoryId
- String
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetPullRequestIterationChangesAsync(String, String, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Retrieve the changes made in a pull request between two iterations.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges> GetPullRequestIterationChangesAsync(string project, string repositoryId, int pullRequestId, int iterationId, Nullable<int> top = null, Nullable<int> skip = null, Nullable<int> compareTo = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetPullRequestIterationChangesAsync : string * string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>
override this.GetPullRequestIterationChangesAsync : string * string * int * int * Nullable<int> * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPullRequestIterationChanges>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The repository ID of the pull request's target branch.
- pullRequestId
- Int32
ID of the pull request.
- iterationId
- Int32
ID of the pull request iteration.
Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.
Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.
ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.