IConfigurableWidget interface

패키지:

azure-devops-extension-api

구성 가능한 위젯은 이 인터페이스를 구현합니다.

Extends

IWidget

속성

reload

구성 보기가 변경되면 위젯이 해당 보기를 업데이트해야 합니다.

상속된 속성

disableWidgetForStakeholders	프레임워크는 이 메서드를 호출하여 관련자 라이선스가 있는 사용자에 대해 위젯을 사용하지 않도록 설정해야 하는지 여부를 결정합니다.
lightbox	라이트박스 모드에서 위젯 실행
listen	호스트에서 메시지 수신 대기
load	위젯은 제공된 설정과 서버 쪽 호출을 사용하여 렌더링 환경을 완료합니다. 나중에 위젯은 호출이 완료되기를 기다리는 동안 로드 환경을 제공할 것으로 예상됩니다. 그때까지 위젯 호스트는 로드 환경을 제공합니다.
onDashboardLoaded	위젯은 초기 로드에 필요하지 않지만 전체 위젯 환경에 필요한 모든 작업을 관리합니다.
preload	위젯은 대화형 상태를 그리는 데 필요할 수 있는 캐시된 데이터와 함께 제공되는 설정을 사용합니다. 위젯에서 네트워크 호출을 수행할 수 없습니다.

속성 세부 정보

reload

구성 보기가 변경되면 위젯이 해당 보기를 업데이트해야 합니다.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

속성 값

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

상속된 속성 세부 정보

disableWidgetForStakeholders

프레임워크는 이 메서드를 호출하여 관련자 라이선스가 있는 사용자에 대해 위젯을 사용하지 않도록 설정해야 하는지 여부를 결정합니다.

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

속성 값

(widgetSettings: WidgetSettings) => Promise<boolean>

IWidget.disableWidgetForStakeholders 상속된

lightbox

라이트박스 모드에서 위젯 실행

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

속성 값

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

IWidget.lightbox 상속된

listen

호스트에서 메시지 수신 대기

listen?: (event: string, eventArgs: EventArgs<T>) => void

속성 값

(event: string, eventArgs: EventArgs<T>) => void

IWidget.listen 상속된

load

위젯은 제공된 설정과 서버 쪽 호출을 사용하여 렌더링 환경을 완료합니다. 나중에 위젯은 호출이 완료되기를 기다리는 동안 로드 환경을 제공할 것으로 예상됩니다. 그때까지 위젯 호스트는 로드 환경을 제공합니다.

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

속성 값

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

IWidget.load 상속된

onDashboardLoaded

위젯은 초기 로드에 필요하지 않지만 전체 위젯 환경에 필요한 모든 작업을 관리합니다.

onDashboardLoaded?: () => void

속성 값

() => void

IWidget.onDashboardLoaded 상속된

preload

위젯은 대화형 상태를 그리는 데 필요할 수 있는 캐시된 데이터와 함께 제공되는 설정을 사용합니다. 위젯에서 네트워크 호출을 수행할 수 없습니다.

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

속성 값

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

IWidget.preload 상속된