Compartilhar via

XDMChannel class

  • Referência
Pacote:
azure-devops-extension-sdk

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

Construtores

XDMChannel(Window, string)

Métodos

error(IJsonRpcMessage, Error)
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, ISerializationSettings)

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

Manipule uma mensagem recebida neste canal. Expedir para o objeto apropriado encontrado por meio do registro de objeto
owns(Window, string, IJsonRpcMessage)

Detalhes do construtor

XDMChannel(Window, string) 

new XDMChannel(postToWindow: Window, targetOrigin?: string)

Parâmetros

postToWindow

Window

targetOrigin

string

Detalhes do método

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parâmetros

messageObj
IJsonRpcMessage
errorObj

Error

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, ISerializationSettings)

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, serializationSettings?: ISerializationSettings): 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

serializationSettings
ISerializationSettings

Configurações de serialização opcionais

Retornos

Promise<T>

onMessage(IJsonRpcMessage)

Manipule uma mensagem recebida neste canal. Expedir para o objeto apropriado encontrado por meio do registro de objeto

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parâmetros

rpcMessage
IJsonRpcMessage

Dados da mensagem

Retornos

boolean

True se a mensagem foi manipulada por este canal. Caso contrário, false.

owns(Window, string, IJsonRpcMessage) 

function owns(source: Window, origin: string, rpcMessage: IJsonRpcMessage): boolean

Parâmetros

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Retornos

boolean