导航历史

类：NavigationHistory¶

管理导航条目列表，表示用户在应用内的浏览历史。

进程：Main
该类未从 'electron' 模块导出。它只能作为 Electron API 中其他方法的返回值使用。

每个 NavigationEntry 对应一个特定已访问页面。 索引系统按顺序排列，最早访问页面的条目位于索引 0，最近访问页面的条目位于索引 N。

此类中的某些 API 还接受 offset，它是一个整数，表示根据上述索引系统，某个索引相对于当前条目的相对位置（即 offset 值为 1 表示在历史中向前前进一个页面）。

维护这个有序的导航条目列表，可让用户在浏览历史中无缝地向前和向后导航。

实例方法¶

navigationHistory.canGoBack()¶

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

navigationHistory.canGoForward()¶

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

navigationHistory.canGoToOffset(offset)¶

• offset Integer

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

navigationHistory.clear()¶

清除导航历史。

navigationHistory.getActiveIndex()¶

返回 Integer - 当前页面的索引，可从此处返回/前进或重新加载。

navigationHistory.getEntryAtIndex(index)¶

• index Integer

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

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

navigationHistory.goBack()¶

使浏览器返回一个网页。

navigationHistory.goForward()¶

使浏览器前进一个网页。

navigationHistory.goToIndex(index)¶

• index Integer

导航到指定的绝对网页索引。

navigationHistory.goToOffset(offset)¶

• offset Integer

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

navigationHistory.length()¶

返回 Integer - 历史长度。

navigationHistory.removeEntryAtIndex(index)¶

• index Integer

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

返回 boolean - 导航条目是否已从 webContents 历史中移除。

navigationHistory.getAllEntries()¶

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

navigationHistory.restore(options)¶

恢复导航历史，并加载栈中给定的条目。将尽力恢复不仅导航栈，而且各个页面的状态——例如包括 HTML 表单值或滚动位置。建议在创建任何导航条目之前调用此 API，理想情况下是在对 webContents 对象调用 loadURL() 或 loadFile() 之前。

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

• options Object
• entries NavigationEntry[] - 先前 getAllEntries() 调用的结果
• index Integer（可选） - 应加载的栈索引。如果将其设置为 0，webContents 将加载第一个（最旧的）条目。如果将其保留为 undefined，Electron 将自动加载最后一个（最新的）条目。

返回 Promise<void> - 当页面完成加载所选导航条目时，该 promise 将 resolve（参见 did-finish-load）；如果页面加载失败，则 reject（参见 did-fail-load）。已附加一个 noop 拒绝处理程序，以避免未处理的拒绝错误。