Sdílet prostřednictvím

XDMChannel class

  • Reference
Balíček:
azure-devops-extension-sdk

Představuje komunikační kanál mezi snímky\dokument zůstává "naživu" napříč několika voláními funtion\method.

Konstruktory

XDMChannel(Window, string)

Metody

error(IJsonRpcMessage, Error)
getObjectRegistry()

Získejte registr objektů pro zpracování zpráv z tohoto konkrétního kanálu. Po přijetí zprávy se nejprve použije tento registr kanálu a pak se použije globální registr, pokud zde nenajdete žádnou obslužnou rutinu.
getRemoteObjectProxy<T>(string, Object)

Získejte objekt proxied, který představuje objekt zaregistrovaný s daným ID instance na vzdálené straně tohoto kanálu.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Vyvolání metody přes RPC. Vyhledejte zaregistrovaný objekt na vzdáleném konci kanálu a vyvolejte zadanou metodu.
onMessage(IJsonRpcMessage)

Zpracování přijaté zprávy v tomto kanálu Odeslání do příslušného objektu nalezeného prostřednictvím registru objektů
owns(Window, string, IJsonRpcMessage)

Podrobnosti konstruktoru

XDMChannel(Window, string) 

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

Parametry

postToWindow

Window

targetOrigin

string

Podrobnosti metody

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parametry

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Získejte registr objektů pro zpracování zpráv z tohoto konkrétního kanálu. Po přijetí zprávy se nejprve použije tento registr kanálu a pak se použije globální registr, pokud zde nenajdete žádnou obslužnou rutinu.

function getObjectRegistry(): IXDMObjectRegistry

Návraty

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Získejte objekt proxied, který představuje objekt zaregistrovaný s daným ID instance na vzdálené straně tohoto kanálu.

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

Parametry

instanceId

string

jedinečné ID registrovaného objektu

contextData

Object

Volitelná kontextová data, která se mají předat do metody továrny registrovaného objektu

Návraty

Promise<T>

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

Vyvolání metody přes RPC. Vyhledejte zaregistrovaný objekt na vzdáleném konci kanálu a vyvolejte zadanou metodu.

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

Parametry

methodName

string

instanceId

string

jedinečné ID registrovaného objektu

params

any[]

Argumenty metody, která se má vyvolat

instanceContextData

Object

Volitelná kontextová data, která se mají předat do metody továrny registrovaného objektu

serializationSettings
ISerializationSettings

Volitelná nastavení serializace

Návraty

Promise<T>

onMessage(IJsonRpcMessage)

Zpracování přijaté zprávy v tomto kanálu Odeslání do příslušného objektu nalezeného prostřednictvím registru objektů

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parametry

rpcMessage
IJsonRpcMessage

Data zpráv

Návraty

boolean

True, pokud zprávu zpracovával tento kanál. V opačném případě nepravda.

owns(Window, string, IJsonRpcMessage) 

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

Parametry

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Návraty

boolean