GitHttpClientBase.GetBranchesAsync 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

Name	Description
GetBranchesAsync(Guid, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.
GetBranchesAsync(String, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.
GetBranchesAsync(Guid, Guid, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.
GetBranchesAsync(Guid, String, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.
GetBranchesAsync(String, Guid, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.
GetBranchesAsync(String, String, GitVersionDescriptor, Object, CancellationToken)	[Preview API] Retrieve statistics about all branches within a repository.

GetBranchesAsync(Guid, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

repositoryId: Guid

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

GetBranchesAsync(String, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

repositoryId: String

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

GetBranchesAsync(Guid, Guid, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(Guid project, Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project: Guid

Project ID

repositoryId: Guid

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

GetBranchesAsync(Guid, String, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(Guid project, string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project: Guid

Project ID

repositoryId: String

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

GetBranchesAsync(String, Guid, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(string project, Guid repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project: String

Project ID or project name

repositoryId: Guid

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

GetBranchesAsync(String, String, GitVersionDescriptor, Object, CancellationToken)

[Preview API] Retrieve statistics about all branches within a repository.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.SourceControl.WebApi.GitBranchStats>> GetBranchesAsync(string project, string repositoryId, Microsoft.TeamFoundation.SourceControl.WebApi.GitVersionDescriptor baseVersionDescriptor = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project: String

Project ID or project name

repositoryId: String

The name or ID of the repository.

baseVersionDescriptor: GitVersionDescriptor

Identifies the commit or branch to use as the base.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<GitBranchStats>>

Applies to

Feedback

Was this page helpful?