azure-devops-extension-sdk package
Klasser
XDMChannel |
Representerar en kommunikationskanal mellan ramar\dokument Förblir "levande" över flera funtion\method-anrop |
XDMObjectRegistry |
Katalog över objekt som exponeras för XDM |
Gränssnitt
ContextIdentifier | |
GlobalizationContext | |
IExtensionContext |
Identifierare för det aktuella tillägget |
IExtensionInitOptions |
Alternativ för tilläggsinitiering – skickas till DevOps.init() |
IHostContext |
Information om den aktuella DevOps-värden (organisationen) |
IPageContext |
Global kontext som placeras på varje webbsida |
ITeamContext |
Information om det aktuella DevOps-teamet |
IUserContext |
Information om den aktuella användaren |
IJsonRpcMessage |
Representerar ett fjärrproceduranrop (rpc) mellan bildrutor. |
ISerializationSettings |
Inställningar som rör serialisering av data över iframe-gränser. |
IXDMChannel |
Gränssnitt för en enda XDM-kanal |
IXDMChannelManager |
Register över XDM-kanaler som sparas per målram/fönster |
IXDMObjectRegistry |
Register över XDM-objekt som kan anropas av en XDM-kanal |
Uppräkningar
HostType |
DevOps-värdnivå |
Funktioner
apply |
Tillämpar temavariabler på det aktuella dokumentet |
get |
Hämta en åtkomsttoken som gör att anrop kan göras till andra DevOps-tjänster |
get |
Hämta en token som kan användas för att identifiera den aktuella användaren |
get |
Hämta konfigurationsdata som skickas i den inledande handskakningen från den överordnade ramen |
get |
Hämtar information om det bidrag som först gjorde att tillägget lästes in. |
get |
Hämta kontexten om tillägget som äger innehållet som finns |
get |
Hämtar information om värden (dvs. en Azure DevOps-organisation) som sidan riktar sig mot |
get |
Hämta kontexten för värdsidan |
get |
Hämta bidraget med det angivna bidrags-ID:t. Det returnerade bidraget har en metod för att hämta ett registrerat objekt i det bidraget. |
get |
Hämtar information om teamet som sidan riktar in sig på |
get |
Hämtar information om den aktuella användaren |
get |
Hämta kontexten om webben |
init(IExtension |
Initierar handskakningen med värdfönstret. |
notify |
Meddelar värden att tillägget inte kunde läsas in |
notify |
Meddelar värden att tillägget har lästs in (sluta visa inläsningsindikatorn) |
ready() | Registrera ett återanrop som anropas när den första installationen/handskakningen har slutförts. Om den första installationen redan är klar anropas återanropet i slutet av den aktuella anropsstacken. |
register<T>(string, T) | Registrera ett objekt (instans eller fabriksmetod) som det här tillägget exponerar för värdramen. |
resize(number, number) | Begär att det överordnade fönstret ändrar storlek på containern för det här tillägget baserat på den aktuella tilläggsstorleken. |
unregister(string) | Tar bort ett objekt som det här tillägget exponeras för värdramen. |
Funktionsinformation
applyTheme({[varName: string]: string})
Tillämpar temavariabler på det aktuella dokumentet
function applyTheme(themeData: {[varName: string]: string})
Parametrar
- themeData
-
{[varName: string]: string}
getAccessToken()
Hämta en åtkomsttoken som gör att anrop kan göras till andra DevOps-tjänster
function getAccessToken(): Promise<string>
Returer
Promise<string>
getAppToken()
Hämta en token som kan användas för att identifiera den aktuella användaren
function getAppToken(): Promise<string>
Returer
Promise<string>
getConfiguration()
Hämta konfigurationsdata som skickas i den inledande handskakningen från den överordnade ramen
function getConfiguration(): {[key: string]: any}
Returer
{[key: string]: any}
getContributionId()
Hämtar information om det bidrag som först gjorde att tillägget lästes in.
function getContributionId(): string
Returer
string
getExtensionContext()
Hämta kontexten om tillägget som äger innehållet som finns
function getExtensionContext(): IExtensionContext
Returer
getHost()
Hämtar information om värden (dvs. en Azure DevOps-organisation) som sidan riktar sig mot
function getHost(): IHostContext
Returer
getPageContext()
getService<T>(string)
Hämta bidraget med det angivna bidrags-ID:t. Det returnerade bidraget har en metod för att hämta ett registrerat objekt i det bidraget.
function getService<T>(contributionId: string): Promise<T>
Parametrar
- contributionId
-
string
ID för bidraget för att få
Returer
Promise<T>
getTeamContext()
Hämtar information om teamet som sidan riktar in sig på
function getTeamContext(): ITeamContext
Returer
getUser()
getWebContext()
Hämta kontexten om webben
function getWebContext(): IWebContext
Returer
IWebContext
init(IExtensionInitOptions)
Initierar handskakningen med värdfönstret.
function init(options?: IExtensionInitOptions): Promise<void>
Parametrar
- options
- IExtensionInitOptions
Initieringsalternativ för tillägget.
Returer
Promise<void>
notifyLoadFailed(string | Error)
Meddelar värden att tillägget inte kunde läsas in
function notifyLoadFailed(e: string | Error): Promise<void>
Parametrar
- e
-
string | Error
Returer
Promise<void>
notifyLoadSucceeded()
Meddelar värden att tillägget har lästs in (sluta visa inläsningsindikatorn)
function notifyLoadSucceeded(): Promise<void>
Returer
Promise<void>
ready()
Registrera ett återanrop som anropas när den första installationen/handskakningen har slutförts. Om den första installationen redan är klar anropas återanropet i slutet av den aktuella anropsstacken.
function ready(): Promise<void>
Returer
Promise<void>
register<T>(string, T)
Registrera ett objekt (instans eller fabriksmetod) som det här tillägget exponerar för värdramen.
function register<T>(instanceId: string, instance: T)
Parametrar
- instanceId
-
string
unikt ID för det registrerade objektet
- instance
-
T
Antingen: (1) en objektinstans eller (2) en funktion som tar valfria kontextdata och returnerar en objektinstans.
resize(number, number)
Begär att det överordnade fönstret ändrar storlek på containern för det här tillägget baserat på den aktuella tilläggsstorleken.
function resize(width?: number, height?: number)
Parametrar
- width
-
number
Valfri bredd, standard för scrollWidth
- height
-
number
Valfri höjd, standard för scrollHeight
unregister(string)
Tar bort ett objekt som det här tillägget exponeras för värdramen.
function unregister(instanceId: string)
Parametrar
- instanceId
-
string
unikt ID för det registrerade objektet