kotlin-browser/web.navigator/Navigator

Navigator

sealed class Navigator : NavigatorAutomationInformation, NavigatorBadge, NavigatorConcurrentHardware, NavigatorContentUtils, NavigatorCookies, NavigatorID, NavigatorLanguage, NavigatorLocks, NavigatorOnLine, NavigatorPlugins, NavigatorStorage(source)

The Navigator interface represents the state and the identity of the user agent.

MDN Reference

Properties

clipboard

val clipboard: Clipboard

The clipboard read-only property of the Navigator interface returns a Clipboard object used to read and write the clipboard's contents. Available only in secure contexts.

cookieEnabled

abstract val cookieEnabled: Boolean

MDN Reference

credentials

val credentials: CredentialsContainer

The credentials read-only property of the Navigator interface returns the CredentialsContainer object associated with the current document, which exposes methods to request credentials. Available only in secure contexts.

doNotTrack

val doNotTrack: String?

geolocation

val geolocation: Geolocation

The Navigator.geolocation read-only property returns a device.

hardwareConcurrency

abstract val hardwareConcurrency: UInt53

MDN Reference

language

abstract val language: String

MDN Reference

languages

abstract val languages: ReadonlyArray<JsString>

MDN Reference

locks

abstract val locks: LockManager

MDN Reference

val login: NavigatorLogin

The login read-only property of the Navigator interface provides access to the browser's NavigatorLogin object, which a federated identity provider (IdP) can use to set its login status when a user signs into or out of the IdP. Available only in secure contexts.

maxTouchPoints

val maxTouchPoints: Int

The maxTouchPoints read-only property of the contact points that are supported by the current device.

mediaCapabilities

val mediaCapabilities: MediaCapabilities

The mediaCapabilities read-only property of the Navigator interface references a MediaCapabilities object that can expose information about the decoding and encoding capabilities for a given media format and output capabilities.

mediaDevices

val mediaDevices: MediaDevices

The mediaDevices read-only property of the Navigator interface returns a MediaDevices object, which provides access to connected media input devices like cameras and microphones, as well as screen sharing. Available only in secure contexts.

mediaSession

val mediaSession: MediaSession

The mediaSession read-only property of the Navigator interface returns a MediaSession object that can be used to share with the browser metadata and other information about the current playback state of media being handled by a document.

onLine

abstract val onLine: Boolean

MDN Reference

pdfViewerEnabled

abstract val pdfViewerEnabled: Boolean

MDN Reference

permissions

val permissions: Permissions

The permissions read-only property of the Navigator interface returns a status of APIs covered by the Permissions API.

serviceWorker

val serviceWorker: ServiceWorkerContainer

The serviceWorker read-only property of the Navigator interface returns the ServiceWorkerContainer object for the associated document, which provides access to registration, removal, upgrade, and communication with the ServiceWorker. Available only in secure contexts.

storage

abstract val storage: StorageManager

MDN Reference

userActivation

val userActivation: UserActivation

The read-only userActivation property of the Navigator interface returns a UserActivation object which contains information about the current window's user activation state.

userAgent

abstract val userAgent: String

MDN Reference

wakeLock

val wakeLock: WakeLock

The wakeLock read-only property of the Navigator interface returns a WakeLock interface that allows a document to acquire a screen wake lock.

webdriver

abstract val webdriver: Boolean

MDN Reference

Functions

canShare

fun canShare(data: ShareData = definedExternally): Boolean

The canShare() method of the Navigator interface returns true if the equivalent call to navigator.share() would succeed. Available only in secure contexts.

clearAppBadge

abstract suspend fun clearAppBadge()

MDN Reference

clearAppBadgeAsync

abstract fun clearAppBadgeAsync(): Promise<Void>

getGamepads

fun getGamepads(): ReadonlyArray<Gamepad?>

The Navigator.getGamepads() method returns an array of Elements in the array may be null if a gamepad disconnects during a session, so that the remaining gamepads retain the same index.

registerProtocolHandler

abstract fun registerProtocolHandler(scheme: String, url: String)

Available only in secure contexts.

abstract fun registerProtocolHandler(scheme: String, url: URL)

requestMediaKeySystemAccess

suspend fun requestMediaKeySystemAccess( keySystem: String, supportedConfigurations: ReadonlyArray<MediaKeySystemConfiguration>): MediaKeySystemAccess

The requestMediaKeySystemAccess() method of the Navigator interface returns a Promise which delivers a MediaKeySystemAccess object that can be used to access a particular media key system, which can in turn be used to create keys for decrypting a media stream. Available only in secure contexts.

requestMediaKeySystemAccessAsync

fun requestMediaKeySystemAccessAsync( keySystem: String, supportedConfigurations: ReadonlyArray<MediaKeySystemConfiguration>): Promise<MediaKeySystemAccess>

requestMIDIAccess

suspend fun requestMIDIAccess(options: MIDIOptions = definedExternally): MIDIAccess

The requestMIDIAccess() method of the Navigator interface returns a Promise representing a request for access to MIDI devices on a user's system. Available only in secure contexts.

requestMIDIAccessAsync

fun requestMIDIAccessAsync(options: MIDIOptions = definedExternally): Promise<MIDIAccess>

sendBeacon

fun sendBeacon(url: String, data: BodyInit? = definedExternally): Boolean

The navigator.sendBeacon() method Asynchronous sends an HTTP POST request containing a small amount of data to a web server.

fun sendBeacon(url: URL, data: BodyInit? = definedExternally): Boolean

setAppBadge

abstract suspend fun setAppBadge(contents: UInt53 = definedExternally)

MDN Reference

setAppBadgeAsync

abstract fun setAppBadgeAsync(contents: UInt53 = definedExternally): Promise<Void>

suspend fun share(data: ShareData = definedExternally)

The share() method of the Navigator interface invokes the native sharing mechanism of the device to share data such as text, URLs, or files. Available only in secure contexts.

shareAsync

fun shareAsync(data: ShareData = definedExternally): Promise<Void>

vibrate

fun vibrate(pattern: VibratePattern): Boolean

The vibrate() method of the Navigator interface pulses the vibration hardware on the device, if such hardware exists.