Edit

Share via


TfvcHttpClientBase.GetLabelsAsync Method

Definition

Overloads

GetLabelsAsync(TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>> GetLabelsAsync(Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData requestData, Nullable<int> top = null, Nullable<int> skip = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetLabelsAsync : Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>
override this.GetLabelsAsync : Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>

Parameters

requestData
TfvcLabelRequestData

labelScope, name, owner, and itemLabelFilter

top
Nullable<Int32>

Max number of labels to return

skip
Nullable<Int32>

Number of labels to skip

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetLabelsAsync(Guid, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>> GetLabelsAsync(Guid project, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData requestData, Nullable<int> top = null, Nullable<int> skip = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetLabelsAsync : Guid * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>
override this.GetLabelsAsync : Guid * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>

Parameters

project
Guid

Project ID

requestData
TfvcLabelRequestData

labelScope, name, owner, and itemLabelFilter

top
Nullable<Int32>

Max number of labels to return

skip
Nullable<Int32>

Number of labels to skip

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to

GetLabelsAsync(String, TfvcLabelRequestData, Nullable<Int32>, Nullable<Int32>, Object, CancellationToken)

[Preview API] Get a collection of shallow label references.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>> GetLabelsAsync(string project, Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData requestData, Nullable<int> top = null, Nullable<int> skip = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetLabelsAsync : string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>
override this.GetLabelsAsync : string * Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRequestData * Nullable<int> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcLabelRef>>

Parameters

project
String

Project ID or project name

requestData
TfvcLabelRequestData

labelScope, name, owner, and itemLabelFilter

top
Nullable<Int32>

Max number of labels to return

skip
Nullable<Int32>

Number of labels to skip

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to