XDMChannel class

Pakiet:

azure-devops-extension-sdk

Reprezentuje kanał komunikacji między ramkami\dokumentem pozostaje "żywy" w wielu wywołaniach funtion\method

Konstruktory

XDMChannel(Window, string)

Metody

error(IJsonRpcMessage, Error)
getObjectRegistry()	Pobierz rejestr obiektów do obsługi komunikatów z tego określonego kanału. Po otrzymaniu komunikatu ten rejestr kanałów będzie używany najpierw, a następnie rejestr globalny będzie używany, jeśli w tym miejscu nie zostanie znaleziona żadna procedura obsługi.
getRemoteObjectProxy<T>(string, Object)	Pobierz obiekt proxied reprezentujący obiekt zarejestrowany przy użyciu danego identyfikatora wystąpienia po zdalnej stronie tego kanału.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)	Wywołaj metodę za pośrednictwem procedury RPC. Wyszukaj zarejestrowany obiekt na zdalnym końcu kanału i wywołaj określoną metodę.
onMessage(IJsonRpcMessage)	Obsługa odebranego komunikatu w tym kanale. Wysyłanie do odpowiedniego obiektu znalezionego za pośrednictwem rejestru obiektów
owns(Window, string, IJsonRpcMessage)

Szczegóły konstruktora

XDMChannel(Window, string)

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

Parametry

postToWindow

Window

targetOrigin

string

Szczegóły metody

error(IJsonRpcMessage, Error)

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parametry

messageObj

IJsonRpcMessage

errorObj

Error

getObjectRegistry()

Pobierz rejestr obiektów do obsługi komunikatów z tego określonego kanału. Po otrzymaniu komunikatu ten rejestr kanałów będzie używany najpierw, a następnie rejestr globalny będzie używany, jeśli w tym miejscu nie zostanie znaleziona żadna procedura obsługi.

function getObjectRegistry(): IXDMObjectRegistry

Zwraca

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Pobierz obiekt proxied reprezentujący obiekt zarejestrowany przy użyciu danego identyfikatora wystąpienia po zdalnej stronie tego kanału.

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

Parametry

instanceId

string

unikatowy identyfikator zarejestrowanego obiektu

contextData

Object

Opcjonalne dane kontekstu do przekazania do metody fabryki zarejestrowanego obiektu

Zwraca

Promise<T>

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

Wywołaj metodę za pośrednictwem procedury RPC. Wyszukaj zarejestrowany obiekt na zdalnym końcu kanału i wywołaj określoną metodę.

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

Parametry

methodName

string

instanceId

string

unikatowy identyfikator zarejestrowanego obiektu

params

any[]

Argumenty metody do wywołania

instanceContextData

Object

Opcjonalne dane kontekstu do przekazania do metody fabryki zarejestrowanego obiektu

serializationSettings

ISerializationSettings

Opcjonalne ustawienia serializacji

Zwraca

Promise<T>

onMessage(IJsonRpcMessage)

Obsługa odebranego komunikatu w tym kanale. Wysyłanie do odpowiedniego obiektu znalezionego za pośrednictwem rejestru obiektów

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parametry

rpcMessage

IJsonRpcMessage

Dane wiadomości

Zwraca

boolean

Prawda, jeśli komunikat został obsłużony przez ten kanał. W przeciwnym razie wartość false.

owns(Window, string, IJsonRpcMessage)

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

Parametry

source

Window

origin

string

rpcMessage

IJsonRpcMessage

Zwraca

boolean