다음을 통해 공유

XDMChannel class

  • 참조
패키지:
azure-devops-extension-sdk

여러 funtion\method 호출에서 프레임\문서 유지 "활성" 간 통신 채널을 나타냅니다.

생성자

XDMChannel(Window, string)

메서드

error(IJsonRpcMessage, Error)
getObjectRegistry()

이 특정 채널의 메시지를 처리할 개체 레지스트리를 가져옵니다. 메시지를 받으면 이 채널 레지스트리가 먼저 사용되고 여기에 처리기가 없으면 전역 레지스트리가 사용됩니다.
getRemoteObjectProxy<T>(string, Object)

이 채널의 원격 쪽에서 지정된 instance ID에 등록된 개체를 나타내는 프록시된 개체를 가져옵니다.
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)

이 채널의 원격 쪽에서 지정된 instance ID에 등록된 개체를 나타내는 프록시된 개체를 가져옵니다.

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

매개 변수

instanceId

string

등록된 개체의 고유 ID

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

등록된 개체의 고유 ID

params

any[]

호출할 메서드에 대한 인수

instanceContextData

Object

등록된 개체의 팩터리 메서드에 전달할 선택적 컨텍스트 데이터

serializationSettings
ISerializationSettings

선택적 serialization 설정

반환

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