azure-devops-extension-sdk package

Klassen

XDMChannel	Vertegenwoordigt een communicatiekanaal tussen frames\document blijft 'actief' voor meerdere funtion\methode-aanroepen
XDMObjectRegistry	Catalogus met objecten die beschikbaar zijn voor XDM

Interfaces

ContextIdentifier
GlobalizationContext
IExtensionContext	Id voor de huidige extensie
IExtensionInitOptions	Opties voor initialisatie van extensies - doorgegeven aan DevOps.init()
IHostContext	Informatie over de huidige DevOps-host (organisatie)
IPageContext	Algemene context die op elke webpagina wordt geplaatst
ITeamContext	Informatie over het huidige DevOps-team
IUserContext	Informatie over de huidige gebruiker
IJsonRpcMessage	Vertegenwoordigt een externe procedureaanroep (rpc) tussen frames.
ISerializationSettings	Instellingen met betrekking tot de serialisatie van gegevens over de grenzen van iframes heen.
IXDMChannel	Interface voor één XDM-kanaal
IXDMChannelManager	Register van XDM-kanalen die per doelframe/venster worden bewaard
IXDMObjectRegistry	Register van XDM-objecten die kunnen worden aangeroepen door een XDM-kanaal

Enums

HostType

DevOps-hostniveau

Functies

applyTheme({[varName: string]: string})	Themavariabelen toepassen op het huidige document
getAccessToken()	Een toegangstoken ophalen waarmee andere DevOps-services kunnen worden aangeroepen
getAppToken()	Een token ophalen dat kan worden gebruikt om de huidige gebruiker te identificeren
getConfiguration()	De configuratiegegevens ophalen die in de eerste handshake van het bovenliggende frame zijn doorgegeven
getContributionId()	Hiermee haalt u de informatie op over de bijdrage die deze extensie het eerst heeft geladen.
getExtensionContext()	De context ophalen over de extensie die eigenaar is van de inhoud die wordt gehost
getHost()	Hiermee haalt u informatie op over de host (dat wil zeggen een Azure DevOps-organisatie) waarop de pagina is gericht
getPageContext()	De context over de hostpagina ophalen
getService<T>(string)	Haal de bijdrage op met de opgegeven bijdrage-id. De geretourneerde bijdrage heeft een methode om een geregistreerd object in die bijdrage op te halen.
getTeamContext()	Hiermee haalt u informatie op over het team waarop de pagina is gericht
getUser()	Hiermee haalt u informatie op over de huidige gebruiker
getWebContext()	De context over het web ophalen
init(IExtensionInitOptions)	Start de handshake met het hostvenster.
notifyLoadFailed(string | Error)	Hiermee wordt de host gewaarschuwd dat de extensie niet kan worden geladen
notifyLoadSucceeded()	Hiermee wordt de host gewaarschuwd dat de extensie is geladen (stop met het weergeven van de laadindicator)
ready()	Registreer een callback die wordt aangeroepen zodra de eerste installatie/handshake is voltooid. Als de eerste installatie al is voltooid, wordt de callback aangeroepen aan het einde van de huidige aanroepstack.
register<T>(string, T)	Registreer een object (exemplaar of factory-methode) dat deze extensie beschikbaar maakt voor het hostframe.
resize(number, number)	Vraagt het bovenliggende venster om het formaat van de container voor deze extensie te wijzigen op basis van de huidige extensiegrootte.
unregister(string)	Hiermee verwijdert u een object dat deze extensie beschikbaar heeft gemaakt voor het hostframe.

Functiedetails

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

Themavariabelen toepassen op het huidige document

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

Parameters

themeData

{[varName: string]: string}

getAccessToken()

Een toegangstoken ophalen waarmee andere DevOps-services kunnen worden aangeroepen

function getAccessToken(): Promise<string>

Retouren

Promise<string>

getAppToken()

Een token ophalen dat kan worden gebruikt om de huidige gebruiker te identificeren

function getAppToken(): Promise<string>

Retouren

Promise<string>

getConfiguration()

De configuratiegegevens ophalen die in de eerste handshake van het bovenliggende frame zijn doorgegeven

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

Retouren

{[key: string]: any}

getContributionId()

Hiermee haalt u de informatie op over de bijdrage die deze extensie het eerst heeft geladen.

function getContributionId(): string

Retouren

string

getExtensionContext()

De context ophalen over de extensie die eigenaar is van de inhoud die wordt gehost

function getExtensionContext(): IExtensionContext

Retouren

IExtensionContext

getHost()

Hiermee haalt u informatie op over de host (dat wil zeggen een Azure DevOps-organisatie) waarop de pagina is gericht

function getHost(): IHostContext

Retouren

IHostContext

getPageContext()

De context over de hostpagina ophalen

function getPageContext(): IPageContext

Retouren

IPageContext

getService<T>(string)

Haal de bijdrage op met de opgegeven bijdrage-id. De geretourneerde bijdrage heeft een methode om een geregistreerd object in die bijdrage op te halen.

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

Parameters

contributionId

string

Id van de te krijgen bijdrage

Retouren

Promise<T>

getTeamContext()

Hiermee haalt u informatie op over het team waarop de pagina is gericht

function getTeamContext(): ITeamContext

Retouren

ITeamContext

getUser()

Hiermee haalt u informatie op over de huidige gebruiker

function getUser(): IUserContext

Retouren

IUserContext

getWebContext()

De context over het web ophalen

function getWebContext(): IWebContext

Retouren

IWebContext

init(IExtensionInitOptions)

Start de handshake met het hostvenster.

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

Parameters

options

IExtensionInitOptions

Initialisatieopties voor de extensie.

Retouren

Promise<void>

notifyLoadFailed(string | Error)

Hiermee wordt de host gewaarschuwd dat de extensie niet kan worden geladen

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

Parameters

e

string | Error

Retouren

Promise<void>

notifyLoadSucceeded()

Hiermee wordt de host gewaarschuwd dat de extensie is geladen (stop met het weergeven van de laadindicator)

function notifyLoadSucceeded(): Promise<void>

Retouren

Promise<void>

ready()

Registreer een callback die wordt aangeroepen zodra de eerste installatie/handshake is voltooid. Als de eerste installatie al is voltooid, wordt de callback aangeroepen aan het einde van de huidige aanroepstack.

function ready(): Promise<void>

Retouren

Promise<void>

register<T>(string, T)

Registreer een object (exemplaar of factory-methode) dat deze extensie beschikbaar maakt voor het hostframe.

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

Parameters

instanceId

string

unieke id van het geregistreerde object

instance

T

Ofwel: (1) een objectexemplaren of (2) een functie die optionele contextgegevens gebruikt en een objectexemplaren retourneert.

resize(number, number)

Vraagt het bovenliggende venster om het formaat van de container voor deze extensie te wijzigen op basis van de huidige extensiegrootte.

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

Parameters

width

number

Optionele breedte, standaard scrollWidth

height

number

Optionele hoogte, standaard scrollHeight

unregister(string)

Hiermee verwijdert u een object dat deze extensie beschikbaar heeft gemaakt voor het hostframe.

function unregister(instanceId: string)

Parameters

instanceId

string

unieke id van het geregistreerde object