azure-devops-extension-sdk package
Klassen
XDMChannel |
Stellt einen Kommunikationskanal zwischen frames\document bleibt "lebendig" über mehrere Funtion\method-Aufrufe dar. |
XDMObjectRegistry |
Katalog von Objekten, die für XDM verfügbar gemacht werden |
Schnittstellen
ContextIdentifier | |
GlobalizationContext | |
IExtensionContext |
Bezeichner für die aktuelle Erweiterung |
IExtensionInitOptions |
Optionen für die Erweiterungsinitialisierung – übergeben an DevOps.init() |
IHostContext |
Informationen zum aktuellen DevOps-Host (organization) |
IPageContext |
Globaler Kontext, der auf jeder Webseite platziert wird |
ITeamContext |
Informationen zum aktuellen DevOps-Team |
IUserContext |
Informationen zum aktuellen Benutzer |
IJsonRpcMessage |
Stellt einen Remoteprozeduraufruf (Rpc) zwischen Frames dar. |
ISerializationSettings |
Einstellungen im Zusammenhang mit der Serialisierung von Daten über iframe-Grenzen hinweg. |
IXDMChannel |
Schnittstelle für einen einzelnen XDM-Kanal |
IXDMChannelManager |
Registrierung von XDM-Kanälen, die pro Zielframe/Fenster beibehalten werden |
IXDMObjectRegistry |
Registrierung von XDM-Objekten, die von einem XDM-Kanal aufgerufen werden können |
Enumerationen
HostType |
DevOps-Hostebene |
Functions
apply |
Wendet Designvariablen auf das aktuelle Dokument an |
get |
Abrufen eines Zugriffstokens, das Aufrufe an andere DevOps-Dienste ermöglicht |
get |
Abrufen eines Tokens, das zum Identifizieren des aktuellen Benutzers verwendet werden kann |
get |
Abrufen der Konfigurationsdaten, die beim anfänglichen Handshake vom übergeordneten Frame übergeben werden |
get |
Ruft die Informationen zu dem Beitrag ab, der zum ersten Mal dazu geführt hat, dass diese Erweiterung geladen wurde. |
get |
Abrufen des Kontexts über die Erweiterung, die den gehosteten Inhalt besitzt |
get |
Ruft Informationen über den Host (d. h. eine Azure DevOps-organization) ab, auf die die Seite ausgerichtet ist. |
get |
Abrufen des Kontexts zur Hostseite |
get |
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. |
get |
Ruft Informationen zum Team ab, auf das die Seite ausgerichtet ist. |
get |
Ruft Informationen zum aktuellen Benutzer ab. |
get |
Abrufen des Kontexts über das Web |
init(IExtension |
Initiiert den Handshake mit dem Hostfenster. |
notify |
Benachrichtigt den Host, dass die Erweiterung nicht geladen werden konnte. |
notify |
Benachrichtigt den Host, dass die Erweiterung erfolgreich geladen wurde (zeigt nicht mehr den Ladeindikator an). |
ready() | Registrieren Sie einen Rückruf, der aufgerufen wird, nachdem das anfängliche Setup/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 (instance 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 diese Erweiterung für den Hostframe verfügbar gemacht hat. |
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, das Aufrufe an andere DevOps-Dienste ermöglicht
function getAccessToken(): Promise<string>
Gibt zurück
Promise<string>
getAppToken()
Abrufen eines Tokens, das zum Identifizieren des aktuellen Benutzers verwendet werden kann
function getAppToken(): Promise<string>
Gibt zurück
Promise<string>
getConfiguration()
Abrufen der Konfigurationsdaten, die beim anfänglichen Handshake vom übergeordneten Frame übergeben werden
function getConfiguration(): {[key: string]: any}
Gibt zurück
{[key: string]: any}
getContributionId()
Ruft die Informationen zu dem Beitrag ab, der zum ersten Mal dazu geführt hat, dass diese Erweiterung geladen wurde.
function getContributionId(): string
Gibt zurück
string
getExtensionContext()
Abrufen des Kontexts über die Erweiterung, die den gehosteten Inhalt besitzt
function getExtensionContext(): IExtensionContext
Gibt zurück
getHost()
Ruft Informationen über den Host (d. h. eine Azure DevOps-organization) ab, auf die die Seite ausgerichtet ist.
function getHost(): IHostContext
Gibt zurück
getPageContext()
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 zu erhaltenden Beitrags
Gibt zurück
Promise<T>
getTeamContext()
Ruft Informationen zum Team ab, auf das die Seite ausgerichtet ist.
function getTeamContext(): ITeamContext
Gibt zurück
getUser()
Ruft Informationen zum aktuellen Benutzer ab.
function getUser(): IUserContext
Gibt zurück
getWebContext()
Abrufen des Kontexts ü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 (zeigt nicht mehr den Ladeindikator an).
function notifyLoadSucceeded(): Promise<void>
Gibt zurück
Promise<void>
ready()
Registrieren Sie einen Rückruf, der aufgerufen wird, nachdem das anfängliche Setup/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 (instance 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) ein Objekt instance, oder (2) eine Funktion, die optionale Kontextdaten akzeptiert und ein Objekt instance 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, standardwert: scrollHeight
unregister(string)
Entfernt ein Objekt, das diese Erweiterung für den Hostframe verfügbar gemacht hat.
function unregister(instanceId: string)
Parameter
- instanceId
-
string
eindeutige ID des registrierten Objekts