TfvcHttpClientBase.GetBranchAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:

Microsoft.TeamFoundation.SourceControl.WebApi.dll

Overloads

GetBranchAsync(String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.
GetBranchAsync(Guid, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.
GetBranchAsync(String, String, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

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

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch> GetBranchAsync(string path, Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

path

String

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

includeParent

Nullable<Boolean>

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

includeChildren

Nullable<Boolean>

Return child branches, if there are any. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcBranch>

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

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch> GetBranchAsync(Guid project, string path, Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project

Guid

Project ID

path

String

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

includeParent

Nullable<Boolean>

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

includeChildren

Nullable<Boolean>

Return child branches, if there are any. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcBranch>

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

[Preview API] Get a single branch hierarchy at the given path with parents or children as specified.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.TfvcBranch> GetBranchAsync(string project, string path, Nullable<bool> includeParent = null, Nullable<bool> includeChildren = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project

String

Project ID or project name

path

String

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

includeParent

Nullable<Boolean>

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

includeChildren

Nullable<Boolean>

Return child branches, if there are any. Default: False

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<TfvcBranch>