azure-devops-extension-sdk package

Aplica variáveis de tema ao documento atual

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

Parâmetros

Desativa a ponte de autenticação da aplicação aninhada. Após esta chamada, quaisquer pedidos de token MSAL receberão um BridgeDisabled erro. O objeto bridge mantém-se ligado window.nestedAppAuthBridge para que os ouvintes MSAL existentes não fiquem órfãos. Ligue enableNestedAppAuth() para reativar.

function disableNestedAppAuth()

Ative a Autenticação de Aplicações Aninhada (NAA) para esta extensão.

Configura window.nestedAppAuthBridge para que os MSAL createNestablePublicClientApplication possam delegar a aquisição de tokens ao host frame do Azure DevOps. Isto evita problemas de origem cruzada no BroadcastChannel que bloqueiam a autenticação baseada em popups nos iframes.

Chame isto depois init() e antes de criar uma instância MSAL. Exige que o host tenha suporte a NAA ativado.

Exemplo

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

function enableNestedAppAuth(): Promise<void>

Devoluções

Uma promessa que se resolve quando a ponte está pronta, ou rejeita se o host não suportar NAA.

Buscar um token de acesso que permitirá que chamadas sejam feitas para outros serviços de DevOps

function getAccessToken(): Promise<string>

Devoluções

Buscar um token que possa ser usado para identificar o usuário atual

function getAppToken(): Promise<string>

Devoluções

Obter os dados de configuração passados no handshake inicial do quadro pai

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

Devoluções

Obtém as informações sobre a contribuição que primeiro causou o carregamento dessa extensão.

function getContributionId(): string

Devoluções

Obter o contexto sobre a extensão proprietária do conteúdo que está sendo hospedado

function getExtensionContext(): IExtensionContext

Devoluções

Obtém informações sobre o host (ou seja, uma organização de DevOps do Azure) que a página está direcionando

function getHost(): IHostContext

Devoluções

Obter o contexto sobre a página do host

function getPageContext(): IPageContext

Devoluções

Obtenha a contribuição com o ID de contribuição dado. A contribuição devolvida tem um método para obter um objeto registrado dentro dessa contribuição.

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

Parâmetros

Devoluções

Obtém informações sobre a equipe que a página está segmentando

function getTeamContext(): ITeamContext

Devoluções

Obtém informações sobre o usuário atual

function getUser(): IUserContext

Devoluções

Obter o contexto sobre a Web

function getWebContext(): IWebContext

Devoluções

Inicia o handshake com a janela do host.

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

Parâmetros

Devoluções

Notifica o host de que a extensão falhou ao carregar

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

Parâmetros

Devoluções

Notifica o host de que a extensão foi carregada com êxito (parar de mostrar o indicador de carregamento)

function notifyLoadSucceeded(): Promise<void>

Devoluções

Registre um retorno de chamada que é chamado assim que a configuração/handshake inicial for concluída. Se a configuração inicial já estiver concluída, o retorno de chamada será invocado no final da pilha de chamadas atual.

function ready(): Promise<void>

Devoluções

Registre um objeto (instância ou método de fábrica) que essa extensão expõe ao quadro do host.

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

Parâmetros

Solicita que a janela pai redimensione o contêiner para essa extensão com base no tamanho da extensão atual.

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

Parâmetros

Remove um objeto que essa extensão expôs ao quadro do host.

function unregister(instanceId: string)

Parâmetros

Número de versão do Web SDK. Pode ser especificado no conjunto de exigências de uma extensão, como: vss-sdk-version/4.2

sdkVersion: 5

Tipo