ILocationService interface

パッケージ:

azure-devops-extension-api

場所を取得するための外部コンテンツのサービス

メソッド

getResourceAreaLocation(string)	指定された REST リソース領域の URL を取得します
getServiceLocation(string, TeamFoundationHostType)	指定したホストの種類でのリモート サービスの場所を取得します。
routeUrl(string, {[key: string]: string}, string)	指定したルート テンプレートとパラメーターの URL を作成します。 URL にはホスト パスが含まれます。 たとえば、ページ URL が で https://dev.azure.com/foo 、プロジェクト "bar" の管理者設定 URL を作成しようとすると、出力は /foo/bar/_admin になります。 これにより、ページ データに含まれていないルートコントリビューションが非同期的にフェッチされます。

メソッドの詳細

getResourceAreaLocation(string)

指定された REST リソース領域の URL を取得します

function getResourceAreaLocation(resourceAreaId: string): Promise<string>

パラメーター

resourceAreaId

string

リソース領域の ID

戻り値

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

指定したホストの種類でのリモート サービスの場所を取得します。

function getServiceLocation(serviceInstanceType?: string, hostType?: TeamFoundationHostType): Promise<string>

パラメーター

serviceInstanceType

string

参照するサービス インスタンスの種類の GUID

hostType

TeamFoundationHostType

参照するホストの種類 (既定では、現在のページ データのホストの種類)

戻り値

Promise<string>

routeUrl(string, {[key: string]: string}, string)

指定したルート テンプレートとパラメーターの URL を作成します。 URL にはホスト パスが含まれます。 たとえば、ページ URL が で https://dev.azure.com/foo 、プロジェクト "bar" の管理者設定 URL を作成しようとすると、出力は /foo/bar/_admin になります。

これにより、ページ データに含まれていないルートコントリビューションが非同期的にフェッチされます。

function routeUrl(routeId: string, routeValues?: {[key: string]: string}, hostPath?: string): Promise<string>

パラメーター

routeId

string

ルートコントリビューションの ID

routeValues

{[key: string]: string}

ルート値の置換

hostPath

string

ページの既定のホスト パスではなく、使用するオプションのホスト パス。

戻り値

Promise<string>