azure-devops-extension-sdk package

Classes

XDMChannel	Representa um canal de comunicação entre frames\document Permanece "vivo" em várias chamadas de função\método
XDMObjectRegistry	Catálogo de objetos expostos para XDM

Interfaces

ContextIdentifier
GlobalizationContext
IExtensionContext	Identificador da extensão atual
IExtensionInitOptions	Opções para inicialização da extensão – transmitidas para DevOps.init()
IHostContext	Informações sobre o anfitrião atual do DevOps (organização)
IPageContext	Contexto global colocado em cada página Web
ITeamContext	Informações sobre a equipa atual do DevOps
IUserContext	Informações sobre o utilizador atual
IJsonRpcMessage	Representa uma chamada de procedimento remoto (rpc) entre frames.
ISerializationSettings	Definições relacionadas com a serialização de dados entre limites de iframe.
IXDMChannel	Interface para um único canal XDM
IXDMChannelManager	Registo de canais XDM mantidos por frame/janela de destino
IXDMObjectRegistry	Registo de objetos XDM que podem ser invocados por um canal XDM

Enumerações

HostType

Nível de anfitrião de DevOps

Funções

applyTheme({[varName: string]: string})	Aplica variáveis de tema ao documento atual
getAccessToken()	Obter um token de acesso que permitirá efetuar chamadas para outros serviços de DevOps
getAppToken()	Obter um token que pode ser utilizado para identificar o utilizador atual
getConfiguration()	Obter os dados de configuração transmitidos no handshake inicial a partir da moldura principal
getContributionId()	Obtém as informações sobre a contribuição que fez com que esta extensão fosse carregada.
getExtensionContext()	Obter o contexto sobre a extensão que detém o conteúdo que está a ser alojado
getHost()	Obtém informações sobre o anfitrião (ou seja, uma organização do Azure DevOps) que a página está a direcionar
getPageContext()	Obter o contexto sobre a página do anfitrião
getService<T>(string)	Obtenha a contribuição com o ID de contribuição indicado. A contribuição devolvida tem um método para obter um objeto registado nessa contribuição.
getTeamContext()	Obtém informações sobre a equipa que a página está a direcionar
getUser()	Obtém informações sobre o utilizador atual
getWebContext()	Obter o contexto sobre a Web
init(IExtensionInitOptions)	Inicia o handshake com a janela do anfitrião.
notifyLoadFailed(string | Error)	Notifica o anfitrião de que a extensão não foi carregada
notifyLoadSucceeded()	Notifica o anfitrião de que a extensão foi carregada com êxito (pare de mostrar o indicador de carregamento)
ready()	Registe uma chamada de retorno que é chamada assim que a configuração/handshake inicial estiver concluída. Se a configuração inicial já estiver concluída, a chamada de retorno é invocada no final da pilha de chamadas atual.
register<T>(string, T)	Registe um objeto (instância ou método de fábrica) que esta extensão expõe à moldura do anfitrião.
resize(number, number)	Pede à janela principal para redimensionar o contentor para esta extensão com base no tamanho atual da extensão.
unregister(string)	Remove um objeto que esta extensão expôs à moldura do anfitrião.

Detalhes de 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()

Obter um token de acesso que permitirá efetuar chamadas para outros serviços de DevOps

function getAccessToken(): Promise<string>

Devoluções

Promise<string>

getAppToken()

Obter um token que pode ser utilizado para identificar o utilizador atual

function getAppToken(): Promise<string>

Devoluções

Promise<string>

getConfiguration()

Obter os dados de configuração transmitidos no handshake inicial a partir da moldura principal

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

Devoluções

{[key: string]: any}

getContributionId()

Obtém as informações sobre a contribuição que fez com que esta extensão fosse carregada.

function getContributionId(): string

Devoluções

string

getExtensionContext()

Obter o contexto sobre a extensão que detém o conteúdo que está a ser alojado

function getExtensionContext(): IExtensionContext

Devoluções

IExtensionContext

getHost()

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

function getHost(): IHostContext

Devoluções

IHostContext

getPageContext()

Obter o contexto sobre a página do anfitrião

function getPageContext(): IPageContext

Devoluções

IPageContext

getService<T>(string)

Obtenha a contribuição com o ID de contribuição indicado. A contribuição devolvida tem um método para obter um objeto registado nessa contribuição.

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

Parâmetros

contributionId

string

ID da contribuição a obter

Devoluções

Promise<T>

getTeamContext()

Obtém informações sobre a equipa que a página está a direcionar

function getTeamContext(): ITeamContext

Devoluções

ITeamContext

getUser()

Obtém informações sobre o utilizador atual

function getUser(): IUserContext

Devoluções

IUserContext

getWebContext()

Obter o contexto sobre a Web

function getWebContext(): IWebContext

Devoluções

IWebContext

init(IExtensionInitOptions)

Inicia o handshake com a janela do anfitrião.

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

Parâmetros

options

IExtensionInitOptions

Opções de inicialização para a extensão.

Devoluções

Promise<void>

notifyLoadFailed(string | Error)

Notifica o anfitrião de que a extensão não foi carregada

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

Parâmetros

e

string | Error

Devoluções

Promise<void>

notifyLoadSucceeded()

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

function notifyLoadSucceeded(): Promise<void>

Devoluções

Promise<void>

ready()

Registe uma chamada de retorno que é chamada assim que a configuração/handshake inicial estiver concluída. Se a configuração inicial já estiver concluída, a chamada de retorno é invocada no final da pilha de chamadas atual.

function ready(): Promise<void>

Devoluções

Promise<void>

register<T>(string, T)

Registe um objeto (instância ou método de fábrica) que esta extensão expõe à moldura do anfitrião.

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

Parâmetros

instanceId

string

ID exclusivo do objeto registado

instance

T

Ou: (1) uma instância de objeto ou (2) uma função que utiliza dados de contexto opcionais e devolve uma instância de objeto.

resize(number, number)

Pede à janela principal para redimensionar o contentor para esta extensão com base no tamanho atual da extensão.

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

Parâmetros

width

number

Largura opcional, predefinição para scrollWidth

height

number

Altura opcional, predefinição para scrollHeight

unregister(string)

Remove um objeto que esta extensão expôs à moldura do anfitrião.

function unregister(instanceId: string)

Parâmetros

instanceId

string

ID exclusivo do objeto registado