azure-devops-extension-sdk package

Klasy

XDMChannel	Reprezentuje kanał komunikacji między ramkami\dokumentem pozostaje "żywy" w wielu wywołaniach funtion\method
XDMObjectRegistry	Wykaz obiektów uwidocznionych dla maszyny XDM

Interfejsy

ContextIdentifier
GlobalizationContext
IExtensionContext	Identyfikator bieżącego rozszerzenia
IExtensionInitOptions	Opcje inicjowania rozszerzenia — przekazane do metodyki DevOps.init()
IHostContext	Informacje o bieżącym hoście DevOps (organizacji)
IPageContext	Kontekst globalny umieszczony na każdej stronie internetowej
ITeamContext	Informacje o bieżącym zespole DevOps
IUserContext	Informacje o bieżącym użytkowniku
IJsonRpcMessage	Reprezentuje zdalne wywołanie procedury (rpc) między ramkami.
ISerializationSettings	Ustawienia związane z serializacji danych w granicach elementów iframe.
IXDMChannel	Interfejs pojedynczego kanału XDM
IXDMChannelManager	Rejestr kanałów XDM przechowywanych na ramce/oknie docelowym
IXDMObjectRegistry	Rejestr obiektów XDM, które mogą być wywoływane przez kanał XDM

Wyliczenia

HostType

Poziom hosta metodyki DevOps

Funkcje

applyTheme({[varName: string]: string})	Stosuje zmienne motywu do bieżącego dokumentu
getAccessToken()	Pobierz token dostępu, który umożliwi wykonywanie wywołań do innych usług DevOps
getAppToken()	Pobieranie tokenu, który może służyć do identyfikowania bieżącego użytkownika
getConfiguration()	Pobieranie danych konfiguracji przekazanych w początkowym uścisku dłoni z ramki nadrzędnej
getContributionId()	Pobiera informacje o współtworzeniu, który po raz pierwszy spowodował załadowanie tego rozszerzenia.
getExtensionContext()	Uzyskaj kontekst rozszerzenia, który jest właścicielem hostowanej zawartości
getHost()	Pobiera informacje o hoście (tj. organizacji usługi Azure DevOps), która jest przeznaczona dla strony
getPageContext()	Pobieranie kontekstu na stronie hosta
getService<T>(string)	Pobierz wkład z podanym identyfikatorem udziału. Zwrócony wkład ma metodę pobierania zarejestrowanego obiektu w ramach tego udziału.
getTeamContext()	Pobiera informacje o zespole, dla którego jest przeznaczona strona
getUser()	Pobiera informacje o bieżącym użytkowniku
getWebContext()	Uzyskiwanie kontekstu o sieci Web
init(IExtensionInitOptions)	Inicjuje uzgadnianie za pomocą okna hosta.
notifyLoadFailed(string | Error)	Powiadamia hosta, że nie można załadować rozszerzenia
notifyLoadSucceeded()	Powiadamia hosta o pomyślnym załadowaniu rozszerzenia (zatrzymaj wyświetlanie wskaźnika ładowania)
ready()	Zarejestruj wywołanie zwrotne, które jest wywoływane po zakończeniu początkowej konfiguracji/uzgadniania. Jeśli konfiguracja początkowa została już ukończona, wywołanie zwrotne jest wywoływane na końcu bieżącego stosu wywołań.
register<T>(string, T)	Zarejestruj obiekt (wystąpienie lub metodę fabryki), który to rozszerzenie uwidacznia ramce hosta.
resize(number, number)	Żąda okna nadrzędnego, aby zmienić rozmiar kontenera dla tego rozszerzenia na podstawie bieżącego rozmiaru rozszerzenia.
unregister(string)	Usuwa obiekt, który to rozszerzenie uwidocznione w ramce hosta.

Szczegóły funkcji

applyTheme({[varName: string]: string})

Stosuje zmienne motywu do bieżącego dokumentu

function applyTheme(themeData: {[varName: string]: string})

Parametry

themeData

{[varName: string]: string}

getAccessToken()

