WidgetMetadata interface

Пакет:

azure-devops-extension-api

Сведения на основе вкладов, описывающие мини-приложения панели мониторинга.

Свойства

allowedSizes	Размеры, поддерживаемые мини-приложением.
analyticsServiceRequired	Логическое согласие, указывающее, требуется ли для работы службы аналитики мини-приложение. Мини-приложения, требующие службы аналитики, скрыты из каталога, если служба аналитики недоступна.
catalogIconUrl	Ресурс для значка в каталоге мини-приложений.
catalogInfoUrl	Строка URL-адреса, указывающая на сведения о мини-приложении. Значение по умолчанию для URL-адреса Marketplace, если опущено
configurationContributionId	Идентификатор базового вклада, определяющий предоставленный пользовательский пользовательский интерфейс конфигурации мини-приложения. Значение NULL, если пользовательский пользовательский интерфейс конфигурации недоступен.
configurationContributionRelativeId	Относительный идентификатор базового вклада, определяющий предоставленный пользовательский интерфейс конфигурации мини-приложения. Значение NULL, если пользовательский пользовательский интерфейс конфигурации недоступен.
configurationRequired	Указывает, требуется ли мини-приложение конфигурации перед добавлением на панель мониторинга.
contentUri	Uri для загрузки содержимого мини-приложения.
contributionId	Идентификатор базового вклада, определяющего предоставленное мини-приложение.
defaultSettings	Необязательные параметры по умолчанию для копирования в параметры мини-приложения.
description	Сводка сведений о мини-приложении.
isEnabled	Мини-приложения можно отключить в магазине приложений. Нам потребуется корректно обрабатывать: — сохраняемость (разрешить) — запросы (тег как отключенные и предоставьте контекст)
isNameConfigurable	Отказ от логическое значение, указывающее, поддерживает ли мини-приложение конфигурацию имени или заголовка мини-приложения. Мини-приложения, игнорирующие имя, должны задать для него значение false в манифесте.
isVisibleFromCatalog	Отказ от логическое значение, указывающее, скрыт ли мини-приложение из каталога. Обычно это позволяет разработчикам отключать создание устаревшего мини-приложения. Мини-приложение должно иметь функциональное состояние по умолчанию или иметь интерфейс конфигурации, чтобы быть видимым из каталога.
keywords	Ключевые слова, связанные с этим мини-приложением, нефильтруемыми и невидимыми
lightboxOptions	Свойства выбора для настройки презентации мини-приложения в диалоговом окне "lightbox".
loadingImageUrl	Ресурс для изображения заполнителя загрузки на панели мониторинга
name	Имя пользователя типа мини-приложения. Каждое мини-приложение должно использовать уникальное значение здесь.
publisherName	Имя издателя этого типа мини-приложения.
supportedScopes	Контракт данных, необходимый для работы мини-приложения и работы в контейнере.
tags	Теги, связанные с этим мини-приложением, видимые на каждом мини-приложении и доступные для фильтрации.
targets	Идентификаторы целевых идентификаторов вкладов
typeId	Устаревший: локальный уникальный идентификатор для разработчика такого типа мини-приложения. ContributionId предоставляет глобальный уникальный идентификатор для типов мини-приложений.

Сведения о свойстве

allowedSizes

Размеры, поддерживаемые мини-приложением.

allowedSizes: WidgetSize[]

Значение свойства

WidgetSize[]

analyticsServiceRequired

Логическое согласие, указывающее, требуется ли для работы службы аналитики мини-приложение. Мини-приложения, требующие службы аналитики, скрыты из каталога, если служба аналитики недоступна.

analyticsServiceRequired: boolean

Значение свойства

boolean

catalogIconUrl

Ресурс для значка в каталоге мини-приложений.

catalogIconUrl: string

Значение свойства

string

catalogInfoUrl

Строка URL-адреса, указывающая на сведения о мини-приложении. Значение по умолчанию для URL-адреса Marketplace, если опущено

catalogInfoUrl: string

Значение свойства

string

configurationContributionId

Идентификатор базового вклада, определяющий предоставленный пользовательский пользовательский интерфейс конфигурации мини-приложения. Значение NULL, если пользовательский пользовательский интерфейс конфигурации недоступен.

configurationContributionId: string

Значение свойства

string

configurationContributionRelativeId

Относительный идентификатор базового вклада, определяющий предоставленный пользовательский интерфейс конфигурации мини-приложения. Значение NULL, если пользовательский пользовательский интерфейс конфигурации недоступен.

configurationContributionRelativeId: string

Значение свойства

string

configurationRequired

Указывает, требуется ли мини-приложение конфигурации перед добавлением на панель мониторинга.

configurationRequired: boolean

Значение свойства

boolean

contentUri

Uri для загрузки содержимого мини-приложения.

contentUri: string

Значение свойства

string

contributionId

Идентификатор базового вклада, определяющего предоставленное мини-приложение.

contributionId: string

Значение свойства

string

defaultSettings

Необязательные параметры по умолчанию для копирования в параметры мини-приложения.

defaultSettings: string

Значение свойства

string

description

Сводка сведений о мини-приложении.

description: string

Значение свойства

string

isEnabled

Мини-приложения можно отключить в магазине приложений. Нам потребуется корректно обрабатывать: — сохраняемость (разрешить) — запросы (тег как отключенные и предоставьте контекст)

isEnabled: boolean

Значение свойства

boolean

isNameConfigurable

Отказ от логическое значение, указывающее, поддерживает ли мини-приложение конфигурацию имени или заголовка мини-приложения. Мини-приложения, игнорирующие имя, должны задать для него значение false в манифесте.

isNameConfigurable: boolean

Значение свойства

boolean

isVisibleFromCatalog

Отказ от логическое значение, указывающее, скрыт ли мини-приложение из каталога. Обычно это позволяет разработчикам отключать создание устаревшего мини-приложения. Мини-приложение должно иметь функциональное состояние по умолчанию или иметь интерфейс конфигурации, чтобы быть видимым из каталога.

isVisibleFromCatalog: boolean

Значение свойства

boolean

keywords

Ключевые слова, связанные с этим мини-приложением, нефильтруемыми и невидимыми

keywords: string[]

Значение свойства

string[]

lightboxOptions

Свойства выбора для настройки презентации мини-приложения в диалоговом окне "lightbox".

lightboxOptions: LightboxOptions

Значение свойства

LightboxOptions

loadingImageUrl

Ресурс для изображения заполнителя загрузки на панели мониторинга

loadingImageUrl: string

Значение свойства

string

name

Имя пользователя типа мини-приложения. Каждое мини-приложение должно использовать уникальное значение здесь.

name: string

Значение свойства

string

publisherName

Имя издателя этого типа мини-приложения.

publisherName: string

Значение свойства

string

supportedScopes

Контракт данных, необходимый для работы мини-приложения и работы в контейнере.

supportedScopes: WidgetScope[]

Значение свойства

WidgetScope[]

tags

Теги, связанные с этим мини-приложением, видимые на каждом мини-приложении и доступные для фильтрации.

tags: string[]

Значение свойства

string[]

targets

Идентификаторы целевых идентификаторов вкладов

targets: string[]

Значение свойства

string[]

typeId

Устаревший: локальный уникальный идентификатор для разработчика такого типа мини-приложения. ContributionId предоставляет глобальный уникальный идентификатор для типов мини-приложений.

typeId: string

Значение свойства

string