TfvcHttpClientBase.GetBranchesAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Overloads

GetBranchesAsync(Guid, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.
GetBranchesAsync(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.
GetBranchesAsync(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

GetBranchesAsync(Guid, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>> GetBranchesAsync(Guid project, Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBranchesAsync : Guid * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>
override this.GetBranchesAsync : Guid * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>

Parameters

project

Guid

Project ID

includeParent

Nullable<Boolean>

Return the parent branch, if there is one. Default: False

includeChildren

Nullable<Boolean>

Return the child branches for each root branch. Default: False

includeDeleted

Nullable<Boolean>

Return deleted branches. Default: False

includeLinks

Nullable<Boolean>

Return links. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TfvcBranch>>

GetBranchesAsync(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>> GetBranchesAsync(string project, Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBranchesAsync : string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>
override this.GetBranchesAsync : string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>

Parameters

project

String

Project ID or project name

includeParent

Nullable<Boolean>

Return the parent branch, if there is one. Default: False

includeChildren

Nullable<Boolean>

Return the child branches for each root branch. Default: False

includeDeleted

Nullable<Boolean>

Return deleted branches. Default: False

includeLinks

Nullable<Boolean>

Return links. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TfvcBranch>>

GetBranchesAsync(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get a collection of branch roots -- first-level children, branches with no parents.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>> GetBranchesAsync(Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBranchesAsync : Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>
override this.GetBranchesAsync : Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch>>

Parameters

includeParent

Nullable<Boolean>

Return the parent branch, if there is one. Default: False

includeChildren

Nullable<Boolean>

Return the child branches for each root branch. Default: False

includeDeleted

Nullable<Boolean>

Return deleted branches. Default: False

includeLinks

Nullable<Boolean>

Return links. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TfvcBranch>>