azure-devops-extension-sdk package

클래스

XDMChannel	여러 funtion\method 호출에서 프레임\문서 유지 "활성" 사이의 통신 채널을 나타냅니다.
XDMObjectRegistry	XDM에 대해 노출된 개체의 카탈로그

인터페이스

ContextIdentifier
GlobalizationContext
IExtensionContext	현재 확장의 식별자
IExtensionInitOptions	확장 초기화 옵션 -- DevOps.init()에 전달됨
IHostContext	현재 DevOps 호스트에 대한 정보(organization)
IPageContext	각 웹 페이지에 배치된 전역 컨텍스트
ITeamContext	현재 DevOps 팀에 대한 정보
IUserContext	현재 사용자에 대한 정보
IJsonRpcMessage	프레임 간의 원격 프로시저 호출(rpc)을 나타냅니다.
ISerializationSettings	iframe 경계를 넘어 데이터의 serialization과 관련된 설정입니다.
IXDMChannel	단일 XDM 채널에 대한 인터페이스
IXDMChannelManager	대상 프레임/창당 유지되는 XDM 채널의 레지스트리
IXDMObjectRegistry	XDM 채널에서 호출할 수 있는 XDM 개체의 레지스트리

열거형

HostType

DevOps 호스트 수준

함수

applyTheme({[varName: string]: string})	현재 문서에 테마 변수 적용
getAccessToken()	다른 DevOps 서비스에 대한 호출을 허용하는 액세스 토큰 가져오기
getAppToken()	현재 사용자를 식별하는 데 사용할 수 있는 토큰 가져오기
getConfiguration()	부모 프레임에서 초기 핸드셰이크에 전달된 구성 데이터를 가져옵니다.
getContributionId()	이 확장을 처음 로드한 기여에 대한 정보를 가져옵니다.
getExtensionContext()	호스팅되는 콘텐츠를 소유하는 확장에 대한 컨텍스트 가져오기
getHost()	페이지가 대상으로 하는 호스트(즉, Azure DevOps organization)에 대한 정보를 가져옵니다.
getPageContext()	호스트 페이지에 대한 컨텍스트 가져오기
getService<T>(string)	지정된 기여 ID를 사용하여 기여를 가져옵니다. 반환된 기여에는 해당 기여 내에서 등록된 개체를 가져오는 메서드가 있습니다.
getTeamContext()	페이지가 대상으로 하는 팀에 대한 정보를 가져옵니다.
getUser()	현재 사용자에 대한 정보를 가져옵니다.
getWebContext()	웹에 대한 컨텍스트 가져오기
init(IExtensionInitOptions)	호스트 창을 사용하여 핸드셰이크를 시작합니다.
notifyLoadFailed(string | Error)	확장이 로드되지 않음을 호스트에 알
notifyLoadSucceeded()	확장이 성공적으로 로드되었음을 호스트에 알 수 있습니다(로드 표시기 표시기 표시 중지).
ready()	초기 설정/핸드셰이크가 완료되면 호출되는 콜백을 등록합니다. 초기 설정이 이미 완료된 경우 현재 호출 스택의 끝에서 콜백이 호출됩니다.
register<T>(string, T)	이 확장이 호스트 프레임에 노출하는 개체(instance 또는 팩터리 메서드)를 등록합니다.
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

반환

IExtensionContext

getHost()

페이지가 대상으로 하는 호스트(즉, Azure DevOps organization)에 대한 정보를 가져옵니다.

function getHost(): IHostContext

반환

IHostContext

getPageContext()

호스트 페이지에 대한 컨텍스트 가져오기

function getPageContext(): IPageContext

반환

IPageContext

getService<T>(string)

지정된 기여 ID를 사용하여 기여를 가져옵니다. 반환된 기여에는 해당 기여 내에서 등록된 개체를 가져오는 메서드가 있습니다.

function getService<T>(contributionId: string): Promise<T>

매개 변수

contributionId

string

가져올 기여의 ID

반환

Promise<T>

getTeamContext()

페이지가 대상으로 하는 팀에 대한 정보를 가져옵니다.

function getTeamContext(): ITeamContext

반환

ITeamContext

getUser()

현재 사용자에 대한 정보를 가져옵니다.

function getUser(): IUserContext

반환

IUserContext

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)

이 확장이 호스트 프레임에 노출하는 개체(instance 또는 팩터리 메서드)를 등록합니다.

function register<T>(instanceId: string, instance: T)

매개 변수

instanceId

string

등록된 개체의 고유 ID

instance

T

(1) 개체 instance 또는 (2) 선택적 컨텍스트 데이터를 사용하고 개체 instance 반환하는 함수입니다.

resize(number, number)

현재 확장 크기에 따라 이 확장의 컨테이너 크기를 조정하도록 부모 창에 요청합니다.

function resize(width?: number, height?: number)

매개 변수

width

number

선택적 너비, 기본값: scrollWidth

height

number

선택적 높이, 기본값: scrollHeight

unregister(string)

이 확장이 호스트 프레임에 노출하는 개체를 제거합니다.

function unregister(instanceId: string)

매개 변수

instanceId

string

등록된 개체의 고유 ID