Delen via

XDMChannel class

  • Referentie
Pakket:
azure-devops-extension-sdk

Vertegenwoordigt een communicatiekanaal tussen frames\document blijft 'in leven' bij meerdere aanroepen van funtion\method

Constructors

XDMChannel(Window, string)

Methoden

error(IJsonRpcMessage, Error)
getObjectRegistry()

Haal het objectregister op om berichten van dit specifieke kanaal te verwerken. Wanneer u een bericht ontvangt, wordt dit kanaalregister eerst gebruikt, waarna het globale register wordt gebruikt als hier geen handler wordt gevonden.
getRemoteObjectProxy<T>(string, Object)

Haal een geproxied object op dat het object vertegenwoordigt dat is geregistreerd met de opgegeven exemplaar-id aan de externe kant van dit kanaal.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Een methode aanroepen via RPC. Zoek het geregistreerde object op aan de externe kant van het kanaal en roep de opgegeven methode aan.
onMessage(IJsonRpcMessage)

Een ontvangen bericht op dit kanaal verwerken. Verzend naar het juiste object dat via het objectregister is gevonden
owns(Window, string, IJsonRpcMessage)

Constructordetails

XDMChannel(Window, string) 

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

Parameters

postToWindow

Window

targetOrigin

string

Methodedetails

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parameters

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Haal het objectregister op om berichten van dit specifieke kanaal te verwerken. Wanneer u een bericht ontvangt, wordt dit kanaalregister eerst gebruikt, waarna het globale register wordt gebruikt als hier geen handler wordt gevonden.

function getObjectRegistry(): IXDMObjectRegistry

Retouren

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Haal een geproxied object op dat het object vertegenwoordigt dat is geregistreerd met de opgegeven exemplaar-id aan de externe kant van dit kanaal.

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

Parameters

instanceId

string

unieke id van het geregistreerde object

contextData

Object

Optionele contextgegevens die moeten worden doorgegeven aan de factorymethode van een geregistreerd object

Retouren

Promise<T>

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

Een methode aanroepen via RPC. Zoek het geregistreerde object op aan de externe kant van het kanaal en roep de opgegeven methode aan.

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

Parameters

methodName

string

instanceId

string

unieke id van het geregistreerde object

params

any[]

Argumenten voor de methode om aan te roepen

instanceContextData

Object

Optionele contextgegevens die moeten worden doorgegeven aan de factorymethode van een geregistreerd object

serializationSettings
ISerializationSettings

Optionele serialisatie-instellingen

Retouren

Promise<T>

onMessage(IJsonRpcMessage)

Een ontvangen bericht op dit kanaal verwerken. Verzend naar het juiste object dat via het objectregister is gevonden

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parameters

rpcMessage
IJsonRpcMessage

Berichtgegevens

Retouren

boolean

True als het bericht is verwerkt door dit kanaal. Anders onwaar.

owns(Window, string, IJsonRpcMessage) 

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

Parameters

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Retouren

boolean