WidgetMetadata interface

패키지:

azure-devops-extension-api

대시보드 위젯을 설명하는 기여 기반 정보입니다.

속성

allowedSizes	위젯에서 지원하는 크기입니다.
analyticsServiceRequired	위젯에 Analytics Service가 작동해야 하는지 여부를 나타내는 옵트인 부울입니다. 분석 서비스를 사용할 수 없는 경우 분석 서비스가 필요한 위젯은 카탈로그에서 숨겨집니다.
catalogIconUrl	위젯 카탈로그의 아이콘에 대한 리소스입니다.
catalogInfoUrl	위젯 정보를 가리키는 옵트인 URL 문자열입니다. 생략된 경우 기본값은 확장 마켓플레이스 URL로 설정됩니다.
configurationContributionId	제공된 위젯 사용자 지정 구성 UI를 정의하는 기본 기여의 ID입니다. 사용자 지정 구성 UI를 사용할 수 없는 경우 Null입니다.
configurationContributionRelativeId	제공된 위젯 사용자 지정 구성 UI를 정의하는 기본 기여의 상대 ID입니다. 사용자 지정 구성 UI를 사용할 수 없는 경우 Null입니다.
configurationRequired	대시보드에 추가되기 전에 위젯에 구성이 필요한지 나타냅니다.
contentUri	에서 로드할 위젯 콘텐츠의 URI입니다.
contributionId	제공된 위젯을 정의하는 기본 기여의 ID입니다.
defaultSettings	위젯 설정에 복사할 선택적 기본 설정입니다.
description	위젯을 설명하는 요약 정보입니다.
isEnabled	위젯은 앱 스토어에서 사용하지 않도록 설정할 수 있습니다. 다음을 정상적으로 처리해야 합니다. - 지속성(허용) - 요청(비활성화된 태그, 컨텍스트 제공)
isNameConfigurable	위젯이 위젯 이름/타이틀 구성을 지원하는지 여부를 나타내는 옵트아웃 부울입니다. 이름을 무시하는 위젯은 매니페스트에서 false로 설정해야 합니다.
isVisibleFromCatalog	위젯이 카탈로그에서 숨겨져 있는지 여부를 나타내는 옵트아웃 부울입니다. 일반적으로 개발자가 사용되지 않는 위젯 만들기를 사용하지 않도록 설정하는 데 사용됩니다. 위젯은 카탈로그에서 표시되려면 기능 기본 상태가 있거나 구성 환경이 있어야 합니다.
keywords	이 위젯과 연결된 키워드, 필터링할 수 없음 및 보이지 않는 키워드
lightboxOptions	"lightbox" 대화 상자에서 위젯 프레젠테이션을 사용자 지정하기 위한 옵트인 속성입니다.
loadingImageUrl	대시보드에서 로드 자리 표시자 이미지에 대한 리소스
name	위젯 유형의 사용자 연결 이름입니다. 각 위젯은 여기에서 고유한 값을 사용해야 합니다.
publisherName	이러한 종류의 위젯의 게시자 이름입니다.
supportedScopes	위젯이 작동하고 컨테이너에서 작동하는 데 필요한 데이터 계약입니다.
tags	각 위젯에 표시되고 필터링 가능한 이 위젯과 연결된 태그입니다.
targets	기여 대상 ID
typeId	사용되지 않음: 이러한 종류의 위젯에 대한 로컬 고유 개발자용 ID입니다. ContributionId는 위젯 형식에 대해 전역적으로 고유한 식별자를 제공합니다.

속성 세부 정보

allowedSizes

위젯에서 지원하는 크기입니다.

allowedSizes: WidgetSize[]

속성 값

WidgetSize[]

analyticsServiceRequired

위젯에 Analytics Service가 작동해야 하는지 여부를 나타내는 옵트인 부울입니다. 분석 서비스를 사용할 수 없는 경우 분석 서비스가 필요한 위젯은 카탈로그에서 숨겨집니다.

analyticsServiceRequired: boolean

속성 값

boolean

catalogIconUrl

위젯 카탈로그의 아이콘에 대한 리소스입니다.

catalogIconUrl: string

속성 값

string

catalogInfoUrl

위젯 정보를 가리키는 옵트인 URL 문자열입니다. 생략된 경우 기본값은 확장 마켓플레이스 URL로 설정됩니다.

catalogInfoUrl: string

속성 값

string

configurationContributionId

제공된 위젯 사용자 지정 구성 UI를 정의하는 기본 기여의 ID입니다. 사용자 지정 구성 UI를 사용할 수 없는 경우 Null입니다.

configurationContributionId: string

속성 값

string

configurationContributionRelativeId

제공된 위젯 사용자 지정 구성 UI를 정의하는 기본 기여의 상대 ID입니다. 사용자 지정 구성 UI를 사용할 수 없는 경우 Null입니다.

configurationContributionRelativeId: string

속성 값

string

configurationRequired

대시보드에 추가되기 전에 위젯에 구성이 필요한지 나타냅니다.

configurationRequired: boolean

속성 값

boolean

contentUri

에서 로드할 위젯 콘텐츠의 URI입니다.

contentUri: string

속성 값

string

contributionId

제공된 위젯을 정의하는 기본 기여의 ID입니다.

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

기여 대상 ID

targets: string[]

속성 값

string[]

typeId

사용되지 않음: 이러한 종류의 위젯에 대한 로컬 고유 개발자용 ID입니다. ContributionId는 위젯 형식에 대해 전역적으로 고유한 식별자를 제공합니다.

typeId: string

속성 값

string