类: NavigationHistory

管理导航条目的列表，表示应用程序中用户的浏览历史记录。

进程: 主进程
此类不是从 'electron' 模块导出的。它仅作为 Electron API 中其他方法的返回值提供。

每个 NavigationEntry 对应于一个特定的访问页面。索引系统遵循顺序，最早访问页面的条目位于索引 0，而最新访问页面的条目位于索引 N。

此类别中的某些 API 也接受偏移量，它是一个整数，表示根据上述索引系统，从当前条目开始的索引的相对位置（即，偏移量值为 1 表示在历史记录中向前移动一页）。

维护此排序的导航条目列表可以实现通过用户浏览历史记录无缝地向后和向前导航。

实例方法

`navigationHistory.canGoBack()`

返回 boolean - 浏览器是否可以返回到上一个网页。

`navigationHistory.canGoForward()`

返回 boolean - 浏览器是否可以前进到下一个网页。

`navigationHistory.canGoToOffset(offset)`

offset 整数

返回 boolean - 网页是否可以转到距当前条目的指定相对 offset。

`navigationHistory.clear()`

清除导航历史记录。

`navigationHistory.getActiveIndex()`

返回 Integer - 当前页面的索引，我们将从该索引返回/前进或重新加载。

`navigationHistory.getEntryAtIndex(index)`

index 整数

返回 NavigationEntry - 给定索引处的导航条目。

如果索引超出范围（大于历史记录长度或小于 0），则将返回 null。

`navigationHistory.goBack()`

使浏览器返回一个网页。

`navigationHistory.goForward()`

使浏览器前进一个网页。

`navigationHistory.goToIndex(index)`

index 整数

将浏览器导航到指定的绝对网页索引。

`navigationHistory.goToOffset(offset)`

offset 整数

导航到距当前条目的指定相对偏移量。

`navigationHistory.length()`

返回 Integer - 历史记录长度。

`navigationHistory.removeEntryAtIndex(index)`

index 整数

删除给定索引处的导航条目。无法删除“当前活动索引”处的条目。

返回 boolean - 是否从 webContents 历史记录中删除了导航条目。

`navigationHistory.getAllEntries()`

返回 NavigationEntry[] - WebContents 完整历史记录。

`navigationHistory.restore(options)`

恢复导航历史记录，并将给定的条目加载到堆栈中。将尽最大努力恢复不仅是导航堆栈，还有单个页面的状态 - 例如包括 HTML 表单值或滚动位置。建议在创建任何导航条目之前调用此 API，因此最好在对 webContents 对象调用 loadURL() 或 loadFile() 之前调用此 API。

此 API 允许您创建旨在恢复、重新创建或克隆其他 webContents 的常见流程。

options 对象
- entries NavigationEntry[] - 之前 getAllEntries() 调用的结果
- index Integer (可选) - 应加载的堆栈的索引。如果将其设置为 0，则 webContents 将加载第一个（最旧的）条目。如果您将其保留为未定义，则 Electron 将自动加载最后一个（最新的）条目。

返回 Promise<void> - 当页面完成加载所选导航条目时，该 promise 将解析（请参阅 did-finish-load），如果页面无法加载，则拒绝（请参阅 did-fail-load）。已经附加了一个 noop 拒绝处理程序，这可以避免未处理的拒绝错误。