Partager via

XDMChannel class

  • Référence
Paquet:
azure-devops-extension-sdk

Représente un canal de communication entre frames\document Reste « vivant » entre plusieurs appels de funtion\méthode

Constructeurs

XDMChannel(Window, string)

Méthodes

error(IJsonRpcMessage, Error)
getObjectRegistry()

Obtenez le registre d’objets pour gérer les messages de ce canal spécifique. Lors de la réception d’un message, ce registre de canaux sera utilisé en premier, puis le registre global sera utilisé si aucun gestionnaire n’est trouvé ici.
getRemoteObjectProxy<T>(string, Object)

Obtenez un objet proxied qui représente l’objet inscrit avec l’ID de instance donné sur le côté distant de ce canal.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Appelez une méthode via RPC. Recherchez l’objet inscrit à l’extrémité distante du canal et appelez la méthode spécifiée.
onMessage(IJsonRpcMessage)

Gérer un message reçu sur ce canal. Distribuer à l’objet approprié trouvé via le registre d’objets
owns(Window, string, IJsonRpcMessage)

Détails du constructeur

XDMChannel(Window, string) 

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

Paramètres

postToWindow

Window

targetOrigin

string

Détails de la méthode

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Paramètres

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Obtenez le registre d’objets pour gérer les messages de ce canal spécifique. Lors de la réception d’un message, ce registre de canaux sera utilisé en premier, puis le registre global sera utilisé si aucun gestionnaire n’est trouvé ici.

function getObjectRegistry(): IXDMObjectRegistry

Retours

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Obtenez un objet proxied qui représente l’objet inscrit avec l’ID de instance donné sur le côté distant de ce canal.

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

Paramètres

instanceId

string

ID unique de l’objet inscrit

contextData

Object

Données de contexte facultatives à passer à la méthode de fabrique d’un objet inscrit

Retours

Promise<T>

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

Appelez une méthode via RPC. Recherchez l’objet inscrit à l’extrémité distante du canal et appelez la méthode spécifiée.

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

Paramètres

methodName

string

instanceId

string

ID unique de l’objet inscrit

params

any[]

Arguments de la méthode à appeler

instanceContextData

Object

Données de contexte facultatives à passer à la méthode de fabrique d’un objet inscrit

serializationSettings
ISerializationSettings

Paramètres de sérialisation facultatifs

Retours

Promise<T>

onMessage(IJsonRpcMessage)

Gérer un message reçu sur ce canal. Distribuer à l’objet approprié trouvé via le registre d’objets

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Paramètres

rpcMessage
IJsonRpcMessage

Données de message

Retours

boolean

True si le message a été géré par ce canal. Sinon, false.

owns(Window, string, IJsonRpcMessage) 

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

Paramètres

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Retours

boolean