azure-devops-extension-sdk package
Interfaces
| ContextIdentifier | |
| GlobalizationContext | |
| IExtensionContext |
Identificador para a extensão atual |
| IExtensionInitOptions |
Opções para inicialização de extensão -- passadas para DevOps.init() |
| IHostContext |
Informações sobre o host DevOps atual (organização) |
| IPageContext |
Contexto global colocado em cada página da web |
| ITeamContext |
Informações sobre a equipe atual de DevOps |
| IUserContext |
Informações sobre o usuário atual |
Enumerações
| HostType |
Nível de host DevOps |
Funções
| apply |
Aplica variáveis de tema ao documento atual |
| get |
Busque um token de acesso que permitirá que chamadas sejam feitas para outros serviços de DevOps |
| get |
Buscar um token que pode ser usado para identificar o usuário atual |
| get |
Obter os dados de configuração passados no handshake inicial do quadro pai |
| get |
Obtém as informações sobre a contribuição que primeiro causou o carregamento dessa extensão. |
| get |
Obter o contexto sobre a extensão que possui o conteúdo que está sendo hospedado |
| get |
Obtém informações sobre o host (ou seja, uma organização do Azure DevOps) que a página está direcionando |
| get |
Obter o contexto sobre a página do host |
| get |
Obtenha a contribuição com o ID de contribuição fornecido. A contribuição retornada tem um método para obter um objeto registrado dentro dessa contribuição. |
| get |
Obtém informações sobre a equipe que a página está direcionando |
| get |
Obtém informações sobre o usuário atual |
| get |
Obter o contexto sobre a Web |
| init(IExtension |
Inicia o handshake com a janela do host. |
| notify |
Notifica o host de que a extensão não foi carregada |
| notify |
Notifica o host de que a extensão foi carregada com êxito (pare de mostrar o indicador de carregamento) |
| ready() | 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. |
| register<T>(string, T) | Registre um objeto (instância ou método de fábrica) que essa extensão expõe ao quadro do host. |
| resize(number, number) | Solicita que a janela pai redimensione o contêiner para essa extensão com base no tamanho atual da extensão. |
| unregister(string) | Remove um objeto que essa extensão expôs ao quadro host. |
Detalhes da função
applyTheme({[varName: string]: string})
Aplica variáveis de tema ao documento atual
function applyTheme(themeData: {[varName: string]: string})
Parâmetros
- themeData
-
{[varName: string]: string}
getAccessToken()
Busque um token de acesso que permitirá que chamadas sejam feitas para outros serviços de DevOps
function getAccessToken(): Promise<string>
Retornos
Promise<string>
getAppToken()
Buscar um token que pode ser usado para identificar o usuário atual
function getAppToken(): Promise<string>
Retornos
Promise<string>
getConfiguration()
Obter os dados de configuração passados no handshake inicial do quadro pai
function getConfiguration(): {[key: string]: any}
Retornos
{[key: string]: any}
getContributionId()
Obtém as informações sobre a contribuição que primeiro causou o carregamento dessa extensão.
function getContributionId(): string
Retornos
string
getExtensionContext()
Obter o contexto sobre a extensão que possui o conteúdo que está sendo hospedado
function getExtensionContext(): IExtensionContext
Retornos
getHost()
Obtém informações sobre o host (ou seja, uma organização do Azure DevOps) que a página está direcionando
function getHost(): IHostContext
Retornos
getPageContext()
Obter o contexto sobre a página do host
function getPageContext(): IPageContext
Retornos
getService<T>(string)
Obtenha a contribuição com o ID de contribuição fornecido. A contribuição retornada tem um método para obter um objeto registrado dentro dessa contribuição.
function getService<T>(contributionId: string): Promise<T>
Parâmetros
- contributionId
-
string
ID da contribuição para obter
Retornos
Promise<T>
getTeamContext()
Obtém informações sobre a equipe que a página está direcionando
function getTeamContext(): ITeamContext
Retornos
getUser()
getWebContext()
Obter o contexto sobre a Web
function getWebContext(): IWebContext
Retornos
IWebContext
init(IExtensionInitOptions)
Inicia o handshake com a janela do host.
function init(options?: IExtensionInitOptions): Promise<void>
Parâmetros
- options
- IExtensionInitOptions
Opções de inicialização para a extensão.
Retornos
Promise<void>
notifyLoadFailed(string | Error)
Notifica o host de que a extensão não foi carregada
function notifyLoadFailed(e: string | Error): Promise<void>
Parâmetros
- e
-
string | Error
Retornos
Promise<void>
notifyLoadSucceeded()
Notifica o host de que a extensão foi carregada com êxito (pare de mostrar o indicador de carregamento)
function notifyLoadSucceeded(): Promise<void>
Retornos
Promise<void>
ready()
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>
Retornos
Promise<void>
register<T>(string, T)
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
- instanceId
-
string
ID exclusivo do objeto registrado
- instance
-
T
Ou: (1) uma instância de objeto ou (2) uma função que usa dados de contexto opcionais e retorna uma instância de objeto.
resize(number, number)
Solicita que a janela pai redimensione o contêiner para essa extensão com base no tamanho atual da extensão.
function resize(width?: number, height?: number)
Parâmetros
- width
-
number
Largura opcional, o padrão é scrollWidth
- height
-
number
Altura opcional, o padrão é scrollHeight
unregister(string)
Remove um objeto que essa extensão expôs ao quadro host.
function unregister(instanceId: string)
Parâmetros
- instanceId
-
string
ID exclusivo do objeto registrado