Pobierz token dostępu, który umożliwi wykonywanie wywołań do innych usług DevOps

function getAccessToken(): Promise<string>

Zwraca

Promise<string>

getAppToken()

Pobieranie tokenu, który może służyć do identyfikowania bieżącego użytkownika

function getAppToken(): Promise<string>

Zwraca

Promise<string>

getConfiguration()

Pobieranie danych konfiguracji przekazanych w początkowym uścisku dłoni z ramki nadrzędnej

function getConfiguration(): {[key: string]: any}

Zwraca

{[key: string]: any}

getContributionId()

Pobiera informacje o współtworzeniu, który po raz pierwszy spowodował załadowanie tego rozszerzenia.

function getContributionId(): string

Zwraca

string

getExtensionContext()

Uzyskaj kontekst rozszerzenia, który jest właścicielem hostowanej zawartości

function getExtensionContext(): IExtensionContext

Zwraca

IExtensionContext

getHost()

Pobiera informacje o hoście (tj. organizacji usługi Azure DevOps), która jest przeznaczona dla strony

function getHost(): IHostContext

Zwraca

IHostContext

getPageContext()

Pobieranie kontekstu na stronie hosta

function getPageContext(): IPageContext

Zwraca

IPageContext

getService<T>(string)

Pobierz wkład z podanym identyfikatorem udziału. Zwrócony wkład ma metodę pobierania zarejestrowanego obiektu w ramach tego udziału.

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

Parametry

contributionId

string

Identyfikator udziału, aby uzyskać

Zwraca

Promise<T>

getTeamContext()

Pobiera informacje o zespole, dla którego jest przeznaczona strona

function getTeamContext(): ITeamContext

Zwraca

ITeamContext

getUser()

Pobiera informacje o bieżącym użytkowniku

function getUser(): IUserContext

Zwraca

IUserContext

getWebContext()

Uzyskiwanie kontekstu o sieci Web

function getWebContext(): IWebContext

Zwraca

IWebContext

init(IExtensionInitOptions)

Inicjuje uzgadnianie za pomocą okna hosta.

function init(options?: IExtensionInitOptions): Promise<void>

Parametry

options

IExtensionInitOptions

Opcje inicjowania rozszerzenia.

Zwraca

Promise<void>

notifyLoadFailed(string | Error)

Powiadamia hosta, że nie można załadować rozszerzenia

function notifyLoadFailed(e: string | Error): Promise<void>

Parametry

e

string | Error

Zwraca

Promise<void>

notifyLoadSucceeded()

Powiadamia hosta o pomyślnym załadowaniu rozszerzenia (zatrzymaj wyświetlanie wskaźnika ładowania)

function notifyLoadSucceeded(): Promise<void>

Zwraca

Promise<void>

ready()

Zarejestruj wywołanie zwrotne, które jest wywoływane po zakończeniu początkowej konfiguracji/uzgadniania. Jeśli konfiguracja początkowa została już ukończona, wywołanie zwrotne jest wywoływane na końcu bieżącego stosu wywołań.

function ready(): Promise<void>

Zwraca

Promise<void>

register<T>(string, T)

Zarejestruj obiekt (wystąpienie lub metodę fabryki), który to rozszerzenie uwidacznia ramce hosta.

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

Parametry

instanceId

string

unikatowy identyfikator zarejestrowanego obiektu

instance

T

Albo: (1) wystąpienie obiektu lub (2) funkcja, która pobiera opcjonalne dane kontekstowe i zwraca wystąpienie obiektu.

resize(number, number)

Żąda okna nadrzędnego, aby zmienić rozmiar kontenera dla tego rozszerzenia na podstawie bieżącego rozmiaru rozszerzenia.

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

Parametry

width

number

Opcjonalna szerokość, domyślnie do przewijaniaWidth

height

number

Opcjonalna wysokość, wartości domyślne do przewijaniaHeight

unregister(string)

Usuwa obiekt, który to rozszerzenie uwidocznione w ramce hosta.

function unregister(instanceId: string)

Parametry

instanceId

string

unikatowy identyfikator zarejestrowanego obiektu