Language

DashboardResponse Class

Definition

[System.Runtime.Serialization.DataContract]
public class DashboardResponse : Microsoft.TeamFoundation.Dashboards.WebApi.DashboardGroupEntry
type DashboardResponse = class
    inherit DashboardGroupEntry
Public Class DashboardResponse
Inherits DashboardGroupEntry
Inheritance
Attributes

Constructors

Name Description
DashboardResponse()
DashboardResponse(IEnumerable<WidgetResponse>, DashboardGroupEntry, String)

Properties

Name Description
Description

Description of the dashboard.

(Inherited from Dashboard)
ETag

Server defined version tracking value, used for edit collision detection.

(Inherited from Dashboard)
Id

ID of the Dashboard. Provided by service at creation time.

(Inherited from Dashboard)
Links (Inherited from Dashboard)
Name

Name of the Dashboard.

(Inherited from Dashboard)
OwnerId

ID of the Owner for a dashboard. For any legacy dashboards, this would be the unique identifier for the team associated with the dashboard.

(Inherited from Dashboard)
Position

Position of the dashboard, within a dashboard group. If unset at creation time, position is decided by the service.

(Inherited from Dashboard)
RefreshInterval

Interval for client to automatically refresh the dashboard. Expressed in minutes.

(Inherited from Dashboard)
Url (Inherited from Dashboard)
Widgets

The set of Widgets on the dashboard.

(Inherited from Dashboard)

Methods

Name Description
IsNew()

Describes if the Dashboard is newly created.

(Inherited from Dashboard)
SetSecuredChildren(ISecuredObject) (Inherited from Dashboard)
SetSecuredObject(ISecuredObject)

Operation to populate SecuredObject Info on object and all children with same security state.

(Inherited from DashboardSecuredObject)

Explicit Interface Implementations

Name Description
ISecuredObject.GetToken() (Inherited from DashboardSecuredObject)
ISecuredObject.NamespaceId (Inherited from DashboardSecuredObject)
ISecuredObject.RequiredPermissions (Inherited from DashboardSecuredObject)

Applies to