DashboardHttpClientBase Class

Definition

Namespace:

Microsoft.TeamFoundation.Dashboards.WebApi

Assembly:

Microsoft.TeamFoundation.Dashboards.WebApi.dll

[Microsoft.VisualStudio.Services.WebApi.ResourceArea("31C84E0A-3ECE-48FD-A29D-100849AF99BA")]
public abstract class DashboardHttpClientBase : Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase

type DashboardHttpClientBase = class
    inherit VssHttpClientBase

Public MustInherit Class DashboardHttpClientBase
Inherits VssHttpClientBase

Inheritance

Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase

DashboardHttpClientBase

Derived

Microsoft.TeamFoundation.Dashboards.WebApi.DashboardHttpClient

Attributes

Microsoft.VisualStudio.Services.WebApi.ResourceAreaAttribute

Constructors

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

Methods

Name	Description
CreateDashboardAsync(Dashboard, TeamContext, Object, CancellationToken)	[Preview API] Create the supplied dashboard.
CreateWidgetAsync(Widget, TeamContext, Guid, Object, CancellationToken)	[Preview API] Create a widget on the specified dashboard.
DeleteDashboardAsync(TeamContext, Guid, Object, CancellationToken)	[Preview API] Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.
DeleteWidgetAsync(TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Delete the specified widget.
GetDashboardAsync(TeamContext, Guid, Object, CancellationToken)	[Preview API] Get a dashboard by its ID.
GetDashboardsAsync(TeamContext, Object, CancellationToken)	[Preview API] Get a list of dashboards.
GetWidgetAsync(TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Get the current state of the specified widget.
GetWidgetMetadataAsync(String, Object, CancellationToken)	[Preview API] Get the widget metadata satisfying the specified contribution ID.
GetWidgetsAsync(TeamContext, Guid, String, Object, CancellationToken)	[Preview API] Get widgets contained on the specified dashboard.
GetWidgetTypesAsync(WidgetScope, Object, CancellationToken)	[Preview API] Get all available widget metadata in alphabetical order.
ReplaceDashboardAsync(Dashboard, TeamContext, Guid, Object, CancellationToken)	[Preview API] Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.
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.
ReplaceWidgetAsync(Widget, TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Override the state of the specified widget.
ReplaceWidgetsAsync(IEnumerable<Widget>, TeamContext, Guid, String, Object, CancellationToken)	[Preview API] Replace the widgets on specified dashboard with the supplied widgets.
UpdateWidgetAsync(Widget, TeamContext, Guid, Guid, Object, CancellationToken)	[Preview API] Perform a partial update of the specified widget.
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.