kotlin-browser/web.navigation/NavigationHistoryEntry

NavigationHistoryEntry

class NavigationHistoryEntry : EventTarget(source)

The NavigationHistoryEntry interface of the Navigation API represents a single navigation history entry.

MDN Reference

Properties

disposeEvent

val disposeEvent: EventInstance<Event, NavigationHistoryEntry, NavigationHistoryEntry>

MDN Reference

val id: String

The id read-only property of the NavigationHistoryEntry interface returns the id of the history entry, or an empty string if current document is not fully active.

index

val index: Int53

The index read-only property of the NavigationHistoryEntry interface returns the index of the history entry in the history entries list (that is, the list returned by Navigation.entries()), or -1 if the entry does not appear in the list or if current document is not fully active.

key

val key: String

The key read-only property of the NavigationHistoryEntry interface returns the key of the history entry, or an empty string if current document is not fully active.

ondispose

var ondispose: EventHandler<Event, NavigationHistoryEntry, NavigationHistoryEntry>?

MDN Reference

sameDocument

val sameDocument: Boolean

The sameDocument read-only property of the NavigationHistoryEntry interface returns true if this history entry is for the same document as the current Document value and current document is fully active, or false otherwise.

url

val url: String?

The url read-only property of the NavigationHistoryEntry interface returns the absolute URL of this history entry.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getState

fun getState(): JsAny

The getState() method of the NavigationHistoryEntry interface returns a clone of the developer-supplied state associated with this history entry.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>