Compartir a través de

XDMChannel class

  • Referencia
Paquete:
azure-devops-extension-sdk

Representa un canal de comunicación entre fotogramas\documento permanece "activo" en varias llamadas de funtion\method.

Constructores

XDMChannel(Window, string)

Métodos

error(IJsonRpcMessage, Error)
getObjectRegistry()

Obtenga el registro de objetos para controlar los mensajes de este canal específico. Después de recibir un mensaje, este registro de canal se usará primero y, a continuación, se usará el registro global si no se encuentra ningún controlador aquí.
getRemoteObjectProxy<T>(string, Object)

Obtiene un objeto proxy que representa el objeto registrado con el identificador de instancia especificado en el lado remoto de este canal.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Invoque un método a través de RPC. Busque el objeto registrado en el extremo remoto del canal e invoque el método especificado.
onMessage(IJsonRpcMessage)

Controle un mensaje recibido en este canal. Envío al objeto adecuado encontrado a través del Registro de objetos
owns(Window, string, IJsonRpcMessage)

Detalles del constructor

XDMChannel(Window, string) 

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

Parámetros

postToWindow

Window

targetOrigin

string

Detalles del método

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parámetros

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Obtenga el registro de objetos para controlar los mensajes de este canal específico. Después de recibir un mensaje, este registro de canal se usará primero y, a continuación, se usará el registro global si no se encuentra ningún controlador aquí.

function getObjectRegistry(): IXDMObjectRegistry

Devoluciones

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Obtiene un objeto proxy que representa el objeto registrado con el identificador de instancia especificado en el lado remoto de este canal.

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

Parámetros

instanceId

string

identificador único del objeto registrado

contextData

Object

Datos de contexto opcionales para pasar al método de fábrica de un objeto registrado

Devoluciones

Promise<T>

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

Invoque un método a través de RPC. Busque el objeto registrado en el extremo remoto del canal e invoque el método especificado.

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

Parámetros

methodName

string

instanceId

string

identificador único del objeto registrado

params

any[]

Argumentos para el método que se va a invocar

instanceContextData

Object

Datos de contexto opcionales para pasar al método de fábrica de un objeto registrado

serializationSettings
ISerializationSettings

Configuración de serialización opcional

Devoluciones

Promise<T>

onMessage(IJsonRpcMessage)

Controle un mensaje recibido en este canal. Envío al objeto adecuado encontrado a través del Registro de objetos

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parámetros

rpcMessage
IJsonRpcMessage

Datos de mensajes

Devoluciones

boolean

True si este canal controló el mensaje. De lo contrario, false.

owns(Window, string, IJsonRpcMessage) 

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

Parámetros

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Devoluciones

boolean