IHostNavigationService interface
用于与主机窗口导航(URL、新窗口等)交互的服务
方法
| get |
获取当前哈希值。 |
| get |
获取在当前页面上选择的一组导航元素(如中心和中心组)。 |
| get |
获取有关与当前页面匹配的路由的信息 |
| get |
获取主机页面 URL 中的当前查询参数集。 |
| navigate(string) | 将父页面导航到指定的网址 |
| on |
添加每次哈希导航更改时调用的回调 |
| open |
打开指定 url 的新窗口 |
| reload() | 重新加载父框架 |
| replace |
将现有哈希替换为托管内容中提供的哈希。 |
| set |
更新主机文档的标题(显示为浏览器选项卡标题)。 |
| set |
设置托管内容提供的哈希值。 |
| set |
在主机页面上设置一个或多个查询参数 |
方法详细信息
getHash()
获取当前哈希值。
function getHash(): Promise<string>
返回
Promise<string>
getPageNavigationElements()
获取在当前页面上选择的一组导航元素(如中心和中心组)。
function getPageNavigationElements(): Promise<INavigationElement[]>
返回
Promise<INavigationElement[]>
getPageRoute()
getQueryParams()
获取主机页面 URL 中的当前查询参数集。
function getQueryParams(): Promise<{[key: string]: string}>
返回
Promise<{[key: string]: string}>
navigate(string)
将父页面导航到指定的网址
function navigate(url: string)
参数
- url
-
string
要导航到的 URL
onHashChanged((hash: string) => void)
添加每次哈希导航更改时调用的回调
function onHashChanged(callback: (hash: string) => void)
参数
- callback
-
(hash: string) => void
每次导航哈希更改时调用的方法
openNewWindow(string, string)
打开指定 url 的新窗口
function openNewWindow(url: string, features: string)
参数
- url
-
string
新窗口的网址
- features
-
string
以逗号分隔的功能/规格列表作为第 3 个参数发送到 window.open。 例如:“高度=400,宽度=400”。
reload()
重新加载父框架
function reload()
replaceHash(string)
将现有哈希替换为托管内容中提供的哈希。
function replaceHash(hash: string)
参数
- hash
-
string
setDocumentTitle(string)
更新主机文档的标题(显示为浏览器选项卡标题)。
function setDocumentTitle(title: string)
参数
- title
-
string
窗口的新标题
setHash(string)
设置托管内容提供的哈希值。
function setHash(hash: string)
参数
- hash
-
string
setQueryParams({[key: string]: string})
在主机页面上设置一个或多个查询参数
function setQueryParams(parameters: {[key: string]: string})
参数
- parameters
-
{[key: string]: string}
要添加、更新或删除的查询字符串参数的字典(传递要删除的空值)