ILocationService interface

套件:

azure-devops-extension-api

外部內容獲取位置的服務

方法

getResourceAreaLocation(string)	取得指定 REST 資源區域的 URL
getServiceLocation(string, TeamFoundationHostType)	取得遠端服務在指定主機類型的位置。
routeUrl(string, {[key: string]: string}, string)	嘗試為指定的路由範本和參數建立 URL。 url 將包含主機路徑。 例如，如果頁面網址為， https://dev.azure.com/foo 而您嘗試為專案「bar」建立管理員設定網址，則輸出將是 /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 將包含主機路徑。 例如，如果頁面網址為， https://dev.azure.com/foo 而您嘗試為專案「bar」建立管理員設定網址，則輸出將是 /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>