IXDMObjectRegistry interface

パッケージ:

azure-devops-extension-sdk

XDM チャネルによって呼び出すことができる 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

オブジェクト ファクトリ メソッドの contructor に渡す省略可能なコンテキスト データ

戻り値

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