azure-devops-extension-sdk package

Applica le variabili del tema al documento corrente

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

Parametri

Disabilita il bridge di autenticazione delle app annidate. Dopo questa chiamata, qualsiasi richiesta di token MSAL riceverà un BridgeDisabled errore. L'oggetto bridge rimane attivo window.nestedAppAuthBridge così che gli ascoltatori MSAL esistenti non siano orfani. Chiama enableNestedAppAuth() per riattivarlo.

function disableNestedAppAuth()

Abilita l'autenticazione con app annidata (NAA) per questa estensione.

Imposta window.nestedAppAuthBridge in modo che gli createNestablePublicClientApplication MSAL possano delegare l'acquisizione dei token al frame host Azure DevOps. Questo evita problemi cross-origin di BroadcastChannel che bloccano l'autenticazione basata su popup negli iframe.

Chiama questo dopo init() e prima di creare un'istanza MSAL. Richiede che l'host abbia abilitato il supporto NAA.

Esempio

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

function enableNestedAppAuth(): Promise<void>

Valori restituiti

Una promessa che si risolve quando il bridge è pronto, o che viene rifiutata se l'host non supporta NAA.

Recuperare un token di accesso che consentirà di effettuare chiamate ad altri servizi DevOps

function getAccessToken(): Promise<string>

Valori restituiti

Recuperare un token che può essere usato per identificare l'utente corrente

function getAppToken(): Promise<string>

Valori restituiti

Ottenere i dati di configurazione passati nell'handshake iniziale dal frame padre

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

Valori restituiti

Ottiene le informazioni sul contributo che ha causato il caricamento dell'estensione.

function getContributionId(): string

Valori restituiti

Ottenere il contesto sull'estensione proprietaria del contenuto ospitato

function getExtensionContext(): IExtensionContext

Valori restituiti

Ottiene informazioni sull'host (ad esempio un'organizzazione di Azure DevOps) che la pagina ha come destinazione

function getHost(): IHostContext

Valori restituiti

Ottenere il contesto sulla pagina host

function getPageContext(): IPageContext

Valori restituiti

Ottenere il contributo con l'ID contributo specificato. Il contributo restituito ha un metodo per ottenere un oggetto registrato all'interno di tale contributo.

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

Parametri

Valori restituiti

Ottiene informazioni sul team di destinazione della pagina

function getTeamContext(): ITeamContext

Valori restituiti

Ottiene informazioni sull'utente corrente

function getUser(): IUserContext

Valori restituiti

Ottenere il contesto sul Web

function getWebContext(): IWebContext

Valori restituiti

Avvia l'handshake con la finestra host.

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

Parametri

Valori restituiti

Notifica all'host che l'estensione non è riuscita a caricare

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

Parametri

Valori restituiti

Notifica all'host che l'estensione è stata caricata correttamente (arrestare la visualizzazione dell'indicatore di caricamento)

function notifyLoadSucceeded(): Promise<void>

Valori restituiti

Registrare un callback che viene chiamato dopo il completamento dell'installazione/handshake iniziale. Se l'installazione iniziale è già stata completata, il callback viene richiamato alla fine dello stack di chiamate corrente.

function ready(): Promise<void>

Valori restituiti

Registrare un oggetto (metodo di istanza o factory) esposto da questa estensione al frame host.

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

Parametri

Richiede alla finestra padre di ridimensionare il contenitore per questa estensione in base alle dimensioni correnti dell'estensione.

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

Parametri

Rimuove un oggetto esposto dall'estensione al frame host.

function unregister(instanceId: string)

Parametri

Numero di versione del Web SDK. Può essere specificato nell'insieme di richieste di un'estensione come: vss-sdk-version/4.2

sdkVersion: 5

Tipo