TfvcHttpClientBase.GetBranchRefsAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:: Microsoft.TeamFoundation.SourceControl.WebApi.dll

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

GetBranchRefsAsync(String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get branch hierarchies below the specified scopePath
GetBranchRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get branch hierarchies below the specified scopePath
GetBranchRefsAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get branch hierarchies below the specified scopePath

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

[Preview API] Get branch hierarchies below the specified scopePath

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranchRef>> GetBranchRefsAsync(string scopePath, Nullable<bool> includeDeleted = null, Nullable<bool> includeLinks = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

scopePath: String

Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.

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<TfvcBranchRef>>

Applies to

GetBranchRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Get branch hierarchies below the specified scopePath

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

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

Parameters

project: Guid

Project ID

scopePath: String

Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.

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<TfvcBranchRef>>

Applies to

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

[Preview API] Get branch hierarchies below the specified scopePath

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

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

Parameters

project: String

Project ID or project name

scopePath: String

Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.

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<TfvcBranchRef>>

Applies to

Feedback

Was this page helpful?

Share via

TfvcHttpClientBase.GetBranchRefsAsync Method

Definition

Overloads

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

Parameters

Returns

Applies to

GetBranchRefsAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

Feedback