IXDMChannel interface

Pacote:

azure-devops-extension-sdk

Interface para um único canal XDM

Métodos

getObjectRegistry()	Obtenha o registro de objeto para manipular mensagens deste canal específico. Ao receber uma mensagem, esse registro de canal será usado primeiro e, em seguida, o registro global será usado se nenhum manipulador for encontrado aqui.
getRemoteObjectProxy<T>(string, Object)	Obtenha um objeto proxied que representa o objeto registrado com a ID de instância fornecida no lado remoto deste canal.
invokeRemoteMethod<T>(string, string, any[], Object)	Invoque um método por meio de RPC. Pesquise o objeto registrado no final remoto do canal e invoque o método especificado.

Detalhes do método

getObjectRegistry()

Obtenha o registro de objeto para manipular mensagens deste canal específico. Ao receber uma mensagem, esse registro de canal será usado primeiro e, em seguida, o registro global será usado se nenhum manipulador for encontrado aqui.

function getObjectRegistry(): IXDMObjectRegistry

Retornos

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Obtenha um objeto proxied que representa o objeto registrado com a ID de instância fornecida no lado remoto deste canal.

function getRemoteObjectProxy<T>(instanceId: string, contextData?: Object): Promise<T>

Parâmetros

instanceId

string

ID exclusiva do objeto registrado

contextData

Object

Dados de contexto opcionais a serem passados para o método de fábrica de um objeto registrado

Retornos

Promise<T>

invokeRemoteMethod<T>(string, string, any[], Object)

Invoque um método por meio de RPC. Pesquise o objeto registrado no final remoto do canal e invoque o método especificado.

function invokeRemoteMethod<T>(methodName: string, instanceId: string, params?: any[], instanceContextData?: Object): Promise<T>

Parâmetros

methodName

string

instanceId

string

ID exclusiva do objeto registrado

params

any[]

Argumentos para o método a ser invocado

instanceContextData

Object

Dados de contexto opcionais a serem passados para o método de fábrica de um objeto registrado

Retornos

Promise<T>