Header menu logo fable-electron-docs-api

NavigationHistory Type

⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ❌ | Exported ❌

Instance members

Instance member Description

this.canGoBack ()

Full Usage: this.canGoBack ()

Returns: bool
Modifiers: inline

Whether the browser can go back to previous web page.

Returns: bool

this.canGoForward ()

Full Usage: this.canGoForward ()

Returns: bool
Modifiers: inline

Whether the browser can go forward to next web page.

Returns: bool

this.canGoToOffset offset

Full Usage: this.canGoToOffset offset

Parameters:
    offset : int

Returns: bool
Modifiers: inline

Whether the web page can go to the specified relative offset from the current entry.

offset : int
Returns: bool

this.clear ()

Full Usage: this.clear ()

Modifiers: inline

Clears the navigation history.

this.getActiveIndex ()

Full Usage: this.getActiveIndex ()

Returns: int
Modifiers: inline

The index of the current page, from which we would go back/forward or reload.

Returns: int

this.getAllEntries ()

Full Usage: this.getAllEntries ()

Returns: NavigationEntry[]
Modifiers: inline

WebContents complete history.

Returns: NavigationEntry[]

this.getEntryAtIndex index

Full Usage: this.getEntryAtIndex index

Parameters:
    index : int

Returns: NavigationEntry
Modifiers: inline

Navigation entry at the given index.If index is out of bounds (greater than history length or less than 0), null will be returned.

index : int
Returns: NavigationEntry

this.goBack ()

Full Usage: this.goBack ()

Modifiers: inline

Makes the browser go back a web page.

this.goForward ()

Full Usage: this.goForward ()

Modifiers: inline

Makes the browser go forward a web page.

this.goToIndex index

Full Usage: this.goToIndex index

Parameters:
    index : int

Modifiers: inline

Navigates browser to the specified absolute web page index.

index : int

this.goToOffset offset

Full Usage: this.goToOffset offset

Parameters:
    offset : int

Modifiers: inline

Navigates to the specified relative offset from the current entry.

offset : int

this.length ()

Full Usage: this.length ()

Returns: int
Modifiers: inline

History length.

Returns: int

this.removeEntryAtIndex index

Full Usage: this.removeEntryAtIndex index

Parameters:
    index : int

Returns: bool
Modifiers: inline

Removes the navigation entry at the given index. Can't remove entry at the "current active index".Whether the navigation entry was removed from the webContents history.

index : int
Returns: bool

this.restore (entries, ?index)

Full Usage: this.restore (entries, ?index)

Parameters:
Returns: Promise<unit>
Modifiers: inline

the promise will resolve when the page has finished loading the selected navigation entry (see did-finish-load), and rejects if the page fails to load (see did-fail-load). A noop rejection handler is already attached, which avoids unhandled rejection errors.

entries : NavigationEntry[]
?index : int
Returns: Promise<unit>

Type something to start searching.