azure-devops-extension-sdk package

現在のドキュメントにテーマ変数を適用します

function applyTheme(themeData: {[varName: string]: string})

パラメーター

ネストされたアプリ認証ブリッジを無効にします。 この呼び出しの後、MSALトークン要求はすべての BridgeDisabled エラーを受け取ります。 ブリッジオブジェクトは window.nestedAppAuthBridge に残るため、既存のMSALリスナーが孤児化しないようにします。 enableNestedAppAuth()に連絡して再有効化を依頼してください。

function disableNestedAppAuth()

この拡張機能でネストアプリ認証(NAA)を有効にしてください。

MSALのcreateNestablePublicClientApplicationがAzure DevOpsホストフレームにトークン取得を委任できるようにwindow.nestedAppAuthBridgeを設定します。 これにより、iframesでポップアップ認証をブロックするクロスオリジンのBroadcastChannel問題を回避できます。

これをMSALインスタンスを作成する前に init() した後と呼びます。 ホストがNAAサポートを有効にしている必要があります。

例

await SDK.init();
await SDK.enableNestedAppAuth();
const pca = await createNestablePublicClientApplication({
    auth: { clientId: "your-entra-client-id" }
});

function enableNestedAppAuth(): Promise<void>

返品

ブリッジが準備できたときに解決するか、ホストがNAAをサポートしない場合は拒否する約束です。

他の DevOps サービスへの呼び出しを許可するアクセス トークンをフェッチする

function getAccessToken(): Promise<string>

返品

現在のユーザーを識別するために使用できるトークンをフェッチする

function getAppToken(): Promise<string>

返品

親フレームから初期ハンドシェイクで渡された構成データを取得する

function getConfiguration(): {[key: string]: any}

返品

この拡張機能が読み込まれる原因となったコントリビューションに関する情報を取得します。

function getContributionId(): string

返品

ホストされているコンテンツを所有する拡張機能に関するコンテキストを取得する

function getExtensionContext(): IExtensionContext

返品

ページが対象としているホスト (つまり Azure DevOps 組織) に関する情報を取得します。

function getHost(): IHostContext

返品

ホスト ページに関するコンテキストを取得する

function getPageContext(): IPageContext

返品

指定されたコントリビューション ID を使用してコントリビューションを取得します。返されるコントリビューションには、そのコントリビューション内の登録済みオブジェクトを取得するメソッドがあります。

function getService<T>(contributionId: string): Promise<T>

パラメーター

返品

ページが対象としているチームに関する情報を取得します

function getTeamContext(): ITeamContext

返品

現在のユーザーに関する情報を取得します

function getUser(): IUserContext

返品

Web に関するコンテキストを取得する

function getWebContext(): IWebContext

返品

ホスト ウィンドウでハンドシェイクを開始します。

function init(options?: IExtensionInitOptions): Promise<void>

パラメーター

返品

拡張機能の読み込みに失敗したことをホストに通知します

function notifyLoadFailed(e: string | Error): Promise<void>

パラメーター

返品

拡張機能が正常に読み込まれたことをホストに通知します (読み込みインジケーターの表示を停止します)

function notifyLoadSucceeded(): Promise<void>

返品

初期セットアップ/ハンドシェイクが完了したら呼び出されるコールバックを登録します。 初期セットアップが既に完了している場合は、現在の呼び出し履歴の最後にコールバックが呼び出されます。

function ready(): Promise<void>

返品

この拡張機能がホスト フレームに公開するオブジェクト (インスタンスまたはファクトリ メソッド) を登録します。

function register<T>(instanceId: string, instance: T)

パラメーター

現在の拡張機能のサイズに基づいて、この拡張機能のコンテナーのサイズを変更するように親ウィンドウに要求します。

function resize(width?: number, height?: number)

パラメーター

この拡張機能がホスト フレームに公開されているオブジェクトを削除します。

function unregister(instanceId: string)

パラメーター

Web SDKのバージョン番号。 拡張の要求セットで指定できます。例えば:vss-sdk-version/4.2

sdkVersion: 5

型