Partilhar via

XDMChannel class

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

Representa um canal de comunicação entre frames\document Permanece "vivo" em várias chamadas de função\método

Construtores

XDMChannel(Window, string)

Métodos

error(IJsonRpcMessage, Error)
getObjectRegistry()

Obtenha o registo de objetos para processar mensagens deste canal específico. Após receber uma mensagem, este registo de canal será utilizado primeiro e, em seguida, o registo global será utilizado se não for encontrado nenhum processador aqui.
getRemoteObjectProxy<T>(string, Object)

Obtenha um objeto proxied que represente o objeto registado com o ID de instância especificado no lado remoto deste canal.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Invocar um método através de RPC. Procure o objeto registado na extremidade remota do canal e invoque o método especificado.
onMessage(IJsonRpcMessage)

Processe uma mensagem recebida neste canal. Enviar para o objeto adequado encontrado através do registo de objetos
owns(Window, string, IJsonRpcMessage)

Detalhes do Construtor

XDMChannel(Window, string) 

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

Parâmetros

postToWindow

Window

targetOrigin

string

Detalhes de Método

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parâmetros

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Obtenha o registo de objetos para processar mensagens deste canal específico. Após receber uma mensagem, este registo de canal será utilizado primeiro e, em seguida, o registo global será utilizado se não for encontrado nenhum processador aqui.

function getObjectRegistry(): IXDMObjectRegistry

Devoluções

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Obtenha um objeto proxied que represente o objeto registado com o ID de instância especificado no lado remoto deste canal.

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

Parâmetros

instanceId

string

ID exclusivo do objeto registado

contextData

Object

Dados de contexto opcionais para passar para o método de fábrica de um objeto registado

Devoluções

Promise<T>

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

Invocar um método através de RPC. Procure o objeto registado na extremidade remota 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 exclusivo do objeto registado

params

any[]

Argumentos para o método a invocar

instanceContextData

Object

Dados de contexto opcionais para passar para o método de fábrica de um objeto registado

serializationSettings
ISerializationSettings

Definições de serialização opcionais

Devoluções

Promise<T>

onMessage(IJsonRpcMessage)

Processe uma mensagem recebida neste canal. Enviar para o objeto adequado encontrado através do registo de objetos

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parâmetros

rpcMessage
IJsonRpcMessage

Dados da mensagem

Devoluções

boolean

Verdadeiro se a mensagem tiver sido processada por este canal. Caso contrário, falso.

owns(Window, string, IJsonRpcMessage) 

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

Parâmetros

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Devoluções

boolean