跳转到主要内容

类：NavigationHistory

Class: NavigationHistory​

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

进程：主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值可用。

每个 NavigationEntry 都对应一个特定访问过的页面。索引系统遵循顺序，最早访问页面的条目索引为 0，最近访问页面的条目索引为 N。

此类中的某些 API 还接受一个偏移量，该偏移量是一个整数，表示按照上述索引系统相对于当前条目的位置（例如，偏移量 1 将表示在历史记录中向前移动一页）。

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

实例方法​

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

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

  • offset Integer

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

清除导航历史记录。

返回 Integer - 当前页面的索引，用于回退/前进或重新加载。

  • index Integer

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

如果索引越界（大于历史记录长度或小于 0），则返回 null。

使浏览器回退一页。

使浏览器前进一页。

  • index Integer

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

  • offset Integer

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

返回 Integer - 历史记录长度。

  • index Integer

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

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

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

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

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

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

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