DashboardHttpClient Class

Definition

Namespace:

Microsoft.TeamFoundation.Dashboards.WebApi

Assembly:

Microsoft.TeamFoundation.Dashboards.WebApi.dll

Client proxy for the dashboard REST interface.

public sealed class DashboardHttpClient : Microsoft.TeamFoundation.Dashboards.WebApi.DashboardHttpClientBase

type DashboardHttpClient = class
    inherit DashboardHttpClientBase

Public NotInheritable Class DashboardHttpClient
Inherits DashboardHttpClientBase

Inheritance

Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase

DashboardHttpClientBase

DashboardHttpClient

Constructors

Name	Description
DashboardHttpClient(Uri, HttpMessageHandler, Boolean)
DashboardHttpClient(Uri, VssCredentials, DelegatingHandler[])
DashboardHttpClient(Uri, VssCredentials, VssHttpRequestSettings, DelegatingHandler[])
DashboardHttpClient(Uri, VssCredentials, VssHttpRequestSettings)
DashboardHttpClient(Uri, VssCredentials)

Methods

Name	Description
CreateDashboardAsync(Dashboard, TeamContext, Object, CancellationToken)	[Preview API] Create the supplied dashboard. (Inherited from DashboardHttpClientBase)
CreateWidgetAsync(Widget, TeamContext, Guid, Object, CancellationToken)	[Preview API] Create a widget on the specified dashboard. (Inherited from DashboardHttpClientBase)
DeleteDashboardAsync(TeamContext, Guid, Object, CancellationToken)	[Preview API] Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard. (Inherited from DashboardHttpClientBase)
DeleteWidgetAsync(TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Delete the specified widget. (Inherited from DashboardHttpClientBase)
GetDashboardAsync(TeamContext, Guid, Object, CancellationToken)	[Preview API] Get a dashboard by its ID. (Inherited from DashboardHttpClientBase)
GetDashboardsAsync(TeamContext, Object, CancellationToken)	[Preview API] Get a list of dashboards. (Inherited from DashboardHttpClientBase)
GetWidgetAsync(TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Get the current state of the specified widget. (Inherited from DashboardHttpClientBase)
GetWidgetMetadataAsync(String, Object, CancellationToken)	[Preview API] Get the widget metadata satisfying the specified contribution ID. (Inherited from DashboardHttpClientBase)
GetWidgetsAsync(TeamContext, Guid, String, Object, CancellationToken)	[Preview API] Get widgets contained on the specified dashboard. (Inherited from DashboardHttpClientBase)
GetWidgetTypesAsync(WidgetScope, Object, CancellationToken)	[Preview API] Get all available widget metadata in alphabetical order. (Inherited from DashboardHttpClientBase)
ReplaceDashboardAsync(Dashboard, TeamContext, Guid, Object, CancellationToken)	[Preview API] Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied. (Inherited from DashboardHttpClientBase)
ReplaceDashboardsAsync(DashboardGroup, TeamContext, Object, CancellationToken)	[Preview API] Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content. (Inherited from DashboardHttpClientBase)
ReplaceWidgetAsync(Widget, TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Override the state of the specified widget. (Inherited from DashboardHttpClientBase)
ReplaceWidgetsAsync(IEnumerable<Widget>, TeamContext, Guid, String, Object, CancellationToken)	[Preview API] Replace the widgets on specified dashboard with the supplied widgets. (Inherited from DashboardHttpClientBase)
UpdateWidgetAsync(Widget, TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Perform a partial update of the specified widget. (Inherited from DashboardHttpClientBase)
UpdateWidgetsAsync(IEnumerable<Widget>, TeamContext, Guid, String, Object, CancellationToken)	[Preview API] Update the supplied widgets on the dashboard using supplied state. State of existing Widgets not passed in the widget list is preserved. (Inherited from DashboardHttpClientBase)