WorkItemTrackingHttpClientBase.GetCommentsAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.WorkItemTracking.WebApi

Assembly:

Microsoft.TeamFoundation.WorkItemTracking.WebApi.dll

Overloads

GetCommentsAsync(Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)	[Preview API] Gets the specified number of comments for a work item from the specified revision.
GetCommentsAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)	[Preview API] Gets the specified number of comments for a work item from the specified revision.
GetCommentsAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)	[Preview API] Gets the specified number of comments for a work item from the specified revision.

GetCommentsAsync(Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)

[Preview API] Gets the specified number of comments for a work item from the specified revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments> GetCommentsAsync (int id, Nullable<int> fromRevision = null, Nullable<int> top = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> order = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetCommentsAsync : int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>
override this.GetCommentsAsync : int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>

Parameters

id

Int32

Work item id

fromRevision

Nullable<Int32>

Revision from which comments are to be fetched (default is 1)

top

Nullable<Int32>

The number of comments to return (default is 200)

order

Nullable<CommentSortOrder>

Ascending or descending by revision id (default is ascending)

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<WorkItemComments>

GetCommentsAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)

[Preview API] Gets the specified number of comments for a work item from the specified revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments> GetCommentsAsync (Guid project, int id, Nullable<int> fromRevision = null, Nullable<int> top = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> order = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetCommentsAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>
override this.GetCommentsAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>

Parameters

project

Guid

Project ID

id

Int32

Work item id

fromRevision

Nullable<Int32>

Revision from which comments are to be fetched (default is 1)

top

Nullable<Int32>

The number of comments to return (default is 200)

order

Nullable<CommentSortOrder>

Ascending or descending by revision id (default is ascending)

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<WorkItemComments>

GetCommentsAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<CommentSortOrder>, Object, CancellationToken)

[Preview API] Gets the specified number of comments for a work item from the specified revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments> GetCommentsAsync (string project, int id, Nullable<int> fromRevision = null, Nullable<int> top = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> order = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetCommentsAsync : string * int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>
override this.GetCommentsAsync : string * int * Nullable<int> * Nullable<int> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.CommentSortOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItemComments>

Parameters

project

String

Project ID or project name

id

Int32

Work item id

fromRevision

Nullable<Int32>

Revision from which comments are to be fetched (default is 1)

top

Nullable<Int32>

The number of comments to return (default is 200)

order

Nullable<CommentSortOrder>

Ascending or descending by revision id (default is ascending)

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<WorkItemComments>