Condividi tramite

XDMChannel class

  • Riferimento
Pacchetto:
azure-devops-extension-sdk

Rappresenta un canale di comunicazione tra frame\documento rimane "attivo" tra più chiamate di funtion\method

Costruttori

XDMChannel(Window, string)

Metodi

error(IJsonRpcMessage, Error)
getObjectRegistry()

Ottenere il Registro oggetti per gestire i messaggi da questo canale specifico. Al momento della ricezione di un messaggio, questo registro dei canali verrà usato per primo, quindi verrà usato il Registro di sistema globale se non viene trovato alcun gestore qui.
getRemoteObjectProxy<T>(string, Object)

Ottiene un oggetto proxy che rappresenta l'oggetto registrato con l'ID istanza specificato sul lato remoto di questo canale.
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)

Richiamare un metodo tramite RPC. Cercare l'oggetto registrato sulla fine remota del canale e richiamare il metodo specificato.
onMessage(IJsonRpcMessage)

Gestire un messaggio ricevuto in questo canale. Invio all'oggetto appropriato trovato tramite il Registro oggetti
owns(Window, string, IJsonRpcMessage)

Dettagli costruttore

XDMChannel(Window, string) 

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

Parametri

postToWindow

Window

targetOrigin

string

Dettagli metodo

error(IJsonRpcMessage, Error) 

function error(messageObj: IJsonRpcMessage, errorObj: Error)

Parametri

messageObj
IJsonRpcMessage
errorObj

Error

getObjectRegistry()

Ottenere il Registro oggetti per gestire i messaggi da questo canale specifico. Al momento della ricezione di un messaggio, questo registro dei canali verrà usato per primo, quindi verrà usato il Registro di sistema globale se non viene trovato alcun gestore qui.

function getObjectRegistry(): IXDMObjectRegistry

Restituisce

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Ottiene un oggetto proxy che rappresenta l'oggetto registrato con l'ID istanza specificato sul lato remoto di questo canale.

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

Parametri

instanceId

string

ID univoco dell'oggetto registrato

contextData

Object

Dati di contesto facoltativi da passare al metodo factory di un oggetto registrato

Restituisce

Promise<T>

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

Richiamare un metodo tramite RPC. Cercare l'oggetto registrato sulla fine remota del canale e richiamare il metodo specificato.

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

Parametri

methodName

string

instanceId

string

ID univoco dell'oggetto registrato

params

any[]

Argomenti per il metodo da richiamare

instanceContextData

Object

Dati di contesto facoltativi da passare al metodo factory di un oggetto registrato

serializationSettings
ISerializationSettings

Impostazioni di serializzazione facoltative

Restituisce

Promise<T>

onMessage(IJsonRpcMessage)

Gestire un messaggio ricevuto in questo canale. Invio all'oggetto appropriato trovato tramite il Registro oggetti

function onMessage(rpcMessage: IJsonRpcMessage): boolean

Parametri

rpcMessage
IJsonRpcMessage

Dati del messaggio

Restituisce

boolean

True se il messaggio è stato gestito da questo canale. In caso contrario, false.

owns(Window, string, IJsonRpcMessage) 

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

Parametri

source

Window

origin

string

rpcMessage
IJsonRpcMessage

Restituisce

boolean