跳转到主要内容

类:NavigationHistory

类: 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 将拒绝。已经附加了一个无操作的拒绝处理程序,以避免未处理的拒绝错误。