WidgetMetadata interface

Paket:

azure-devops-extension-api

Informasi berbasis kontribusi yang menjelaskan Widget Dasbor.

Properti

allowedSizes	Ukuran yang didukung oleh Widget.
analyticsServiceRequired	Boolean keikutsertaan yang menunjukkan apakah widget memerlukan Layanan Analitik untuk berfungsi. Widget yang memerlukan layanan analitik disembunyikan dari katalog jika Layanan Analitik tidak tersedia.
catalogIconUrl	Sumber daya untuk ikon di katalog widget.
catalogInfoUrl	String URL keikutsertaan menunjuk pada informasi widget. Default ke URL marketplace ekstensi jika dihilangkan
configurationContributionId	Id kontribusi yang mendasar yang menentukan UI konfigurasi kustom Widget yang disediakan. Null jika UI konfigurasi kustom tidak tersedia.
configurationContributionRelativeId	Id relatif dari kontribusi yang mendasar yang menentukan UI konfigurasi kustom Widget yang disediakan. Null jika UI konfigurasi kustom tidak tersedia.
configurationRequired	Menunjukkan apakah widget memerlukan konfigurasi sebelum ditambahkan ke dasbor.
contentUri	Uri untuk konten widget yang akan dimuat dari .
contributionId	Id kontribusi yang mendasar yang menentukan Widget yang disediakan.
defaultSettings	Pengaturan default opsional yang akan disalin ke dalam pengaturan widget.
description	Informasi ringkasan yang menjelaskan widget.
isEnabled	Widget dapat dinonaktifkan oleh penyimpanan aplikasi. Kita harus menangani dengan baik untuk: - persistensi (Izinkan) - Permintaan (Tag sebagai dinonaktifkan, dan memberikan konteks)
isNameConfigurable	Boolean opt-out yang menunjukkan apakah widget mendukung konfigurasi nama/judul widget. Widget yang mengabaikan nama harus mengaturnya ke false dalam manifes.
isVisibleFromCatalog	Memilih keluar boolean yang menunjukkan apakah widget disembunyikan dari katalog. Umumnya, ini digunakan untuk memungkinkan pengembang menonaktifkan pembuatan widget yang tidak digunakan lagi. Widget harus memiliki status default fungsi, atau memiliki pengalaman konfigurasi, agar terlihat dari katalog.
keywords	Kata kunci yang terkait dengan widget ini, tidak dapat difilter dan tidak terlihat
lightboxOptions	Properti keikutsertaan untuk menyesuaikan presentasi widget dalam dialog "lightbox".
loadingImageUrl	Sumber daya untuk gambar tempat penampung pemuatan di dasbor
name	Nama pengguna yang menghadap ke jenis widget. Setiap widget harus menggunakan nilai unik di sini.
publisherName	Nama Penerbit widget semacam ini.
supportedScopes	Kontrak data yang diperlukan agar widget berfungsi dan berfungsi dalam kontainernya.
tags	Tag yang terkait dengan widget ini, terlihat pada setiap widget dan dapat difilter.
targets	ID target kontribusi
typeId	Tidak digunakan lagi: id menghadap pengembang yang unik secara lokal dari widget semacam ini. ContributionId menyediakan pengidentifikasi unik global untuk jenis widget.

Detail Properti

allowedSizes

Ukuran yang didukung oleh Widget.

allowedSizes: WidgetSize[]

Nilai Properti

WidgetSize[]

analyticsServiceRequired

Boolean keikutsertaan yang menunjukkan apakah widget memerlukan Layanan Analitik untuk berfungsi. Widget yang memerlukan layanan analitik disembunyikan dari katalog jika Layanan Analitik tidak tersedia.

analyticsServiceRequired: boolean

Nilai Properti

boolean

catalogIconUrl

Sumber daya untuk ikon di katalog widget.

catalogIconUrl: string

Nilai Properti

string

catalogInfoUrl

String URL keikutsertaan menunjuk pada informasi widget. Default ke URL marketplace ekstensi jika dihilangkan

catalogInfoUrl: string

Nilai Properti

string

configurationContributionId

Id kontribusi yang mendasar yang menentukan UI konfigurasi kustom Widget yang disediakan. Null jika UI konfigurasi kustom tidak tersedia.

configurationContributionId: string

Nilai Properti

string

configurationContributionRelativeId

Id relatif dari kontribusi yang mendasar yang menentukan UI konfigurasi kustom Widget yang disediakan. Null jika UI konfigurasi kustom tidak tersedia.

configurationContributionRelativeId: string

Nilai Properti

string

configurationRequired

Menunjukkan apakah widget memerlukan konfigurasi sebelum ditambahkan ke dasbor.

configurationRequired: boolean

Nilai Properti

boolean

contentUri

Uri untuk konten widget yang akan dimuat dari .

contentUri: string

Nilai Properti

string

contributionId

Id kontribusi yang mendasar yang menentukan Widget yang disediakan.

contributionId: string

Nilai Properti

string

defaultSettings

Pengaturan default opsional yang akan disalin ke dalam pengaturan widget.

defaultSettings: string

Nilai Properti

string

description

Informasi ringkasan yang menjelaskan widget.

description: string

Nilai Properti

string

isEnabled

Widget dapat dinonaktifkan oleh penyimpanan aplikasi. Kita harus menangani dengan baik untuk: - persistensi (Izinkan) - Permintaan (Tag sebagai dinonaktifkan, dan memberikan konteks)

isEnabled: boolean

Nilai Properti

boolean

isNameConfigurable

Boolean opt-out yang menunjukkan apakah widget mendukung konfigurasi nama/judul widget. Widget yang mengabaikan nama harus mengaturnya ke false dalam manifes.

isNameConfigurable: boolean

Nilai Properti

boolean

isVisibleFromCatalog

Memilih keluar boolean yang menunjukkan apakah widget disembunyikan dari katalog. Umumnya, ini digunakan untuk memungkinkan pengembang menonaktifkan pembuatan widget yang tidak digunakan lagi. Widget harus memiliki status default fungsi, atau memiliki pengalaman konfigurasi, agar terlihat dari katalog.

isVisibleFromCatalog: boolean

Nilai Properti

boolean

keywords

Kata kunci yang terkait dengan widget ini, tidak dapat difilter dan tidak terlihat

keywords: string[]

Nilai Properti

string[]

lightboxOptions

Properti keikutsertaan untuk menyesuaikan presentasi widget dalam dialog "lightbox".

lightboxOptions: LightboxOptions

Nilai Properti

LightboxOptions

loadingImageUrl

Sumber daya untuk gambar tempat penampung pemuatan di dasbor

loadingImageUrl: string

Nilai Properti

string

name

Nama pengguna yang menghadap ke jenis widget. Setiap widget harus menggunakan nilai unik di sini.

name: string

Nilai Properti

string

publisherName

Nama Penerbit widget semacam ini.

publisherName: string

Nilai Properti

string

supportedScopes

Kontrak data yang diperlukan agar widget berfungsi dan berfungsi dalam kontainernya.

supportedScopes: WidgetScope[]

Nilai Properti

WidgetScope[]

tags

Tag yang terkait dengan widget ini, terlihat pada setiap widget dan dapat difilter.

tags: string[]

Nilai Properti

string[]

targets

ID target kontribusi

targets: string[]

Nilai Properti

string[]

typeId

Tidak digunakan lagi: id menghadap pengembang yang unik secara lokal dari widget semacam ini. ContributionId menyediakan pengidentifikasi unik global untuk jenis widget.

typeId: string

Nilai Properti

string