azure-devops-extension-sdk package

Aplikuje proměnné motivu na aktuální dokument

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

Parametry

Vypíná most Nested App Authentication. Po tomto volání dostanou všechny požadavky na MSAL token chybu BridgeDisabled . Objekt mostu zůstává zapnutý window.nestedAppAuthBridge , takže stávající posluchači MSAL nejsou osiřelí. Zavolejte enableNestedAppAuth() pro opětovné zapojení.

function disableNestedAppAuth()

Pro toto rozšíření povolte Nested App Authentication (NAA).

Nastavuje window.nestedAppAuthBridge tak, aby MSAL mohly createNestablePublicClientApplication delegovat získávání tokenů na host frame Azure DevOps. Tím se předchází problémům s BroadcastChannel mezi původními stránkami, které blokují autentizaci založenou na vyskakovacích oknech v iframech.

Nazvěte to po init() a před vytvořením instance MSAL. Vyžaduje, aby měl host zapnutou podporu NAA.

Příklad

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

function enableNestedAppAuth(): Promise<void>

Návraty

Slib, který se vyřeší, když bude most připraven, nebo odmítne, pokud hostitel NAA nepodporuje.

Načtěte přístupový token, který umožní volat do jiných služeb DevOps

function getAccessToken(): Promise<string>

Návraty

Načíst token, který lze použít k identifikaci aktuálního uživatele

function getAppToken(): Promise<string>

Návraty

Získání konfiguračních dat předaných v počátečním handshake z nadřazeného rámce

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

Návraty

Získá informace o příspěvku, který jako první způsobil načtení tohoto rozšíření.

function getContributionId(): string

Návraty

Získejte kontext o rozšíření, které vlastní hostovaný obsah

function getExtensionContext(): IExtensionContext

Návraty

Získá informace o hostiteli (tj. organizaci Azure DevOps), na kterého stránka cílí

function getHost(): IHostContext

Návraty

Získání kontextu hostitelské stránky

function getPageContext(): IPageContext

Návraty

Získejte příspěvek s daným ID příspěvku. Vrácený příspěvek má metodu pro získání registrovaného objektu v rámci tohoto příspěvku.

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

Parametry

Návraty

Získá informace o týmu, na který stránka cílí

function getTeamContext(): ITeamContext

Návraty

Získá informace o aktuálním uživateli

function getUser(): IUserContext

Návraty

Získejte kontext o webu

function getWebContext(): IWebContext

Návraty

Zahájí metodu handshake s oknem hostitele.

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

Parametry

Návraty

Upozorní hostitele, že se nepodařilo načíst rozšíření

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

Parametry

Návraty

Upozorní hostitele, že rozšíření bylo úspěšně načteno (přestane se zobrazovat indikátor načítání)

function notifyLoadSucceeded(): Promise<void>

Návraty

Zaregistrujte zpětné volání, které se volá po dokončení počátečního nastavení/metody handshake. Pokud je počáteční nastavení již dokončeno, zpětné volání je vyvoláno na konci aktuálního zásobníku volání.

function ready(): Promise<void>

Návraty

Zaregistrujte objekt (instanci nebo metodu továrny), který toto rozšíření zpřístupňuje hostitelskému rámci.

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

Parametry

Požádá nadřazené okno o změnu velikosti kontejneru pro toto rozšíření na základě aktuální velikosti rozšíření.

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

Parametry

Odstraní objekt, který tento doplněk vystavil hostitelskému snímku.

function unregister(instanceId: string)

Parametry

Číslo verze webového SDK. Lze specifikovat v sadě požadavků rozšíření, například: vss-sdk-version/4.2

sdkVersion: 5

Typ