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

資源區域的識別碼

傳回

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

路由貢獻的識別碼

routeValues

{[key: string]: string}

路由值取代

hostPath

string

要使用的選擇性主機路徑，而不是頁面的預設主機路徑。

傳回

Promise<string>