WidgetMetadata interface

Pakiet:

azure-devops-extension-api

Informacje oparte na współtworzeniu opisujące widżety pulpitu nawigacyjnego.

Właściwości

allowedSizes	Rozmiary obsługiwane przez widżet.
analyticsServiceRequired	Wyrażenie zgody na wartość logiczną, która wskazuje, czy widżet wymaga, aby usługa Analytics działała. Widżety wymagające usługi analitycznej są ukryte w katalogu, jeśli usługa analizy jest niedostępna.
catalogIconUrl	Zasób ikony w wykazie widżetów.
catalogInfoUrl	Ciąg adresu URL zgody wskazujący informacje o widżecie. Domyślnie jest to adres URL witryny Marketplace rozszerzeń, jeśli pominięto
configurationContributionId	Identyfikator bazowego współtworzenia definiujący podany interfejs użytkownika konfiguracji niestandardowej widżetu. Wartość null, jeśli interfejs użytkownika konfiguracji niestandardowej jest niedostępny.
configurationContributionRelativeId	Względny identyfikator bazowego współtworzenia definiujący podany interfejs użytkownika konfiguracji niestandardowej widżetu. Wartość null, jeśli interfejs użytkownika konfiguracji niestandardowej jest niedostępny.
configurationRequired	Wskazuje, czy widżet wymaga konfiguracji przed dodaniu do pulpitu nawigacyjnego.
contentUri	Identyfikator URI zawartości widżetu do załadowania z elementu .
contributionId	Identyfikator bazowego współtworzenia definiującego podany widżet.
defaultSettings	Opcjonalne ustawienia domyślne, które mają być kopiowane do ustawień widżetu.
description	Podsumowanie informacji opisujących widżet.
isEnabled	Widżety można wyłączyć w sklepie z aplikacjami. Będziemy musieli bezpiecznie obsługiwać następujące elementy: — trwałość (Zezwalaj) — Żądania (tag jako wyłączone i podaj kontekst)
isNameConfigurable	Zrezygnuj z wartości logicznej, która wskazuje, czy widżet obsługuje konfigurację nazwy/tytułu widżetu. Widżety ignorujące nazwę powinny ustawić na wartość false w manifeście.
isVisibleFromCatalog	Wartość logiczna rezygnacji wskazująca, czy widżet jest ukryty w wykazie. Często jest to używane w celu umożliwienia deweloperom wyłączenia tworzenia przestarzałego widżetu. Widżet musi mieć stan domyślny funkcjonalny lub mieć środowisko konfiguracji, aby był widoczny z wykazu.
keywords	Słowa kluczowe skojarzone z tym widżetem, niefiltrowalne i niewidoczne
lightboxOptions	Wybieranie właściwości dostosowywania prezentacji widżetu w oknie dialogowym "lightbox".
loadingImageUrl	Zasób ładowania obrazu zastępczego na pulpicie nawigacyjnym
name	Nazwa widżetu wyświetlana dla użytkownika. W tym miejscu każdy widżet musi używać unikatowej wartości.
publisherName	Nazwa wydawcy tego rodzaju widżetu.
supportedScopes	Kontrakt danych wymagany do działania widżetu i pracy w kontenerze.
tags	Tagi skojarzone z tym widżetem, widoczne dla każdego widżetu i filtrowalne.
targets	Identyfikatory obiektów docelowych współtworzenia
typeId	Przestarzałe: lokalnie unikatowy identyfikator widżetu dostępnego dla deweloperów. Identyfikator ContributionId udostępnia globalnie unikatowy identyfikator typów widżetów.

Szczegóły właściwości

allowedSizes

Rozmiary obsługiwane przez widżet.

allowedSizes: WidgetSize[]

Wartość właściwości

WidgetSize[]

analyticsServiceRequired

Wyrażenie zgody na wartość logiczną, która wskazuje, czy widżet wymaga, aby usługa Analytics działała. Widżety wymagające usługi analitycznej są ukryte w katalogu, jeśli usługa analizy jest niedostępna.

analyticsServiceRequired: boolean

Wartość właściwości

boolean

catalogIconUrl

Zasób ikony w wykazie widżetów.

