クラス: NavigationHistory

アプリケーション内のユーザーの閲覧履歴を表すナビゲーション項目のリストを管理します。

プロセス: メイン
_このクラスは 'electron' モジュールからはエクスポートされていません。 Electron API の他のメソッドの戻り値としてのみ利用できます。

各 NavigationEntry は、特定の訪問済みページに対応します。このインデックスはシーケンシャルな順序に従うシステムです。最初にアクセスしたページのエントリはインデックス 0 にあり、最後にアクセスしたページのエントリはインデックス N にあります。

このクラスの一部の API は、オフセット も受け付けます。これは上記のインデックスのシステムに従って、現在のエントリからのインデックスの相対位置を表す整数です (つまり、オフセット値の '1' は履歴内で 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 - 指定インデックスのナビゲーションエントリ。

index が範囲外の場合 (履歴の長さより大きいか 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 を使用すると、他のウェブコンテンツの復元、再作成、または複製を目的とした共通のフローを作成できます。

options Object
- entries NavigationEntry[] - 以前の getAllEntries() 呼び出しの戻り値
- index Integer (任意) - 読み込み必要があるスタックのインデックス。これを 0 に設定すると、webContents は最初の (最も古い) エントリをロードします。 undefined のままにすると、Electron は自動的に最後の (最新の) エントリをロードします。

戻り値 Promise<void> - ページが選択されたナビゲーションエントリの読み込みを完了すると Promise は解決され (did-finish-load を参照) ます。ページの読み込みに失敗した場合 (did-fail-load を参照) は拒否されます。無操作拒否ハンドラーが既にアタッチされているため、未処理の拒否エラーは回避されます。