azure-devops-extension-sdk package
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 actual de DevOps (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 |
Enumeraciones
| HostType |
Nivel de host de DevOps |
Funciones
| apply |
Aplica variables de tema al documento actual |
| get |
Captura de un token de acceso que permitirá realizar llamadas a otros servicios de DevOps |
| get |
Captura de un token que se puede usar para identificar al usuario actual |
| get |
Obtención de los datos de configuración pasados en el protocolo de enlace inicial del marco primario |
| get |
Obtiene la información sobre la contribución que hizo que esta extensión se cargara por primera vez. |
| get |
Obtener el contexto sobre la extensión que posee el contenido que se hospeda |
| get |
Obtiene información sobre el host (es decir, una organización de Azure DevOps) que la página tiene como destino. |
| get |
Obtener el contexto sobre la página host |
| get |
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. |
| get |
Obtiene información sobre el equipo al que se dirige la página. |
| get |
Obtiene información sobre el usuario actual. |
| get |
Obtener el contexto sobre la web |
| init(IExtension |
Inicia el protocolo de enlace con la ventana host. |
| notify |
Notifica al host que la extensión no se pudo cargar. |
| notify |
Notifica al host que la extensión se ha cargado correctamente (deje 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 expone al marco 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 la extensión actual. |
| unregister(string) | Quita un objeto que esta extensión expone al marco 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á realizar 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 del 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
getHost()
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
getPageContext()
Obtener el contexto sobre la página host
function getPageContext(): IPageContext
Devoluciones
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
getUser()
Obtiene información sobre el usuario actual.
function getUser(): IUserContext
Devoluciones
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 ha cargado correctamente (deje 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 expone al marco host.
function register<T>(instanceId: string, instance: T)
Parámetros
- instanceId
-
string
identificador único del objeto registrado
- instance
-
T
Ya sea: (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 la 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 host.
function unregister(instanceId: string)
Parámetros
- instanceId
-
string
identificador único del objeto registrado