Поделиться через

XDMChannel class

  • Ссылка
Пакет:
azure-devops-extension-sdk

Представляет канал обмена данными между кадрами\document Stays "в активном режиме" в нескольких вызовах funtion\method

Конструкторы

XDMChannel(Window, string)

Методы

error(IJsonRpcMessage, Error)
getObjectRegistry()

Получите реестр объектов для обработки сообщений из этого канала. После получения сообщения сначала будет использоваться этот реестр каналов, а затем глобальный реестр будет использоваться, если обработчик здесь не найден.
getRemoteObjectProxy<T>(string, Object)

Получите прокси-объект, представляющий объект, зарегистрированный с заданным идентификатором экземпляра на удаленной стороне этого канала.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Вызов метода с помощью RPC. Найдите зарегистрированный объект в удаленном конце канала и вызовите указанный метод.
onMessage(IJsonRpcMessage)

Обработка полученного сообщения в этом канале. Отправка в соответствующий объект, найденный с помощью реестра объектов
owns(Window, string, IJsonRpcMessage)

Сведения о конструкторе

XDMChannel(Window, string) 

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

Параметры

postToWindow

Window

targetOrigin

string

Сведения о методе

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Параметры

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Получите реестр объектов для обработки сообщений из этого канала. После получения сообщения сначала будет использоваться этот реестр каналов, а затем глобальный реестр будет использоваться, если обработчик здесь не найден.

function getObjectRegistry(): IXDMObjectRegistry

Возвращаемое значение

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Получите прокси-объект, представляющий объект, зарегистрированный с заданным идентификатором экземпляра на удаленной стороне этого канала.

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

Параметры

instanceId

string

уникальный идентификатор зарегистрированного объекта

contextData

Object

Необязательные данные контекста для передачи в метод фабрики зарегистрированного объекта

Возвращаемое значение

Promise<T>

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

Вызов метода с помощью RPC. Найдите зарегистрированный объект в удаленном конце канала и вызовите указанный метод.

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

Параметры

methodName

string

instanceId

string

уникальный идентификатор зарегистрированного объекта

params

any[]

Аргументы вызываемого метода

instanceContextData

Object

Необязательные данные контекста для передачи в метод фабрики зарегистрированного объекта

serializationSettings
ISerializationSettings

Необязательные параметры сериализации

Возвращаемое значение

Promise<T>

onMessage(IJsonRpcMessage)

Обработка полученного сообщения в этом канале. Отправка в соответствующий объект, найденный с помощью реестра объектов

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Параметры

rpcMessage
IJsonRpcMessage

Данные сообщения

Возвращаемое значение

boolean

Значение true, если сообщение было обработано этим каналом. В противном случае — false.

owns(Window, string, IJsonRpcMessage) 

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

Параметры

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Возвращаемое значение

boolean