Dela via

XDMChannel class

  • Referens
Paket:
azure-devops-extension-sdk

Representerar en kommunikationskanal mellan ramar\dokument förblir "levande" över flera funtion\method-anrop

Konstruktorer

XDMChannel(Window, string)

Metoder

error(IJsonRpcMessage, Error)
getObjectRegistry()

Hämta objektregistret för att hantera meddelanden från den här specifika kanalen. När du får ett meddelande används det här kanalregistret först och sedan används det globala registret om ingen hanterare hittas här.
getRemoteObjectProxy<T>(string, Object)

Hämta ett proxierat objekt som representerar objektet som registrerats med det angivna instans-ID:t på fjärrsidan av den här kanalen.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Anropa en metod via RPC. Leta upp det registrerade objektet på fjärrslutet av kanalen och anropa den angivna metoden.
onMessage(IJsonRpcMessage)

Hantera ett mottaget meddelande på den här kanalen. Skicka till lämpligt objekt som hittas via objektregistret
owns(Window, string, IJsonRpcMessage)

Konstruktorinformation

XDMChannel(Window, string) 

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

Parametrar

postToWindow

Window

targetOrigin

string

Metodinformation

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parametrar

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Hämta objektregistret för att hantera meddelanden från den här specifika kanalen. När du får ett meddelande används det här kanalregistret först och sedan används det globala registret om ingen hanterare hittas här.

function getObjectRegistry(): IXDMObjectRegistry

Returer

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Hämta ett proxierat objekt som representerar objektet som registrerats med det angivna instans-ID:t på fjärrsidan av den här kanalen.

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

Parametrar

instanceId

string

unikt ID för det registrerade objektet

contextData

Object

Valfria kontextdata som ska skickas till ett registrerat objekts fabriksmetod

Returer

Promise<T>

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

Anropa en metod via RPC. Leta upp det registrerade objektet på fjärrslutet av kanalen och anropa den angivna metoden.

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

Parametrar

methodName

string

instanceId

string

unikt ID för det registrerade objektet

params

any[]

Argument till metoden som ska anropas

instanceContextData

Object

Valfria kontextdata som ska skickas till ett registrerat objekts fabriksmetod

serializationSettings
ISerializationSettings

Valfria serialiseringsinställningar

Returer

Promise<T>

onMessage(IJsonRpcMessage)

Hantera ett mottaget meddelande på den här kanalen. Skicka till lämpligt objekt som hittas via objektregistret

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parametrar

rpcMessage
IJsonRpcMessage

Meddelandedata

Returer

boolean

Sant om meddelandet hanterades av den här kanalen. Annars falskt.

owns(Window, string, IJsonRpcMessage) 

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

Parametrar

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Returer

boolean