類別:NavigationHistory
類別: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 允許您建立旨在還原、重新建立或複製其他 webContents 的常見流程。
返回 Promise<void>
- 當頁面完成載入選定的導航條目時,promise 將會解析(請參閱 did-finish-load
),如果頁面載入失敗,則會拒絕(請參閱 did-fail-load
)。已附加 noop 拒絕處理常式,以避免未處理的拒絕錯誤。