ILocationService interface

用于获取位置的外部内容的服务

方法

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>