Partager via

IXDMChannel interface

  • Référence
Paquet:
azure-devops-extension-sdk

Interface pour un seul canal XDM

Méthodes

getObjectRegistry()

Obtenez le registre d’objets pour gérer les messages de ce canal spécifique. Lors de la réception d’un message, ce registre de canaux sera utilisé en premier, puis le registre global sera utilisé si aucun gestionnaire n’est trouvé ici.
getRemoteObjectProxy<T>(string, Object)

Obtenez un objet proxied qui représente l’objet inscrit avec l’ID de instance donné sur le côté distant de ce canal.
invokeRemoteMethod<T>(string, string, any[], Object)

Appelez une méthode via RPC. Recherchez l’objet inscrit à l’extrémité distante du canal et appelez la méthode spécifiée.

Détails de la méthode

getObjectRegistry()

Obtenez le registre d’objets pour gérer les messages de ce canal spécifique. Lors de la réception d’un message, ce registre de canaux sera utilisé en premier, puis le registre global sera utilisé si aucun gestionnaire n’est trouvé ici.

function getObjectRegistry(): IXDMObjectRegistry

Retours

IXDMObjectRegistry

getRemoteObjectProxy<T>(string, Object)

Obtenez un objet proxied qui représente l’objet inscrit avec l’ID de instance donné sur le côté distant de ce canal.

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

Paramètres

instanceId

string

ID unique de l’objet inscrit

contextData

Object

Données de contexte facultatives à passer à la méthode de fabrique d’un objet inscrit

Retours

Promise<T>

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

Appelez une méthode via RPC. Recherchez l’objet inscrit à l’extrémité distante du canal et appelez la méthode spécifiée.

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

Paramètres

methodName

string

instanceId

string

ID unique de l’objet inscrit

params

any[]

Arguments de la méthode à appeler

instanceContextData

Object

Données de contexte facultatives à passer à la méthode de fabrique d’un objet inscrit

Retours

Promise<T>