XDMChannel class

  • Referenz
Paket:
azure-devops-extension-sdk

Stellt einen Kommunikationskanal zwischen frames\document bleibt "lebendig" über mehrere Funtion\method-Aufrufe dar.

Konstruktoren

XDMChannel(Window, string)

Methoden

error(IJsonRpcMessage, Error)
getObjectRegistry()

Rufen Sie die Objektregistrierung zum Verarbeiten von Nachrichten aus diesem spezifischen Kanal ab. Beim Empfang einer Nachricht wird zuerst diese Kanalregistrierung verwendet, dann wird die globale Registrierung verwendet, wenn hier kein Handler gefunden wird.
getRemoteObjectProxy<T>(string, Object)

Rufen Sie ein perxies Objekt ab, das das Objekt darstellt, das mit der angegebenen instance-ID auf der Remoteseite dieses Kanals registriert ist.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Rufen Sie eine Methode über RPC auf. Suchen Sie das registrierte Objekt am Remoteende des Kanals, und rufen Sie die angegebene Methode auf.
onMessage(IJsonRpcMessage)

Behandeln einer empfangenen Nachricht in diesem Kanal. Senden an das entsprechende Objekt, das über die Objektregistrierung gefunden wurde
owns(Window, string, IJsonRpcMessage)

Details zum Konstruktor

XDMChannel(Window, string) 

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

Parameter

postToWindow

Window

targetOrigin

string

Details zur Methode

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parameter

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Rufen Sie die Objektregistrierung zum Verarbeiten von Nachrichten aus diesem spezifischen Kanal ab. Beim Empfang einer Nachricht wird zuerst diese Kanalregistrierung verwendet, dann wird die globale Registrierung verwendet, wenn hier kein Handler gefunden wird.

function getObjectRegistry(): IXDMObjectRegistry

Gibt zurück

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Rufen Sie ein perxies Objekt ab, das das Objekt darstellt, das mit der angegebenen instance-ID auf der Remoteseite dieses Kanals registriert ist.

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

Parameter

instanceId

string

eindeutige ID des registrierten Objekts

contextData

Object

Optionale Kontextdaten, die an die Factorymethode eines registrierten Objekts übergeben werden sollen

Gibt zurück

Promise<T>

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

Rufen Sie eine Methode über RPC auf. Suchen Sie das registrierte Objekt am Remoteende des Kanals, und rufen Sie die angegebene Methode auf.

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

Parameter

methodName

string

instanceId

string

eindeutige ID des registrierten Objekts

params

any[]

Argumente für die aufzurufende Methode

instanceContextData

Object

Optionale Kontextdaten, die an die Factorymethode eines registrierten Objekts übergeben werden sollen

serializationSettings
ISerializationSettings

Optionale Serialisierungseinstellungen

Gibt zurück

Promise<T>

onMessage(IJsonRpcMessage)

Behandeln einer empfangenen Nachricht in diesem Kanal. Senden an das entsprechende Objekt, das über die Objektregistrierung gefunden wurde

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parameter

rpcMessage
IJsonRpcMessage

Nachrichtendaten

Gibt zurück

boolean

True, wenn die Nachricht von diesem Kanal verarbeitet wurde. Andernfalls false.

owns(Window, string, IJsonRpcMessage) 

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

Parameter

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Gibt zurück

boolean