azure-devops-extension-sdk package

Rozhraní

ContextIdentifier
GlobalizationContext
IExtensionContext	Identifikátor aktuální linky
IExtensionInitOptions	Možnosti inicializace rozšíření – předává se do DevOps.init()
IHostContext	Informace o aktuálním hostiteli (organizaci) DevOps
IPageContext	Globální kontext umístěný na každé webové stránce
ITeamContext	Informace o aktuálním týmu DevOps
IUserContext	Informace o aktuálním uživateli

Výčty

HostType

Úroveň hostitele DevOps

Funkce

applyTheme({[varName: string]: string})	Aplikuje proměnné motivu na aktuální dokument
getAccessToken()	Načtěte přístupový token, který umožní volat do jiných služeb DevOps
getAppToken()	Načíst token, který lze použít k identifikaci aktuálního uživatele
getConfiguration()	Získání konfiguračních dat předaných v počátečním handshake z nadřazeného rámce
getContributionId()	Získá informace o příspěvku, který jako první způsobil načtení tohoto rozšíření.
getExtensionContext()	Získejte kontext o rozšíření, které vlastní hostovaný obsah
getHost()	Získá informace o hostiteli (tj. organizaci Azure DevOps), na kterého stránka cílí
getPageContext()	Získání kontextu hostitelské stránky
getService<T>(string)	Získejte příspěvek s daným ID příspěvku. Vrácený příspěvek má metodu pro získání registrovaného objektu v rámci tohoto příspěvku.
getTeamContext()	Získá informace o týmu, na který stránka cílí
getUser()	Získá informace o aktuálním uživateli
getWebContext()	Získejte kontext o webu
init(IExtensionInitOptions)	Zahájí metodu handshake s oknem hostitele.
notifyLoadFailed(string | Error)	Upozorní hostitele, že se nepodařilo načíst rozšíření
notifyLoadSucceeded()	Upozorní hostitele, že rozšíření bylo úspěšně načteno (přestane se zobrazovat indikátor načítání)
ready()	Zaregistrujte zpětné volání, které se volá po dokončení počátečního nastavení/metody handshake. Pokud je počáteční nastavení již dokončeno, zpětné volání je vyvoláno na konci aktuálního zásobníku volání.
register<T>(string, T)	Zaregistrujte objekt (instanci nebo metodu továrny), který toto rozšíření zpřístupňuje hostitelskému rámci.
resize(number, number)	Požádá nadřazené okno o změnu velikosti kontejneru pro toto rozšíření na základě aktuální velikosti rozšíření.
unregister(string)	Odstraní objekt, který tento doplněk vystavil hostitelskému snímku.

Podrobnosti funkce

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

Aplikuje proměnné motivu na aktuální dokument

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

Parametry

themeData

{[varName: string]: string}

getAccessToken()

Načtěte přístupový token, který umožní volat do jiných služeb DevOps

function getAccessToken(): Promise<string>

Návraty

Promise<string>

getAppToken()

Načíst token, který lze použít k identifikaci aktuálního uživatele

function getAppToken(): Promise<string>

Návraty

Promise<string>

getConfiguration()

Získání konfiguračních dat předaných v počátečním handshake z nadřazeného rámce

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

Návraty

{[key: string]: any}

getContributionId()

Získá informace o příspěvku, který jako první způsobil načtení tohoto rozšíření.

function getContributionId(): string

Návraty

string

getExtensionContext()

Získejte kontext o rozšíření, které vlastní hostovaný obsah

function getExtensionContext(): IExtensionContext

Návraty

IExtensionContext

getHost()

Získá informace o hostiteli (tj. organizaci Azure DevOps), na kterého stránka cílí

function getHost(): IHostContext

Návraty

IHostContext

getPageContext()

Získání kontextu hostitelské stránky

function getPageContext(): IPageContext

Návraty

IPageContext

getService<T>(string)

Získejte příspěvek s daným ID příspěvku. Vrácený příspěvek má metodu pro získání registrovaného objektu v rámci tohoto příspěvku.

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

Parametry

contributionId

string

Id příspěvku, který chcete získat

Návraty

Promise<T>

getTeamContext()

Získá informace o týmu, na který stránka cílí

function getTeamContext(): ITeamContext

Návraty

ITeamContext

getUser()

Získá informace o aktuálním uživateli

function getUser(): IUserContext

Návraty

IUserContext

getWebContext()

Získejte kontext o webu

function getWebContext(): IWebContext

Návraty

IWebContext

init(IExtensionInitOptions)

Zahájí metodu handshake s oknem hostitele.

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

Parametry

options

IExtensionInitOptions

Možnosti inicializace rozšíření.

Návraty

Promise<void>

notifyLoadFailed(string | Error)

Upozorní hostitele, že se nepodařilo načíst rozšíření

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

Parametry

e

string | Error

Návraty

Promise<void>

notifyLoadSucceeded()

Upozorní hostitele, že rozšíření bylo úspěšně načteno (přestane se zobrazovat indikátor načítání)

function notifyLoadSucceeded(): Promise<void>

Návraty

Promise<void>

ready()

Zaregistrujte zpětné volání, které se volá po dokončení počátečního nastavení/metody handshake. Pokud je počáteční nastavení již dokončeno, zpětné volání je vyvoláno na konci aktuálního zásobníku volání.

function ready(): Promise<void>

Návraty

Promise<void>

register<T>(string, T)

Zaregistrujte objekt (instanci nebo metodu továrny), který toto rozšíření zpřístupňuje hostitelskému rámci.

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

Parametry

instanceId

string

Unikátní ID registrovaného objektu

instance

T

Buď: (1) instance objektu, nebo (2) funkce, která přebírá volitelná kontextová data a vrací instanci objektu.

resize(number, number)

Požádá nadřazené okno o změnu velikosti kontejneru pro toto rozšíření na základě aktuální velikosti rozšíření.

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

Parametry

width

number

Volitelná šířka, výchozí je scrollWidth

height

number

Volitelná výška, výchozí je scrollHeight

unregister(string)

Odstraní objekt, který tento doplněk vystavil hostitelskému snímku.

function unregister(instanceId: string)

Parametry

instanceId

string

Unikátní ID registrovaného objektu