TfvcHttpClientBase.GetChangesetAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Overloads

GetChangesetAsync(Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)	[Preview API] Retrieve a Tfvc Changeset
GetChangesetAsync(Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)	[Preview API] Retrieve a Tfvc Changeset
GetChangesetAsync(String, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)	[Preview API] Retrieve a Tfvc Changeset

GetChangesetAsync(Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset> GetChangesetAsync(int id, Nullable<int> maxChangeCount = null, Nullable<bool> includeDetails = null, Nullable<bool> includeWorkItems = null, Nullable<int> maxCommentLength = null, Nullable<bool> includeSourceRename = null, Nullable<int> skip = null, Nullable<int> top = null, string orderby = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria searchCriteria = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetChangesetAsync : int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>
override this.GetChangesetAsync : int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>

Parameters

id

Int32

Changeset Id to retrieve.

maxChangeCount

Nullable<Int32>

Number of changes to return (maximum 100 changes) Default: 0

includeDetails

Nullable<Boolean>

Include policy details and check-in notes in the response. Default: false

includeWorkItems

Nullable<Boolean>

Include workitems. Default: false

maxCommentLength

Nullable<Int32>

Include details about associated work items in the response. Default: null

includeSourceRename

Nullable<Boolean>

Include renames. Default: false

skip

Nullable<Int32>

Number of results to skip. Default: null

top

Nullable<Int32>

The maximum number of results to return. Default: null

orderby

String

Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.

searchCriteria

TfvcChangesetSearchCriteria

Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcChangeset>

GetChangesetAsync(Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset> GetChangesetAsync(Guid project, int id, Nullable<int> maxChangeCount = null, Nullable<bool> includeDetails = null, Nullable<bool> includeWorkItems = null, Nullable<int> maxCommentLength = null, Nullable<bool> includeSourceRename = null, Nullable<int> skip = null, Nullable<int> top = null, string orderby = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria searchCriteria = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetChangesetAsync : Guid * int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>
override this.GetChangesetAsync : Guid * int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>

Parameters

project

Guid

Project ID

id

Int32

Changeset Id to retrieve.

maxChangeCount

Nullable<Int32>

Number of changes to return (maximum 100 changes) Default: 0

includeDetails

Nullable<Boolean>

Include policy details and check-in notes in the response. Default: false

includeWorkItems

Nullable<Boolean>

Include workitems. Default: false

maxCommentLength

Nullable<Int32>

Include details about associated work items in the response. Default: null

includeSourceRename

Nullable<Boolean>

Include renames. Default: false

skip

Nullable<Int32>

Number of results to skip. Default: null

top

Nullable<Int32>

The maximum number of results to return. Default: null

orderby

String

Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.

searchCriteria

TfvcChangesetSearchCriteria

Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcChangeset>

GetChangesetAsync(String, Int32, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, String, TfvcChangesetSearchCriteria, Object, CancellationToken)

[Preview API] Retrieve a Tfvc Changeset

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset> GetChangesetAsync(string project, int id, Nullable<int> maxChangeCount = null, Nullable<bool> includeDetails = null, Nullable<bool> includeWorkItems = null, Nullable<int> maxCommentLength = null, Nullable<bool> includeSourceRename = null, Nullable<int> skip = null, Nullable<int> top = null, string orderby = null, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria searchCriteria = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetChangesetAsync : string * int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>
override this.GetChangesetAsync : string * int * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<int> * Nullable<int> * string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangesetSearchCriteria * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcChangeset>

Parameters

project

String

Project ID or project name

id

Int32

Changeset Id to retrieve.

maxChangeCount

Nullable<Int32>

Number of changes to return (maximum 100 changes) Default: 0

includeDetails

Nullable<Boolean>

Include policy details and check-in notes in the response. Default: false

includeWorkItems

Nullable<Boolean>

Include workitems. Default: false

maxCommentLength

Nullable<Int32>

Include details about associated work items in the response. Default: null

includeSourceRename

Nullable<Boolean>

Include renames. Default: false

skip

Nullable<Int32>

Number of results to skip. Default: null

top

Nullable<Int32>

The maximum number of results to return. Default: null

orderby

String

Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.

searchCriteria

TfvcChangesetSearchCriteria

Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcChangeset>