XDMChannel class

Csomag:

azure-devops-extension-sdk

A keretek\dokumentum közötti kommunikáció csatornáját jelöli, amely "életben marad" több funtion\metódushívás között

Konstruktorok

XDMChannel(Window, string)

Metódusok

error(IJsonRpcMessage, Error)
getObjectRegistry()	Kérje le az objektumregisztrációs adatbázist az adott csatorna üzeneteinek kezeléséhez. Üzenet érkezésekor a rendszer először ezt a csatornaregisztrációs adatbázist használja, majd a globális beállításjegyzéket, ha itt nem található kezelő.
getRemoteObjectProxy<T>(string, Object)	Szerezzen be egy proxyzott objektumot, amely a csatorna távoli oldalán található, a megadott példányazonosítóval regisztrált objektumot jelöli.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)	Metódus meghívása RPC-n keresztül. Keresse meg a regisztrált objektumot a csatorna távoli végén, és hívja meg a megadott metódust.
onMessage(IJsonRpcMessage)	Fogadott üzenet kezelése ezen a csatornán. Küldés az objektumregisztrációs adatbázison keresztül található megfelelő objektumra
owns(Window, string, IJsonRpcMessage)

Konstruktor adatai

XDMChannel(Window, string)

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

Paraméterek

postToWindow

Window

targetOrigin

string

Metódus adatai

error(IJsonRpcMessage, Error)

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Paraméterek

messageObj

IJsonRpcMessage

errorObj

Error

getObjectRegistry()

Kérje le az objektumregisztrációs adatbázist az adott csatorna üzeneteinek kezeléséhez. Üzenet érkezésekor a rendszer először ezt a csatornaregisztrációs adatbázist használja, majd a globális beállításjegyzéket, ha itt nem található kezelő.

function getObjectRegistry(): IXDMObjectRegistry

Válaszok

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Szerezzen be egy proxyzott objektumot, amely a csatorna távoli oldalán található, a megadott példányazonosítóval regisztrált objektumot jelöli.

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

Paraméterek

instanceId

string

a regisztrált objektum egyedi azonosítója

contextData

Object

Nem kötelező környezeti adatok a regisztrált objektum gyári metódusának való továbbításhoz

Válaszok

Promise<T>

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

Metódus meghívása RPC-n keresztül. Keresse meg a regisztrált objektumot a csatorna távoli végén, és hívja meg a megadott metódust.

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

Paraméterek

methodName

string

instanceId

string

a regisztrált objektum egyedi azonosítója

params

any[]

A meghívandó metódus argumentumai

instanceContextData

Object

Nem kötelező környezeti adatok a regisztrált objektum gyári metódusának való továbbításhoz

serializationSettings

ISerializationSettings

Nem kötelező szerializálási beállítások

Válaszok

Promise<T>

onMessage(IJsonRpcMessage)

Fogadott üzenet kezelése ezen a csatornán. Küldés az objektumregisztrációs adatbázison keresztül található megfelelő objektumra

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Paraméterek

rpcMessage

IJsonRpcMessage

Üzenetadatok

Válaszok

boolean

Igaz, ha az üzenetet ez a csatorna kezelte. Egyéb esetben hamis.

owns(Window, string, IJsonRpcMessage)

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

Paraméterek

source

Window

origin

string

rpcMessage

IJsonRpcMessage

Válaszok

boolean