类:NavigationHistory
类:NavigationHistory
管理导航条目列表,代表用户在应用程序内的浏览历史。
进程:主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值可用。
每个 NavigationEntry 都对应一个特定的访问过的页面。索引系统遵循顺序,最早访问页面的条目索引为 0,最近访问页面的条目索引为 N。
此类中的某些 API 也接受一个偏移量,这是一个整数,表示相对于当前条目在上述索引系统中的位置(即,偏移量 1 表示在历史记录中前进一页)。
维护这个有序的导航条目列表,使得用户能够无缝地在浏览历史中向后和向前导航。
实例方法
navigationHistory.canGoBack()
返回 boolean - 浏览器是否可以回退到前一个网页。
navigationHistory.canGoForward()
返回 boolean - 浏览器是否可以前进到下一个网页。
navigationHistory.canGoToOffset(offset)
offsetInteger
返回 boolean - 网页是否可以从当前条目跳转到指定的相对 offset。
navigationHistory.clear()
清除导航历史记录。
navigationHistory.getActiveIndex()
返回 Integer - 当前页面的索引,从此索引可以回退/前进或重新加载。
navigationHistory.getEntryAtIndex(index)
indexInteger
返回 NavigationEntry - 指定索引处的导航条目。
如果索引超出范围(大于历史长度或小于 0),则返回 null。
navigationHistory.goBack()
使浏览器回退一页。
navigationHistory.goForward()
使浏览器前进一页。
navigationHistory.goToIndex(index)
indexInteger
将浏览器导航到指定的绝对网页索引。
navigationHistory.goToOffset(offset)
offsetInteger
导航到当前条目指定的相对偏移量。
navigationHistory.length()
返回 Integer - 历史长度。
navigationHistory.removeEntryAtIndex(index)
indexInteger
删除指定索引处的导航条目。无法删除“当前活动索引”处的条目。
返回 boolean - 该导航条目是否已从 webContents 历史记录中删除。
navigationHistory.getAllEntries()
返回 NavigationEntry[] - WebContents 的完整历史记录。
navigationHistory.restore(options)
恢复导航历史并加载堆栈中的给定条目。将尽最大努力恢复导航堆栈以及各个页面的状态 - 例如,包括 HTML 表单值或滚动位置。建议在创建任何导航条目之前调用此 API,最好是在 webContents 对象上调用 loadURL() 或 loadFile() 之前。
此 API 允许您创建旨在恢复、重新创建或克隆其他 webContents 的常见流程。
返回 Promise<void> - promise 将在页面完成加载所选导航条目时解析(请参阅 did-finish-load),并在页面加载失败时拒绝(请参阅 did-fail-load)。已附加一个 noop 拒绝处理程序,以避免未处理的拒绝错误。