Dashboard Class
Definition
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.
Model of a Dashboard.
[System.Runtime.Serialization.DataContract]
public class Dashboard : Microsoft.TeamFoundation.Dashboards.WebApi.DashboardSecuredObjecttype Dashboard = class
inherit DashboardSecuredObjectPublic Class Dashboard
Inherits DashboardSecuredObject- Inheritance
- Derived
- Attributes
Constructors
| Name | Description |
|---|---|
| Dashboard() | |
| Dashboard(DashboardGroupEntry) | |
| Dashboard(IEnumerable<Widget>) | |
| Dashboard(String) | |
Properties
| Name | Description |
|---|---|
| Description |
Description of the dashboard. |
| ETag |
Server defined version tracking value, used for edit collision detection. |
| Id |
ID of the Dashboard. Provided by service at creation time. |
| Links | |
| Name |
Name of the 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. |
| Position |
Position of the dashboard, within a dashboard group. If unset at creation time, position is decided by the service. |
| RefreshInterval |
Interval for client to automatically refresh the dashboard. Expressed in minutes. |
| Url | |
| Widgets |
The set of Widgets on the dashboard. |
Methods
| Name | Description |
|---|---|
| IsNew() |
Describes if the Dashboard is newly created. |
| SetSecuredChildren(ISecuredObject) | |
| 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) |