azure-devops-extension-sdk package

Třídy

XDMChannel	Představuje komunikační kanál mezi snímky\dokument zůstává "naživu" napříč několika voláními funtion\method.
XDMObjectRegistry	Katalog objektů vystavených pro XDM

Rozhraní

ContextIdentifier
GlobalizationContext
IExtensionContext	Identifikátor aktuálního rozšíření
IExtensionInitOptions	Možnosti inicializace rozšíření – předané do DevOps.init()
IHostContext	Informace o aktuálním hostiteli DevOps (organizaci)
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
IJsonRpcMessage	Představuje vzdálené volání procedur (rpc) mezi snímky.
ISerializationSettings	Nastavení související se serializací dat napříč hranicemi iframe.
IXDMChannel	Rozhraní pro jeden kanál XDM
IXDMChannelManager	Registr kanálů XDM uchovávaných podle cílového rámce nebo okna
IXDMObjectRegistry	Registr objektů XDM, které lze vyvolat kanálem XDM

Výčty

HostType

Úroveň hostitele DevOps

Funkce

applyTheme({[varName: string]: string})	Použije proměnné motivu na aktuální dokument.
getAccessToken()	Načtení přístupového tokenu, který umožní provádět volání jiných služeb DevOps
getAppToken()	Načtení tokenu, který se dá použít k identifikaci aktuálního uživatele
getConfiguration()	Získání konfiguračních dat předaných při počátečním handshake z nadřazeného rámce
getContributionId()	Získá informace o příspěvku, který poprvé způsobil načtení tohoto rozšíření.
getExtensionContext()	Získání kontextu 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 stránky hostitele
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í zaregistrovaného objektu v rámci daného 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ískání kontextu o webu
init(IExtensionInitOptions)	Zahájí metodu handshake v okně hostitele.
notifyLoadFailed(string | Error)	Upozorní hostitele, že se rozšíření nepodařilo načíst.
notifyLoadSucceeded()	Upozorní hostitele, že se rozšíření úspěšně načetlo (přestane se zobrazovat indikátor načítání).
ready()	Zaregistrujte zpětné volání, které se zavolá po dokončení počátečního nastavení nebo metody handshake. Pokud je počáteční nastavení již dokončeno, je na konci aktuálního zásobníku volání vyvoláno zpětné volání.
register<T>(string, T)	Zaregistrujte objekt (instanci nebo metodu továrny), který toto rozšíření zpřístupňuje rámci hostitele.
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)	Odebere objekt, který toto rozšíření zveřejnilo v rámci hostitele.

Podrobnosti funkce

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

Použije proměnné motivu na aktuální dokument.

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

Parametry

themeData

{[varName: string]: string}

getAccessToken()

Načtení přístupového tokenu, který umožní provádět volání jiných služeb DevOps

function getAccessToken(): Promise<string>

Návraty

Promise<string>

getAppToken()

Načtení tokenu, který se dá 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 při 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ý poprvé způsobil načtení tohoto rozšíření.

function getContributionId(): string

Návraty

string

getExtensionContext()

Získání kontextu 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 stránky hostitele

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í zaregistrovaného objektu v rámci daného 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ískání kontextu o webu

function getWebContext(): IWebContext

Návraty

IWebContext

init(IExtensionInitOptions)

Zahájí metodu handshake v okně 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 rozšíření nepodařilo načíst.

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

Parametry

e

string | Error

Návraty

Promise<void>

notifyLoadSucceeded()

Upozorní hostitele, že se rozšíření úspěšně načetlo (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 zavolá po dokončení počátečního nastavení nebo metody handshake. Pokud je počáteční nastavení již dokončeno, je na konci aktuálního zásobníku volání vyvoláno zpětné 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 rámci hostitele.

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

Parametry

instanceId

string

jedinečné ID registrovaného objektu

instance

T

Buď (1) instance objektu, nebo (2) funkce, která přijímá 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í hodnota scrollWidth

height

number

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

unregister(string)

Odebere objekt, který toto rozšíření zveřejnilo v rámci hostitele.

function unregister(instanceId: string)

Parametry

instanceId

string

jedinečné ID registrovaného objektu