azure-devops-extension-sdk package

Schnittstellen

ContextIdentifier
GlobalizationContext
IExtensionContext	Kennung für die aktuelle Erweiterung
IExtensionInitOptions	Optionen für die Initialisierung von Erweiterungen – übergeben an DevOps.init()
IHostContext	Informationen über den aktuellen DevOps-Host (Organisation)
IPageContext	Globaler Kontext, der auf jeder Webseite platziert wird
ITeamContext	Informationen zum aktuellen DevOps-Team
IUserContext	Informationen über den aktuellen Benutzer

Enumerationen

HostType

DevOps-Hostebene

Functions

applyTheme({[varName: string]: string})	Wendet Designvariablen auf das aktuelle Dokument an
getAccessToken()	Abrufen eines Zugriffstokens, mit dem Aufrufe an andere DevOps-Dienste getätigt werden können
getAppToken()	Rufen Sie ein Token ab, das zur Identifizierung des aktuellen Benutzers verwendet werden kann
getConfiguration()	Abrufen der Konfigurationsdaten, die beim ersten Handshake vom übergeordneten Frame übergeben werden
getContributionId()	Ruft die Informationen über den Beitrag ab, der das Laden dieser Erweiterung zuerst verursacht hat.
getExtensionContext()	Abrufen des Kontexts zu der Erweiterung, die den gehosteten Inhalt besitzt
getHost()	Ruft Informationen über den Host (d. h. eine Azure DevOps-Organisation) ab, auf den die Seite ausgerichtet ist
getPageContext()	Abrufen des Kontexts zur Hostseite
getService<T>(string)	Rufen Sie den Beitrag mit der angegebenen Beitrags-ID ab. Der zurückgegebene Beitrag verfügt über eine Methode zum Abrufen eines registrierten Objekts innerhalb dieses Beitrags.
getTeamContext()	Ruft Informationen über das Team ab, auf das die Seite ausgerichtet ist
getUser()	Ruft Informationen über den aktuellen Benutzer ab
getWebContext()	Verschaffen Sie sich einen Überblick über das Web
init(IExtensionInitOptions)	Initiiert den Handshake mit dem Hostfenster.
notifyLoadFailed(string | Error)	Benachrichtigt den Host, dass die Erweiterung nicht geladen werden konnte
notifyLoadSucceeded()	Benachrichtigt den Host, dass die Erweiterung erfolgreich geladen wurde (die Ladeanzeige wird nicht mehr angezeigt)
ready()	Registrieren Sie einen Rückruf, der aufgerufen wird, sobald die Ersteinrichtung/der erste Handshake abgeschlossen ist. Wenn die Ersteinrichtung bereits abgeschlossen ist, wird der Rückruf am Ende der aktuellen Aufrufliste aufgerufen.
register<T>(string, T)	Registrieren Sie ein Objekt (Instanz oder Factorymethode), das diese Erweiterung für den Hostframe verfügbar macht.
resize(number, number)	Fordert das übergeordnete Fenster auf, die Größe des Containers für diese Erweiterung basierend auf der aktuellen Erweiterungsgröße zu ändern.
unregister(string)	Entfernt ein Objekt, das von dieser Erweiterung für den Hostframe verfügbar gemacht wurde.

Details zur Funktion

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

Wendet Designvariablen auf das aktuelle Dokument an

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

Parameter

themeData

{[varName: string]: string}

getAccessToken()

Abrufen eines Zugriffstokens, mit dem Aufrufe an andere DevOps-Dienste getätigt werden können

function getAccessToken(): Promise<string>

Gibt zurück

Promise<string>

getAppToken()

Rufen Sie ein Token ab, das zur Identifizierung des aktuellen Benutzers verwendet werden kann

function getAppToken(): Promise<string>

Gibt zurück

Promise<string>

getConfiguration()

Abrufen der Konfigurationsdaten, die beim ersten Handshake vom übergeordneten Frame übergeben werden

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

Gibt zurück

{[key: string]: any}

getContributionId()

Ruft die Informationen über den Beitrag ab, der das Laden dieser Erweiterung zuerst verursacht hat.

function getContributionId(): string

Gibt zurück

string

getExtensionContext()

Abrufen des Kontexts zu der Erweiterung, die den gehosteten Inhalt besitzt

function getExtensionContext(): IExtensionContext

Gibt zurück

IExtensionContext

getHost()

Ruft Informationen über den Host (d. h. eine Azure DevOps-Organisation) ab, auf den die Seite ausgerichtet ist

function getHost(): IHostContext

Gibt zurück

IHostContext

getPageContext()

Abrufen des Kontexts zur Hostseite

function getPageContext(): IPageContext

Gibt zurück

IPageContext

getService<T>(string)

Rufen Sie den Beitrag mit der angegebenen Beitrags-ID ab. Der zurückgegebene Beitrag verfügt über eine Methode zum Abrufen eines registrierten Objekts innerhalb dieses Beitrags.

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

Parameter

contributionId

string

ID des Beitrags, der abgerufen werden soll

Gibt zurück

Promise<T>

getTeamContext()

Ruft Informationen über das Team ab, auf das die Seite ausgerichtet ist

function getTeamContext(): ITeamContext

Gibt zurück

ITeamContext

getUser()

Ruft Informationen über den aktuellen Benutzer ab

function getUser(): IUserContext

Gibt zurück

IUserContext

getWebContext()

Verschaffen Sie sich einen Überblick über das Web

function getWebContext(): IWebContext

Gibt zurück

IWebContext

init(IExtensionInitOptions)

Initiiert den Handshake mit dem Hostfenster.

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

Parameter

options

IExtensionInitOptions

Initialisierungsoptionen für die Erweiterung.

Gibt zurück

Promise<void>

notifyLoadFailed(string | Error)

Benachrichtigt den Host, dass die Erweiterung nicht geladen werden konnte

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

Parameter

e

string | Error

Gibt zurück

Promise<void>

notifyLoadSucceeded()

Benachrichtigt den Host, dass die Erweiterung erfolgreich geladen wurde (die Ladeanzeige wird nicht mehr angezeigt)

function notifyLoadSucceeded(): Promise<void>

Gibt zurück

Promise<void>

ready()

Registrieren Sie einen Rückruf, der aufgerufen wird, sobald die Ersteinrichtung/der erste Handshake abgeschlossen ist. Wenn die Ersteinrichtung bereits abgeschlossen ist, wird der Rückruf am Ende der aktuellen Aufrufliste aufgerufen.

function ready(): Promise<void>

Gibt zurück

Promise<void>

register<T>(string, T)

Registrieren Sie ein Objekt (Instanz oder Factorymethode), das diese Erweiterung für den Hostframe verfügbar macht.

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

Parameter

instanceId

string

Eindeutige ID des registrierten Objekts

instance

T

Entweder: (1) eine Objektinstanz oder (2) eine Funktion, die optionale Kontextdaten verwendet und eine Objektinstanz zurückgibt.

resize(number, number)

Fordert das übergeordnete Fenster auf, die Größe des Containers für diese Erweiterung basierend auf der aktuellen Erweiterungsgröße zu ändern.

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

Parameter

width

number

Optionale Breite, standardmäßig scrollWidth

height

number

Optionale Höhe, standardmäßig scrollHeight

unregister(string)

Entfernt ein Objekt, das von dieser Erweiterung für den Hostframe verfügbar gemacht wurde.

function unregister(instanceId: string)

Parameter

instanceId

string

Eindeutige ID des registrierten Objekts