XDMObjectRegistry class

包:

azure-devops-extension-sdk

为 XDM 公开的对象目录

方法

getInstance<T>(string, Object)	获取使用给定 ID 注册的 对象的实例
register(string, Object | (contextData?: any) => Object)	(实例或工厂方法注册) 此帧向远程帧中的调用方公开的对象
unregister(string)	(实例或工厂方法) 取消注册以前由此帧注册的对象

方法详细信息

getInstance<T>(string, Object)

获取使用给定 ID 注册的 对象的实例

function getInstance<T>(instanceId: string, contextData?: Object): undefined | T

参数

instanceId

string

已注册对象的唯一 ID

contextData

Object

要传递到已注册对象的工厂方法的可选上下文数据

返回

undefined | T

register(string, Object | (contextData?: any) => Object)

(实例或工厂方法注册) 此帧向远程帧中的调用方公开的对象

function register(instanceId: string, instance: Object | (contextData?: any) => Object)

参数

instanceId

string

已注册对象的唯一 ID

instance

Object | (contextData?: any) => Object

要么： (1) 对象实例，或 (2) 采用可选上下文数据并返回对象实例的函数。

unregister(string)

(实例或工厂方法) 取消注册以前由此帧注册的对象

function unregister(instanceId: string)

参数

instanceId

string

已注册对象的唯一 ID