IWidgetConfiguration interface

패키지:

azure-devops-extension-api

위젯 작성자는 구성에 대해 이 인터페이스를 구현합니다.

속성

listen	호스트에서 메시지 수신 대기
load	위젯 구성을 설정하기 위해 호스트에서 호출합니다. 이 구성은 위젯과 공유되는 설정을 사용하여 렌더링 환경을 완료합니다.
onSave	사용자가 저장 단추를 클릭할 때 호스트가 호출합니다. 위젯 작성자는 필요한 경우 유효성 검사를 실행해야 합니다. 저장할 준비가 되면 WidgetHelpers.WidgetConfigurationSave.Valid()를 사용하여 configuraton에서 위젯의 직렬화된 사용자 지정 설정을 반환합니다. 사용자 지정 설정이 유효하지 않아 저장할 준비가 되지 않은 경우 WidgetHelpers.WidgetConfigurationSave.Invalid()를 사용하여 호스트에 저장 중지를 알립니다.
onSaveComplete	(선택 사항) 구성을 저장할 준비가 되면 호스트가 호출합니다(사용자가 구성 패널에서 저장 단추를 클릭할 때).

속성 세부 정보

listen

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

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

속성 값

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

load

위젯 구성을 설정하기 위해 호스트에서 호출합니다. 이 구성은 위젯과 공유되는 설정을 사용하여 렌더링 환경을 완료합니다.

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

속성 값

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

사용자가 저장 단추를 클릭할 때 호스트가 호출합니다. 위젯 작성자는 필요한 경우 유효성 검사를 실행해야 합니다. 저장할 준비가 되면 WidgetHelpers.WidgetConfigurationSave.Valid()를 사용하여 configuraton에서 위젯의 직렬화된 사용자 지정 설정을 반환합니다. 사용자 지정 설정이 유효하지 않아 저장할 준비가 되지 않은 경우 WidgetHelpers.WidgetConfigurationSave.Invalid()를 사용하여 호스트에 저장 중지를 알립니다.

onSave: () => Promise<SaveStatus>

속성 값

() => Promise<SaveStatus>

onSaveComplete

(선택 사항) 구성을 저장할 준비가 되면 호스트가 호출합니다(사용자가 구성 패널에서 저장 단추를 클릭할 때).

onSaveComplete?: () => void

속성 값

() => void