azure-devops-extension-sdk package

Aplica variables de tema al documento actual

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

Parámetros

Desactiva el puente de autenticación de aplicaciones anidadas. Tras esta llamada, cualquier solicitud de token MSAL recibirá un BridgeDisabled error. El objeto puente permanece activado window.nestedAppAuthBridge para que los oyentes MSAL existentes no queden huérfanos. Llama enableNestedAppAuth() para reactivar.

function disableNestedAppAuth()

Activa la Autenticación de Aplicaciones Anidadas (NAA) para esta extensión.

Configura window.nestedAppAuthBridge para que los createNestablePublicClientApplication MSAL puedan delegar la adquisición de tokens al host frame de Azure DevOps. Esto evita problemas de BroadcastChannel de origen cruzado que bloquean la autenticación basada en ventanas emergentes en iframes.

Llámala después init() y antes de crear una instancia MSAL. Requiere que el host tenga habilitado el soporte NAA.

Ejemplo

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

function enableNestedAppAuth(): Promise<void>

Devoluciones

Una promesa que se resuelve cuando el puente está listo, o que se rechaza si el anfitrión no soporta NAA.

Captura de un token de acceso que permitirá realizar llamadas a otros servicios de DevOps

function getAccessToken(): Promise<string>

Devoluciones

Captura de un token que se puede usar para identificar al usuario actual

function getAppToken(): Promise<string>

Devoluciones

Obtención de los datos de configuración pasados en el protocolo de enlace inicial del marco primario

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

Devoluciones

Obtiene la información sobre la contribución que hizo que esta extensión se cargara por primera vez.

function getContributionId(): string

Devoluciones

Obtener el contexto sobre la extensión que posee el contenido que se hospeda

function getExtensionContext(): IExtensionContext

Devoluciones

Obtiene información sobre el host (es decir, una organización de Azure DevOps) que la página tiene como destino.

function getHost(): IHostContext

Devoluciones

Obtener el contexto sobre la página host

function getPageContext(): IPageContext

Devoluciones

Obtenga la contribución con el identificador de contribución especificado. La contribución devuelta tiene un método para obtener un objeto registrado dentro de esa contribución.

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

Parámetros

Devoluciones

Obtiene información sobre el equipo al que se dirige la página.

function getTeamContext(): ITeamContext

Devoluciones

Obtiene información sobre el usuario actual.

function getUser(): IUserContext

Devoluciones

Obtener el contexto sobre la web

function getWebContext(): IWebContext

Devoluciones

Inicia el protocolo de enlace con la ventana host.

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

Parámetros

Devoluciones

Notifica al host que la extensión no se pudo cargar.

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

Parámetros

Devoluciones

Notifica al host que la extensión se ha cargado correctamente (deje de mostrar el indicador de carga).

function notifyLoadSucceeded(): Promise<void>

Devoluciones

Registre una devolución de llamada a la que se llama una vez completada la configuración inicial o el protocolo de enlace. Si la configuración inicial ya se ha completado, se invoca la devolución de llamada al final de la pila de llamadas actual.

function ready(): Promise<void>

Devoluciones

Registre un objeto (instancia o método de fábrica) que esta extensión expone al marco host.

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

Parámetros

Solicita a la ventana primaria que cambie el tamaño del contenedor de esta extensión en función del tamaño de la extensión actual.

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

Parámetros

Quita un objeto que esta extensión expone al marco host.

function unregister(instanceId: string)

Parámetros

Número de versión del SDK web. Puede especificarse en el conjunto de demandas de una extensión como: vss-sdk-version/4.2

sdkVersion: 5

Tipo