azure-devops-extension-sdk package
인터페이스
| ContextIdentifier | |
| GlobalizationContext | |
| IExtensionContext |
현재 확장의 식별자입니다 |
| IExtensionInitOptions |
확장 초기화를 위한 옵션 -- DevOps.init()에 전달됨 |
| IHostContext |
현재 DevOps 호스트(조직)에 대한 정보 |
| IPageContext |
각 웹 페이지에 배치된 전역 컨텍스트 |
| ITeamContext |
현재 DevOps 팀에 대한 정보 |
| IUserContext |
현재 사용자에 대한 정보 |
열거형
| HostType |
DevOps 호스트 수준 |
함수
| apply |
테마 변수를 현재 문서에 적용합니다. |
| get |
다른 DevOps 서비스에 대한 호출을 허용하는 액세스 토큰을 가져옵니다. |
| get |
현재 사용자를 식별하는 데 사용할 수 있는 토큰을 가져옵니다. |
| get |
부모 프레임에서 초기 핸드셰이크에 전달된 구성 데이터를 가져옵니다. |
| get |
이 확장을 처음 로드한 기여에 대한 정보를 가져옵니다. |
| get |
호스팅되는 콘텐츠를 소유하는 확장에 대한 컨텍스트 가져오기 |
| get |
페이지가 대상으로 하는 호스트(즉, Azure DevOps 조직)에 대한 정보를 가져옵니다. |
| get |
호스트 페이지에 대한 컨텍스트 가져오기 |
| get |
지정된 기여 ID를 사용하여 기여를 가져옵니다. 반환된 기여에는 해당 기여 내에서 등록된 개체를 가져오는 메서드가 있습니다. |
| get |
페이지가 대상으로 하는 팀에 대한 정보를 가져옵니다. |
| get |
현재 사용자에 대한 정보를 가져옵니다. |
| get |
웹에 대한 컨텍스트 파악 |
| init(IExtension |
호스트 창과의 핸드셰이크를 시작합니다. |
| notify |
확장이 로드되지 않았음을 호스트에 알립니다. |
| notify |
확장이 성공적으로 로드되었음을 호스트에 알립니다(로드 표시기 표시 중지). |
| ready() | 초기 설정/핸드셰이크가 완료되면 호출되는 콜백을 등록합니다. 초기 설정이 이미 완료된 경우 현재 호출 스택의 끝에서 콜백이 호출됩니다. |
| register<T>(string, T) | 이 확장이 호스트 프레임에 노출하는 개체(인스턴스 또는 팩터리 메서드)를 등록합니다. |
| resize(number, number) | 부모 창에 현재 확장 크기에 따라 이 확장에 대한 컨테이너의 크기를 조정하도록 요청합니다. |
| unregister(string) | 이 확장이 호스트 프레임에 노출한 개체를 제거합니다. |
함수 세부 정보
applyTheme({[varName: string]: string})
테마 변수를 현재 문서에 적용합니다.
function applyTheme(themeData: {[varName: string]: string})
매개 변수
- themeData
-
{[varName: string]: string}
getAccessToken()
다른 DevOps 서비스에 대한 호출을 허용하는 액세스 토큰을 가져옵니다.
function getAccessToken(): Promise<string>
반환
Promise<string>
getAppToken()
현재 사용자를 식별하는 데 사용할 수 있는 토큰을 가져옵니다.
function getAppToken(): Promise<string>
반환
Promise<string>
getConfiguration()
부모 프레임에서 초기 핸드셰이크에 전달된 구성 데이터를 가져옵니다.
function getConfiguration(): {[key: string]: any}
반환
{[key: string]: any}
getContributionId()
이 확장을 처음 로드한 기여에 대한 정보를 가져옵니다.
function getContributionId(): string
반환
string
getExtensionContext()
호스팅되는 콘텐츠를 소유하는 확장에 대한 컨텍스트 가져오기
function getExtensionContext(): IExtensionContext
반환
getHost()
페이지가 대상으로 하는 호스트(즉, Azure DevOps 조직)에 대한 정보를 가져옵니다.
function getHost(): IHostContext
반환
getPageContext()
getService<T>(string)
지정된 기여 ID를 사용하여 기여를 가져옵니다. 반환된 기여에는 해당 기여 내에서 등록된 개체를 가져오는 메서드가 있습니다.
function getService<T>(contributionId: string): Promise<T>
매개 변수
- contributionId
-
string
가져올 기여도의 ID
반환
Promise<T>
getTeamContext()
getUser()
getWebContext()
웹에 대한 컨텍스트 파악
function getWebContext(): IWebContext
반환
IWebContext
init(IExtensionInitOptions)
호스트 창과의 핸드셰이크를 시작합니다.
function init(options?: IExtensionInitOptions): Promise<void>
매개 변수
- options
- IExtensionInitOptions
확장에 대한 초기화 옵션입니다.
반환
Promise<void>
notifyLoadFailed(string | Error)
확장이 로드되지 않았음을 호스트에 알립니다.
function notifyLoadFailed(e: string | Error): Promise<void>
매개 변수
- e
-
string | Error
반환
Promise<void>
notifyLoadSucceeded()
확장이 성공적으로 로드되었음을 호스트에 알립니다(로드 표시기 표시 중지).
function notifyLoadSucceeded(): Promise<void>
반환
Promise<void>
ready()
초기 설정/핸드셰이크가 완료되면 호출되는 콜백을 등록합니다. 초기 설정이 이미 완료된 경우 현재 호출 스택의 끝에서 콜백이 호출됩니다.
function ready(): Promise<void>
반환
Promise<void>
register<T>(string, T)
이 확장이 호스트 프레임에 노출하는 개체(인스턴스 또는 팩터리 메서드)를 등록합니다.
function register<T>(instanceId: string, instance: T)
매개 변수
- instanceId
-
string
등록된 개체의 고유 ID
- instance
-
T
(1) object instance 또는 (2) 선택적 context data를 취하고 object 인스턴스를 반환하는 함수입니다.
resize(number, number)
부모 창에 현재 확장 크기에 따라 이 확장에 대한 컨테이너의 크기를 조정하도록 요청합니다.
function resize(width?: number, height?: number)
매개 변수
- width
-
number
선택적 너비, 기본값은 scrollWidth입니다.
- height
-
number
선택적 height, 기본값은 scrollHeight입니다.
unregister(string)
이 확장이 호스트 프레임에 노출한 개체를 제거합니다.
function unregister(instanceId: string)
매개 변수
- instanceId
-
string
등록된 개체의 고유 ID