BuildHttpClientBase.GetBadgeAsync Method

Reference

Definition

Namespace:: Microsoft.TeamFoundation.Build.WebApi

Assembly:: Microsoft.TeamFoundation.Build2.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.

Caution

Use StatusBadgeController.GetStatusBadge

[Preview API] Gets a badge that indicates the status of the most recent build for a definition.

public virtual System.Threading.Tasks.Task<string> GetBadgeAsync (Guid project, int definitionId, string branchName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

[System.Obsolete("Use StatusBadgeController.GetStatusBadge")]
public virtual System.Threading.Tasks.Task<string> GetBadgeAsync (Guid project, int definitionId, string branchName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetBadgeAsync : Guid * int * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.GetBadgeAsync : Guid * int * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Parameters

project: Guid

The project ID or name.

definitionId: Int32

The ID of the definition.

branchName: String

The name of the branch.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<String>

Attributes: ObsoleteAttribute

Applies to

Share via