Compartilhar via


azure-devops-extension-sdk package

Classes

XDMChannel

Representa um canal de comunicação entre quadros\documento Permanece "ativo" em várias chamadas funtion\method

XDMObjectRegistry

Catálogo de objetos expostos para XDM

Interfaces

ContextIdentifier
GlobalizationContext
IExtensionContext

Identificador da extensão atual

IExtensionInitOptions

Opções para inicialização de extensão – passadas para DevOps.init()

IHostContext

Informações sobre o host de DevOps atual (organização)

IPageContext

Contexto global colocado em cada página da Web

ITeamContext

Informações sobre a equipe atual do DevOps

IUserContext

Informações sobre o usuário atual

IJsonRpcMessage

Representa uma rpc (chamada de procedimento remoto) entre quadros.

ISerializationSettings

Configurações relacionadas à serialização de dados entre limites de iframe.

IXDMChannel

Interface para um único canal XDM

IXDMChannelManager

Registro de canais XDM mantidos por quadro/janela de destino

IXDMObjectRegistry

Registro de objetos XDM que podem ser invocados por um canal XDM

Enumerações

HostType

Nível de host do DevOps

Funções

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

Aplica variáveis de tema ao documento atual

getAccessToken()

Buscar um token de acesso que permitirá que chamadas sejam feitas para outros serviços de DevOps

getAppToken()

Buscar um token que pode ser usado para identificar o usuário atual

getConfiguration()

Obter os dados de configuração passados no handshake inicial do quadro pai

getContributionId()

Obtém as informações sobre a contribuição que primeiro causou o carregamento dessa extensão.

getExtensionContext()

Obter o contexto sobre a extensão que possui o conteúdo que está sendo hospedado

getHost()

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

getPageContext()

Obter o contexto sobre a página de host

getService<T>(string)

Obtenha a contribuição com a ID de contribuição fornecida. A contribuição retornada tem um método para obter um objeto registrado dentro dessa contribuição.

getTeamContext()

Obtém informações sobre a equipe que a página está direcionando

getUser()

Obtém informações sobre o usuário atual

getWebContext()

Obter o contexto sobre a Web

init(IExtensionInitOptions)

Inicia o handshake com a janela do host.

notifyLoadFailed(string | Error)

Notifica o host de que a extensão falhou ao carregar

notifyLoadSucceeded()

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 será chamado depois que a instalaçã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 da extensão atual.

unregister(string)

Remove um objeto que essa extensão expôs ao quadro de 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()

Buscar 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 de host

function getPageContext(): IPageContext

Retornos

getService<T>(string)

Obtenha a contribuição com a ID de contribuição fornecida. 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()

Obtém informações sobre o usuário atual

function getUser(): IUserContext

Retornos

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 falhou ao carregar

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 será chamado depois que a instalaçã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 exclusiva do objeto registrado

instance

T

(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 da extensão atual.

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 de host.

function unregister(instanceId: string)

Parâmetros

instanceId

string

ID exclusiva do objeto registrado