azure-devops-extension-sdk package
クラス
XDMChannel |
複数の funtion\method 呼び出し間でフレーム\ドキュメントが "アクティブ" のままの間の通信チャネルを表します |
XDMObjectRegistry |
XDM 用に公開されているオブジェクトのカタログ |
インターフェイス
ContextIdentifier | |
GlobalizationContext | |
IExtensionContext |
現在の拡張機能の識別子 |
IExtensionInitOptions |
拡張機能の初期化のオプション -- DevOps.init() に渡されます |
IHostContext |
現在の DevOps ホストに関する情報 (organization) |
IPageContext |
各 Web ページに配置されたグローバル コンテキスト |
ITeamContext |
現在の DevOps チームに関する情報 |
IUserContext |
現在のユーザーに関する情報 |
IJsonRpcMessage |
フレーム間のリモート プロシージャ コール (rpc) を表します。 |
ISerializationSettings |
iframe 境界を越えたデータのシリアル化に関連する設定。 |
IXDMChannel |
1 つの XDM チャネルのインターフェイス |
IXDMChannelManager |
ターゲット フレーム/ウィンドウごとに保持される XDM チャネルのレジストリ |
IXDMObjectRegistry |
XDM チャネルによって呼び出すことができる XDM オブジェクトのレジストリ |
列挙型
HostType |
DevOps ホスト レベル |
機能
apply |
テーマ変数を現在のドキュメントに適用します |
get |
他の DevOps サービスへの呼び出しを許可するアクセス トークンをフェッチする |
get |
現在のユーザーを識別するために使用できるトークンをフェッチする |
get |
親フレームから初期ハンドシェイクで渡された構成データを取得する |
get |
この拡張機能が読み込まれる原因となったコントリビューションに関する情報を取得します。 |
get |
ホストされているコンテンツを所有する拡張機能に関するコンテキストを取得する |
get |
ページが対象とするホスト (Azure DevOps organization) に関する情報を取得します |
get |
ホスト ページに関するコンテキストを取得する |
get |
指定されたコントリビューション ID を使用してコントリビューションを取得します。返されるコントリビューションには、そのコントリビューション内の登録済みオブジェクトを取得するメソッドがあります。 |
get |
ページがターゲットとしているチームに関する情報を取得します |
get |
現在のユーザーに関する情報を取得します |
get |
Web に関するコンテキストを取得する |
init(IExtension |
ホスト ウィンドウでハンドシェイクを開始します。 |
notify |
拡張機能の読み込みに失敗したことをホストに通知します |
notify |
拡張機能が正常に読み込まれたことをホストに通知します (読み込みインジケーターの表示を停止します) |
ready() | 初期セットアップ/ハンドシェイクが完了したら呼び出されるコールバックを登録します。 初期セットアップが既に完了している場合は、現在の呼び出し履歴の最後にコールバックが呼び出されます。 |
register<T>(string, T) | この拡張機能がホスト フレームに公開するオブジェクト (インスタンスまたはファクトリ メソッド) を登録します。 |
resize(number, number) | 現在の拡張機能のサイズに基づいて、この拡張機能のコンテナーのサイズを変更するように親ウィンドウに要求します。 |
unregister(string) | この拡張機能がホスト フレームに公開されているオブジェクトを削除します。 |
関数の詳細
applyTheme({[varName: string]: string})
テーマ変数を現在のドキュメントに適用します
function applyTheme(themeData: {[varName: string]: string})
パラメーター
- themeData
-
{[varName: string]: string}
getAccessToken()
他の DevOps サービスへの呼び出しを許可するアクセス トークンをフェッチする
function getAccessToken(): Promise<string>
戻り値
Promise<string>
getAppToken()
現在のユーザーを識別するために使用できるトークンをフェッチする
function getAppToken(): Promise<string>
戻り値
Promise<string>
getConfiguration()
親フレームから初期ハンドシェイクで渡された構成データを取得する
function getConfiguration(): {[key: string]: any}
戻り値
{[key: string]: any}
getContributionId()
この拡張機能が読み込まれる原因となったコントリビューションに関する情報を取得します。
function getContributionId(): string
戻り値
string
getExtensionContext()
ホストされているコンテンツを所有する拡張機能に関するコンテキストを取得する
function getExtensionContext(): IExtensionContext
戻り値
getHost()
ページが対象とするホスト (Azure DevOps organization) に関する情報を取得します
function getHost(): IHostContext
戻り値
getPageContext()
getService<T>(string)
指定されたコントリビューション ID を使用してコントリビューションを取得します。返されるコントリビューションには、そのコントリビューション内の登録済みオブジェクトを取得するメソッドがあります。
function getService<T>(contributionId: string): Promise<T>
パラメーター
- contributionId
-
string
取得するコントリビューションの ID
戻り値
Promise<T>
getTeamContext()
getUser()
getWebContext()
Web に関するコンテキストを取得する
function getWebContext(): IWebContext
戻り値
IWebContext
init(IExtensionInitOptions)
ホスト ウィンドウでハンドシェイクを開始します。
function init(options?: IExtensionInitOptions): Promise<void>
パラメーター
- options
- IExtensionInitOptions
拡張機能の初期化オプション。
戻り値
Promise<void>
notifyLoadFailed(string | Error)
拡張機能の読み込みに失敗したことをホストに通知します
function notifyLoadFailed(e: string | Error): Promise<void>
パラメーター
- e
-
string | Error
戻り値
Promise<void>
notifyLoadSucceeded()
拡張機能が正常に読み込まれたことをホストに通知します (読み込みインジケーターの表示を停止します)
function notifyLoadSucceeded(): Promise<void>
戻り値
Promise<void>
ready()
初期セットアップ/ハンドシェイクが完了したら呼び出されるコールバックを登録します。 初期セットアップが既に完了している場合は、現在の呼び出し履歴の最後にコールバックが呼び出されます。
function ready(): Promise<void>
戻り値
Promise<void>
register<T>(string, T)
この拡張機能がホスト フレームに公開するオブジェクト (インスタンスまたはファクトリ メソッド) を登録します。
function register<T>(instanceId: string, instance: T)
パラメーター
- instanceId
-
string
登録済みオブジェクトの一意の ID
- instance
-
T
次のいずれか: (1) オブジェクト インスタンス、または (2) 省略可能なコンテキスト データを受け取り、オブジェクト インスタンスを返す関数。
resize(number, number)
現在の拡張機能のサイズに基づいて、この拡張機能のコンテナーのサイズを変更するように親ウィンドウに要求します。
function resize(width?: number, height?: number)
パラメーター
- width
-
number
省略可能な幅(既定値は scrollWidth)
- height
-
number
省略可能な高さ(既定値は scrollHeight)
unregister(string)
この拡張機能がホスト フレームに公開されているオブジェクトを削除します。
function unregister(instanceId: string)
パラメーター
- instanceId
-
string
登録済みオブジェクトの一意の ID