catalogIconUrl: string

Wartość właściwości

string

catalogInfoUrl

Ciąg adresu URL zgody wskazujący informacje o widżecie. Domyślnie jest to adres URL witryny Marketplace rozszerzeń, jeśli pominięto

catalogInfoUrl: string

Wartość właściwości

string

configurationContributionId

Identyfikator bazowego współtworzenia definiujący podany interfejs użytkownika konfiguracji niestandardowej widżetu. Wartość null, jeśli interfejs użytkownika konfiguracji niestandardowej jest niedostępny.

configurationContributionId: string

Wartość właściwości

string

configurationContributionRelativeId

Względny identyfikator bazowego współtworzenia definiujący podany interfejs użytkownika konfiguracji niestandardowej widżetu. Wartość null, jeśli interfejs użytkownika konfiguracji niestandardowej jest niedostępny.

configurationContributionRelativeId: string

Wartość właściwości

string

configurationRequired

Wskazuje, czy widżet wymaga konfiguracji przed dodaniu do pulpitu nawigacyjnego.

configurationRequired: boolean

Wartość właściwości

boolean

contentUri

Identyfikator URI zawartości widżetu do załadowania z elementu .

contentUri: string

Wartość właściwości

string

contributionId

Identyfikator bazowego współtworzenia definiującego podany widżet.

contributionId: string

Wartość właściwości

string

defaultSettings

Opcjonalne ustawienia domyślne, które mają być kopiowane do ustawień widżetu.

defaultSettings: string

Wartość właściwości

string

description

Podsumowanie informacji opisujących widżet.

description: string

Wartość właściwości

string

isEnabled

Widżety można wyłączyć w sklepie z aplikacjami. Będziemy musieli bezpiecznie obsługiwać następujące elementy: — trwałość (Zezwalaj) — Żądania (tag jako wyłączone i podaj kontekst)

isEnabled: boolean

Wartość właściwości

boolean

isNameConfigurable

Zrezygnuj z wartości logicznej, która wskazuje, czy widżet obsługuje konfigurację nazwy/tytułu widżetu. Widżety ignorujące nazwę powinny ustawić na wartość false w manifeście.

isNameConfigurable: boolean

Wartość właściwości

boolean

isVisibleFromCatalog

Wartość logiczna rezygnacji wskazująca, czy widżet jest ukryty w wykazie. Często jest to używane w celu umożliwienia deweloperom wyłączenia tworzenia przestarzałego widżetu. Widżet musi mieć stan domyślny funkcjonalny lub mieć środowisko konfiguracji, aby był widoczny z wykazu.

isVisibleFromCatalog: boolean

Wartość właściwości

boolean

keywords

Słowa kluczowe skojarzone z tym widżetem, niefiltrowalne i niewidoczne

keywords: string[]

Wartość właściwości

string[]

lightboxOptions

Wybieranie właściwości dostosowywania prezentacji widżetu w oknie dialogowym "lightbox".

lightboxOptions: LightboxOptions

Wartość właściwości

LightboxOptions

loadingImageUrl

Zasób ładowania obrazu zastępczego na pulpicie nawigacyjnym

loadingImageUrl: string

Wartość właściwości

string

name

Nazwa widżetu wyświetlana dla użytkownika. W tym miejscu każdy widżet musi używać unikatowej wartości.

name: string

Wartość właściwości

string

publisherName

Nazwa wydawcy tego rodzaju widżetu.

publisherName: string

Wartość właściwości

string

supportedScopes

Kontrakt danych wymagany do działania widżetu i pracy w kontenerze.

supportedScopes: WidgetScope[]

Wartość właściwości

WidgetScope[]

tags

Tagi skojarzone z tym widżetem, widoczne dla każdego widżetu i filtrowalne.

tags: string[]

Wartość właściwości

string[]

targets

Identyfikatory obiektów docelowych współtworzenia

targets: string[]

Wartość właściwości

string[]

typeId

Przestarzałe: lokalnie unikatowy identyfikator widżetu dostępnego dla deweloperów. Identyfikator ContributionId udostępnia globalnie unikatowy identyfikator typów widżetów.

typeId: string

Wartość właściwości

string