azure-devops-extension-sdk package

Témaváltozók alkalmazása az aktuális dokumentumra

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

Paraméterek

Letiltja a Nested App Authentication hidat. E hívás után minden MSAL token kérés hibát kap BridgeDisabled . A híd objektum továbbra is bekapcsolt window.nestedAppAuthBridge , így a meglévő MSAL hallgatók nem maradnak árvákba. Hívás enableNestedAppAuth() , hogy újra aktiváld.

function disableNestedAppAuth()

Engedélyezze a Nested App Authentication (NAA) használatát ehhez a kiegészítéshez.

Úgy állít bewindow.nestedAppAuthBridge, hogy a MSAL-ok createNestablePublicClientApplication a token beszerzést delegálhassák az Azure DevOps host keretre. Ez elkerüli a cross-origin BroadcastChannel problémákat, amelyek blokkolják a felugró ablakos hitelesítést az iframe-ekben.

Ezt nevezd el MSAL instance létrehozása init() után és előtt. Ehhez a hoszt számára engedélyezve kell a NAA támogatás.

Példa

await SDK.init();
await SDK.enableNestedAppAuth();
const pca = await createNestablePublicClientApplication({
    auth: { clientId: "your-entra-client-id" }
});

function enableNestedAppAuth(): Promise<void>

Válaszok

Egy ígéret, amely akkor oldódik, amikor a híd készen áll, vagy elutasítják, ha a gazdagép nem támogatja a NAA-t.

Hozzáférési jogkivonat lekérése, amely lehetővé teszi a hívásokat más DevOps-szolgáltatásokba

function getAccessToken(): Promise<string>

Válaszok

Jogkivonat lekérése, amely az aktuális felhasználó azonosítására használható

function getAppToken(): Promise<string>

Válaszok

A kezdeti kézfogásban átadott konfigurációs adatok lekérése a szülőkeretből

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

Válaszok

Lekéri a bővítmény betöltését először okozó hozzájárulással kapcsolatos információkat.

function getContributionId(): string

Válaszok

Az üzemeltetett tartalom tulajdonosaként működő bővítmény kontextusának lekérése

function getExtensionContext(): IExtensionContext

Válaszok

Információt kap arról a gazdagépről (például egy Azure DevOps-szervezetről), amelyet az oldal megcéloz

function getHost(): IHostContext

Válaszok

A gazdagépoldal környezetének lekérése

function getPageContext(): IPageContext

Válaszok

Kérje le a hozzájárulást a megadott hozzájárulási azonosítóval. A visszaadott hozzájárulásnak van egy metódusa, amellyel be lehet szerezni egy regisztrált objektumot a hozzájáruláson belül.

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

Paraméterek

Válaszok

A lap által megcélzott csapat adatainak lekérdezése

function getTeamContext(): ITeamContext

Válaszok

Az aktuális felhasználóval kapcsolatos információk lekérdezése

function getUser(): IUserContext

Válaszok

A webes környezet lekérése

function getWebContext(): IWebContext

Válaszok

Elindítja a kézfogást a gazdagép ablakával.

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

Paraméterek

Válaszok

Értesíti a gazdagépet, hogy a bővítmény betöltése nem sikerült

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

Paraméterek

Válaszok

Értesíti a gazdagépet, hogy a bővítmény sikeresen be lett töltve (a betöltésjelző megjelenítésének leállítása)

function notifyLoadSucceeded(): Promise<void>

Válaszok

Regisztráljon egy visszahívást, amely a kezdeti beállítás/kézfogás befejeződése után lesz meghívva. Ha a kezdeti beállítás már befejeződött, a rendszer meghívja a visszahívást az aktuális hívásverem végén.

function ready(): Promise<void>

Válaszok

Regisztráljon egy objektumot (példányt vagy gyári metódust), amelyet ez a bővítmény elérhetővé tesz a gazdagépkeret számára.

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

Paraméterek

Kéri a szülőablakot, hogy méretezze át a tárolót ehhez a bővítményhez az aktuális bővítményméret alapján.

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

Paraméterek

Eltávolít egy objektumot, amelyet ez a bővítmény elérhetővé téve van a gazdagépkeretnek.

function unregister(instanceId: string)

Paraméterek

Web SDK verziószám. Megadhatók egy kiterjesztés követelménykészletében, például: vss-sdk-version/4.2

sdkVersion: 5

Típus