WidgetMetadata Class

Definition

Namespace:

Microsoft.TeamFoundation.Dashboards.WebApi

Assembly:

Microsoft.TeamFoundation.Dashboards.WebApi.dll

Contribution based information describing Dashboard Widgets.

[System.Runtime.Serialization.DataContract]
public class WidgetMetadata : Microsoft.TeamFoundation.Dashboards.WebApi.DashboardSecuredObject

type WidgetMetadata = class
    inherit DashboardSecuredObject

Public Class WidgetMetadata
Inherits DashboardSecuredObject

Inheritance

Object

DashboardSecuredObject

WidgetMetadata

Attributes

DataContractAttribute

Constructors

Name	Description
WidgetMetadata()

Properties

Name	Description
AllowedSizes	Sizes supported by the Widget.
AnalyticsServiceRequired	Opt-in boolean that indicates if the widget requires the Analytics Service to function. Widgets requiring the analytics service are hidden from the catalog if the Analytics Service is not available.
CanStoreCrossProjectSettings	Advanced widgets can store settings referring across projects Non member users can only access information within the current project. Where this is opted in, and "hasNoCrossProjectReferences" is set true, the framework will selectively permit trusted single project configurations. If active, and hasNoCrossProjectReferences is false or null, widget settings will be cleared.
CatalogIconUrl	Resource for an icon in the widget catalog.
CatalogInfoUrl	Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted
ConfigurationContributionId	The id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.
ConfigurationContributionRelativeId	The relative id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.
ConfigurationRequired	Indicates if the widget requires configuration before being added to dashboard.
ContentUri	Uri for the widget content to be loaded from .
ContributionId	The id of the underlying contribution defining the supplied Widget.
DefaultSettings	Optional default settings to be copied into widget settings.
Description	Summary information describing the widget.
IsEnabled	Widgets can be disabled by the app store. We'll need to gracefully handle for: persistence (Allow) Requests (Tag as disabled, and provide context)
IsNameConfigurable	Opt-out boolean that indicates if the widget supports widget name/title configuration. Widgets ignoring the name should set it to false in the manifest.
IsVisibleFromCatalog	Opt-out boolean indicating if the widget is hidden from the catalog. Commonly, this is used to allow developers to disable creation of a deprecated widget. A widget must have a functional default state, or have a configuration experience, in order to be visible from the catalog.
LightboxOptions	Opt-in properties for customizing widget presentation in a "lightbox" dialog.
LoadingImageUrl	Resource for a loading placeholder image on dashboard
Name	User facing name of the widget type. Each widget must use a unique value here.
PublisherName	Publisher Name of this kind of widget.
SupportedScopes	Data contract required for the widget to function and to work in its container.
Targets	Contribution target IDs
TypeId	Deprecated: locally unique developer-facing id of this kind of widget. ContributionId provides a globally unique identifier for widget types.

Methods

Name	Description
CloneWithSecuredObject(ISecuredObject)
CreateDisabledInstance(String)	Produces a canonical "Disabled" Metadata entry.
IsValid()
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)