Compartir a través de

azure-devops-extension-sdk package

  • Referencia

Clases

XDMChannel

Representa un canal de comunicación entre frames\document Stays "alive" en varias llamadas funtion\method.
XDMObjectRegistry

Catálogo de objetos expuestos para XDM

Interfaces

ContextIdentifier
GlobalizationContext
IExtensionContext

Identificador de la extensión actual
IExtensionInitOptions

Opciones para la inicialización de extensiones: se pasa a DevOps.init()
IHostContext

Información sobre el host de DevOps actual (organización)
IPageContext

Contexto global colocado en cada página web
ITeamContext

Información sobre el equipo actual de DevOps
IUserContext

Información sobre el usuario actual
IJsonRpcMessage

Representa una llamada a procedimiento remoto (rpc) entre fotogramas.
ISerializationSettings

Configuración relacionada con la serialización de datos a través de límites de iframe.
IXDMChannel

Interfaz para un único canal XDM
IXDMChannelManager

Registro de canales XDM mantenidos por marco o ventana de destino
IXDMObjectRegistry

Registro de objetos XDM que un canal XDM puede invocar

Enumeraciones

HostType

Nivel de host de DevOps

Funciones

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

Aplica variables de tema al documento actual
getAccessToken()

Captura de un token de acceso que permitirá que se realicen llamadas a otros servicios de DevOps
getAppToken()

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

Obtención de los datos de configuración pasados en el protocolo de enlace inicial desde el marco primario
getContributionId()

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

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

Obtiene información sobre el host (es decir, una organización de Azure DevOps) a la que se dirige la página.
getPageContext()

Obtener el contexto sobre la página host
getService<T>(string)

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.
getTeamContext()

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

Obtiene información sobre el usuario actual.
getWebContext()

Obtener el contexto sobre la web
init(IExtensionInitOptions)

Inicia el protocolo de enlace con la ventana host.
notifyLoadFailed(string | Error)

Notifica al host que la extensión no se pudo cargar
notifyLoadSucceeded()

Notifica al host que la extensión se cargó correctamente (deja de mostrar el indicador de carga).
ready()

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.
register<T>(string, T)

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

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

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

Detalles de la función

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

Aplica variables de tema al documento actual

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

Parámetros

themeData

{[varName: string]: string}

getAccessToken()

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

function getAccessToken(): Promise<string>

Devoluciones

Promise<string>

getAppToken()

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

function getAppToken(): Promise<string>

Devoluciones

Promise<string>

getConfiguration()

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

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

Devoluciones

{[key: string]: any}

getContributionId()

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

function getContributionId(): string

Devoluciones

string

getExtensionContext()

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

function getExtensionContext(): IExtensionContext

Devoluciones

IExtensionContext

getHost()

Obtiene información sobre el host (es decir, una organización de Azure DevOps) a la que se dirige la página.

function getHost(): IHostContext

Devoluciones

IHostContext

getPageContext()

Obtener el contexto sobre la página host

function getPageContext(): IPageContext

Devoluciones

IPageContext

getService<T>(string)

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

contributionId

string

Identificador de la contribución que se va a obtener

Devoluciones

Promise<T>

getTeamContext()

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

function getTeamContext(): ITeamContext

Devoluciones

ITeamContext

getUser()

Obtiene información sobre el usuario actual.

function getUser(): IUserContext

Devoluciones

IUserContext

getWebContext()

Obtener el contexto sobre la web

function getWebContext(): IWebContext

Devoluciones

IWebContext

init(IExtensionInitOptions)

Inicia el protocolo de enlace con la ventana host.

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

Parámetros

options
IExtensionInitOptions

Opciones de inicialización para la extensión.

Devoluciones

Promise<void>

notifyLoadFailed(string | Error)

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

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

Parámetros

e

string | Error

Devoluciones

Promise<void>

notifyLoadSucceeded()

Notifica al host que la extensión se cargó correctamente (deja de mostrar el indicador de carga).

function notifyLoadSucceeded(): Promise<void>

Devoluciones

Promise<void>

ready()

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

Promise<void>

register<T>(string, T)

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

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

Parámetros

instanceId

string

identificador único del objeto registrado

instance

T

O bien: (1) una instancia de objeto o (2) una función que toma datos de contexto opcionales y devuelve una instancia de objeto.

resize(number, number)

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

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

Parámetros

width

number

Ancho opcional, el valor predeterminado es scrollWidth.

height

number

Alto opcional, el valor predeterminado es scrollHeight.

unregister(string)

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

function unregister(instanceId: string)

Parámetros

instanceId

string

identificador único del objeto registrado