WidgetResponse Class

Definition

Namespace:

Microsoft.TeamFoundation.Dashboards.WebApi

Assembly:

Microsoft.TeamFoundation.Dashboards.WebApi.dll

Response from RestAPI when saving and editing Widget

[System.Runtime.Serialization.DataContract]
public class WidgetResponse : Microsoft.TeamFoundation.Dashboards.WebApi.Widget

type WidgetResponse = class
    inherit Widget

Public Class WidgetResponse
Inherits Widget

Inheritance

Object

DashboardSecuredObject

Widget

WidgetResponse

Attributes

DataContractAttribute

Constructors

Name	Description
WidgetResponse()
WidgetResponse(Widget, String)

Properties

Name	Description
AllowedSizes	Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget (Inherited from Widget)
AreSettingsBlockedForUser	Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user. (Inherited from Widget)
ArtifactId	Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact. (Inherited from Widget)
CanStoreCrossProjectSettings	(Inherited from Widget)
ConfigurationContributionId	(Inherited from Widget)
ConfigurationContributionRelativeId	(Inherited from Widget)
ContentUri	(Inherited from Widget)
ContributionId	The id of the underlying contribution defining the supplied Widget Configuration. (Inherited from Widget)
Dashboard	Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs (Inherited from Widget)
ETag	(Inherited from Widget)
Id	(Inherited from Widget)
IsEnabled	(Inherited from Widget)
IsNameConfigurable	(Inherited from Widget)
LightboxOptions	(Inherited from Widget)
Links	(Inherited from Widget)
LoadingImageUrl	(Inherited from Widget)
Name	(Inherited from Widget)
Position	(Inherited from Widget)
Settings	(Inherited from Widget)
SettingsVersion	(Inherited from Widget)
Size	(Inherited from Widget)
TypeId	(Inherited from Widget)
Url	(Inherited from Widget)

Methods

Name	Description
IsNew()	(Inherited from Widget)
IsPositioned()	(Inherited from Widget)
SetMetaData(WidgetMetadata)	Applies metadata about the widget. If metadata is not enabled for the current user, omit the settings payload, to protect widgets which have not explicitly been targeted for public use. (Settings only matter to enabled widgets) (Inherited from Widget)
SetSecuredChildren(ISecuredObject)	(Inherited from Widget)
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)