Struct azure_devops_rust_api::dashboard::models::WidgetMetadata

pub struct WidgetMetadata {

    pub allowed_sizes: Vec<WidgetSize>,
    pub analytics_service_required: Option<bool>,
    pub catalog_icon_url: Option<String>,
    pub catalog_info_url: Option<String>,
    pub configuration_contribution_id: Option<String>,
    pub configuration_contribution_relative_id: Option<String>,
    pub configuration_required: Option<bool>,
    pub content_uri: Option<String>,
    pub contribution_id: Option<String>,
    pub default_settings: Option<String>,
    pub description: Option<String>,
    pub is_enabled: Option<bool>,
    pub is_name_configurable: Option<bool>,
    pub is_visible_from_catalog: Option<bool>,
    pub keywords: Vec<String>,
    pub lightbox_options: Option<LightboxOptions>,
    pub loading_image_url: Option<String>,
    pub name: Option<String>,
    pub publisher_name: Option<String>,
    pub supported_scopes: Vec<Value>,
    pub tags: Vec<String>,
    pub targets: Vec<String>,
    pub type_id: Option<String>,
}

Contribution based information describing Dashboard Widgets.

Fields

allowed_sizes: Vec<WidgetSize>

Sizes supported by the Widget.

analytics_service_required: Option<bool>

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.

catalog_icon_url: Option<String>

Resource for an icon in the widget catalog.

catalog_info_url: Option<String>

Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted

configuration_contribution_id: Option<String>

The id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.

configuration_contribution_relative_id: Option<String>

The relative id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.

configuration_required: Option<bool>

Indicates if the widget requires configuration before being added to dashboard.

content_uri: Option<String>

Uri for the widget content to be loaded from .

contribution_id: Option<String>

The id of the underlying contribution defining the supplied Widget.

default_settings: Option<String>

Optional default settings to be copied into widget settings.

description: Option<String>

Summary information describing the widget.

is_enabled: Option<bool>

Widgets can be disabled by the app store. We’ll need to gracefully handle for: - persistence (Allow) - Requests (Tag as disabled, and provide context)

is_name_configurable: Option<bool>

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.

is_visible_from_catalog: Option<bool>

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.

keywords: Vec<String>

Keywords associated with this widget, non-filterable and invisible

lightbox_options: Option<LightboxOptions>

Lightbox configuration

loading_image_url: Option<String>

Resource for a loading placeholder image on dashboard

name: Option<String>

User facing name of the widget type. Each widget must use a unique value here.

publisher_name: Option<String>

Publisher Name of this kind of widget.

supported_scopes: Vec<Value>

Data contract required for the widget to function and to work in its container.

tags: Vec<String>

Tags associated with this widget, visible on each widget and filterable.

targets: Vec<String>

Contribution target IDs

type_id: Option<String>

Deprecated: locally unique developer-facing id of this kind of widget. ContributionId provides a globally unique identifier for widget types.

Implementations

impl WidgetMetadata

pub fn new() -> Self

Trait Implementations

impl Clone for WidgetMetadata

fn clone(&self) -> WidgetMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WidgetMetadata

fn default() -> WidgetMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WidgetMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WidgetMetadata

fn eq(&self, other: &WidgetMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WidgetMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WidgetMetadata