Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 1043710 of Navigator

  • Revision slug: Web/API/Navigator
  • Revision title: Navigator
  • Revision id: 1043710
  • Created:
  • Creator: jpmedley
  • Is current revision? No
  • Comment Add the credentials interface.

Revision Content

{{ apiref() }}

The Navigator interface represents the state and the identity of the user agent. It allows scripts to query it and to register themselves to carry on some activities.

A Navigator object can be retrieved using the read-only {{domxref("Window.navigator")}} property.

Properties

Doesn't inherit any property, but implements those defined in {{domxref("NavigatorID")}}, {{domxref("NavigatorLanguage")}}, {{domxref("NavigatorOnLine")}}, {{domxref("NavigatorContentUtils")}}, {{domxref("NavigatorStorageUtils")}}, {{domxref("NavigatorCookies")}}, {{domxref("NavigatorConcurrentHardware")}}, {{domxref("NavigatorPlugins")}}, and {{domxref("NavigatorUserMedia")}}.

Standard

{{domxref("NavigatorID.appCodeName")}} {{readonlyInline}}{{experimental_inline}}
Returns the internal "code" name of the current browser. Do not rely on this property to return the correct value.
{{domxref("NavigatorID.appName")}} {{readonlyInline}}{{experimental_inline}}
Returns a {{domxref("DOMString")}} with the official name of the browser. Do not rely on this property to return the correct value.
{{domxref("NavigatorID.appVersion")}} {{readonlyInline}}{{experimental_inline}}
Returns the version of the browser as a {{domxref("DOMString")}}. Do not rely on this property to return the correct value.
{{domxref("Navigator.battery")}} {{readonlyInline}}
Returns a {{domxref("BatteryManager")}} object you can use to get information about the battery charging status.
{{domxref("Navigator.connection")}} {{readonlyInline}}{{experimental_inline}}
Provides a {{domxref("NetworkInformation")}} object containing information about the network connection of a device.
{{domxref("Navigator.geolocation")}} {{readonlyInline}}
Returns a {{domxref("Geolocation")}} object allowing accessing the location of the device.
{{domxref("NavigatorConcurrentHardware.hardwareConcurrency")}} {{readOnlyInline}}
Returns the number of logical processor cores available.
{{domxref("NavigatorPlugins.javaEnabled")}} {{readonlyInline}}{{experimental_inline}}
Returns a {{domxref("Boolean")}} flag indicating whether the host browser is Java-enabled or not.
{{domxref("NavigatorLanguage.language")}} {{readonlyInline}}
Returns a {{domxref("DOMString")}} representing the preferred language of the user, usually the language of the browser UI. The null value is returned when this is unknown.
{{domxref("NavigatorLanguage.languages")}} {{readonlyInline}}
Returns an array of {{domxref("DOMString")}} representing the languages known to the user, by order of preference.
{{domxref("NavigatorPlugins.mimeTypes")}} {{readonlyInline}}{{experimental_inline}}
Returns an {{domxref("MimeTypeArray")}} listing the MIME types supported by the browser.
{{domxref("NavigatorOnLine.onLine")}} {{readonlyInline}}
Returns a {{domxref("Boolean")}} indicating whether the browser is working online.
{{domxref("Navigator.oscpu")}}
Returns a string that represents the current operating system.
{{domxref("Navigator.permissions")}} {{readonlyinline}}{{experimental_inline}}
Returns a {{domxref("Permissions")}} object that can be used to query and update permission status of APIs covered by the Permissions API.
{{domxref("NavigatorID.platform")}} {{readonlyInline}}{{experimental_inline}}
Returns a string representing the platform of the browser. Do not rely on this function to return a significant value.
{{domxref("NavigatorPlugins.plugins")}} {{readonlyInline}}{{experimental_inline}}
Returns a {{domxref("PluginArray")}} listing the plugins installed in the browser.
{{domxref("NavigatorID.product")}} {{readonlyInline}} {{experimental_inline}}
Always returns 'Gecko', on any browser. This property is kept only for compatibility purpose.
{{domxref("NavigatorID.userAgent")}} {{readonlyInline}}
Returns the user agent string for the current browser.
{{domxref("Navigator.serviceWorker")}} {{readonlyInline}}
Returns a {{domxref("ServiceWorkerContainer")}} object, which provides access to registration, removal, upgrade, and communication with the {{domxref("ServiceWorker")}} objects for the associated document.

Non-standard

Firefox OS devices adds more non-standard properties. You can consult them on the Firefox OS Navigator extensions article.

{{domxref("Navigator.buildID")}} {{non-standard_inline}}
Returns the build identifier of the browser (e.g., "2006090803").
{{domxref("Navigator.cookieEnabled")}} {{non-standard_inline}}
Returns a boolean indicating whether cookies are enabled in the browser or not.
{{domxref("Navigator.credentials")}} {{non-standard_inline}}
Returns the {{domxref("CredentialsContainer")}} interface which exposes methods to request credentials and notify the user agent when interesting events occur such as successful sign in or sign out. 
{{domxref("Navigator.doNotTrack")}} {{non-standard_inline}}
Reports the value of the user's do-not-track preference. When this value is "yes", your web site or application should not track the user.
{{domxref("Navigator.id")}} {{non-standard_inline}}
Returns the {{domxref("window.navigator.id", "id")}} object which you can use to add support for BrowserID to your web site.
{{domxref("Navigator.mediaDevices")}} {{non-standard_inline}}
Returns a reference to the {{domxref("MediaDevices")}} interface.
{{domxref("Navigator.mozNotification")}} {{deprecated_inline("22")}} {{non-standard_inline}}
{{domxref("Navigator.webkitNotification")}}
Returns a {{domxref("navigator.mozNotification", "notification")}} object you can use to deliver notifications to the user from your web application.
{{domxref("Navigator.mozSocial")}} {{non-standard_inline}}
The Object, returned by the navigator.mozSocial property, is available within the social media provider's panel to provide functionality it may need.
{{domxref("Navigator.presentation")}} {{non-standard_inline}}
Returns a reference to the {{domxref("Presentation")}} API.
{{domxref("Navigator.productSub")}} {{non-standard_inline}}
Returns the build number of the current browser (e.g., "20060909").
{{domxref("Navigator.securitypolicy")}} {{non-standard_inline}}
Returns an empty string. In Netscape 4.7x, returns "US & CA domestic policy" or "Export policy".
{{domxref("Navigator.standalone")}} {{non-standard_inline}}
Returns a boolean indicating whether the browser is running in standalone mode. Available on Apple's iOS Safari only.
{{domxref("Navigator.vendor")}} {{non-standard_inline}}
Returns the vendor name of the current browser (e.g., "Netscape6").
{{domxref("Navigator.vendorSub")}} {{non-standard_inline}}
Returns the vendor version number (e.g. "6.1").
{{domxref("Navigator.webkitPointer")}} {{non-standard_inline}}
Returns a PointerLock object for the Mouse Lock API.

Methods

Doesn't inherit any method, but implements those defined in {{domxref("NavigatorID")}}, {{domxref("NavigatorContentUtils")}}, {{domxref("NavigatorUserMedia")}}, and {{domxref("NavigatorStorageUtils")}}.

Standard

{{domxref("Navigator.getUserMedia", "NavigatorUserMedia.getUserMedia()")}}
After having prompted the user for permission, returns the audio or video stream associated to a camera or microphone on the local computer.
{{domxref("Navigator.registerContentHandler()")}}
Allows web sites to register themselves as a possible handler for a given MIME type.
{{domxref("Navigator.registerProtocolHandler()")}}
Allows web sites to register themselves as a possible handler for a given protocol.
{{domxref("Navigator.requestMediaKeySystemAccess()")}} {{experimental_inline}}
Returns a {{jsxref("Promise")}} for a MediaKeySystemAccess object.
{{domxref("Navigator.sendBeacon()")}}{{experimental_inline}}
Used to asynchronously transfer small HTTP data from the User Agent to a web server.
{{domxref("NavigatorID.taintEnabled()")}} {{deprecated_inline("1.7.8")}} {{obsolete_inline("9.0")}} {{experimental_inline}}
Returns false. JavaScript taint/untaint functions removed in JavaScript 1.2.
{{domxref("Navigator.vibrate()")}} {{gecko_minversion_inline("11.0")}}
Causes vibration on devices with support for it. Does nothing if vibration support isn't available.

Non-standard

Firefox OS devices adds more non-standard methods. You can consult them on the Firefox OS Navigator extensions article.

{{domxref("Navigator.getVRDevices()")}} {{non-standard_inline}}
Returns a promise that resolves to an array of objects representing any VR devices that are connected to the computer and compatible with the browser.
{{domxref("Navigator.mozIsLocallyAvailable()")}} {{non-standard_inline}}
Lets code check to see if the document at a given URI is available without using the network.
{{domxref("Navigator.mozPay()")}} {{non-standard_inline}}
Allows in-app payment.

Revision Source

<p>{{ apiref() }}</p>

<p>The <code><strong>Navigator</strong></code> interface represents the state and the identity of the user agent. It allows scripts to query it and to register themselves to carry on some activities.</p>

<p>A <code>Navigator</code> object can be retrieved using the read-only {{domxref("Window.navigator")}} property.</p>

<h2 id="Properties">Properties</h2>

<p><em>Doesn't inherit any property, but implements those defined in {{domxref("NavigatorID")}}, {{domxref("NavigatorLanguage")}}, {{domxref("NavigatorOnLine")}}, {{domxref("NavigatorContentUtils")}}, {{domxref("NavigatorStorageUtils")}}, {{domxref("NavigatorCookies")}}, {{domxref("NavigatorConcurrentHardware")}}, {{domxref("NavigatorPlugins")}}, and {{domxref("NavigatorUserMedia")}}.</em></p>

<h3 id="Standard">Standard</h3>

<dl>
 <dt>{{domxref("NavigatorID.appCodeName")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns the internal "code" name of the current browser. Do not rely on this property to return the correct value.</dd>
 <dt>{{domxref("NavigatorID.appName")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns a {{domxref("DOMString")}} with the official name of the browser. Do not rely on this property to return the correct value.</dd>
 <dt>{{domxref("NavigatorID.appVersion")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns the version of the browser as a {{domxref("DOMString")}}. Do not rely on this property to return the correct value.</dd>
 <dt>{{domxref("Navigator.battery")}} {{readonlyInline}}</dt>
 <dd>Returns a {{domxref("BatteryManager")}} object you can use to get information about the battery charging status.</dd>
 <dt>{{domxref("Navigator.connection")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Provides a {{domxref("NetworkInformation")}} object containing information about the network connection of a device.</dd>
 <dt>{{domxref("Navigator.geolocation")}} {{readonlyInline}}</dt>
 <dd>Returns a {{domxref("Geolocation")}} object allowing accessing the location of the device.</dd>
 <dt>{{domxref("NavigatorConcurrentHardware.hardwareConcurrency")}} {{readOnlyInline}}</dt>
 <dd>Returns the number of logical processor cores available.</dd>
 <dt>{{domxref("NavigatorPlugins.javaEnabled")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns a {{domxref("Boolean")}} flag indicating whether the host browser is Java-enabled or not.</dd>
 <dt>{{domxref("NavigatorLanguage.language")}} {{readonlyInline}}</dt>
 <dd>Returns a {{domxref("DOMString")}} representing the preferred language of the user, usually the language of the browser UI. The <code>null</code> value is returned when this is unknown.</dd>
 <dt>{{domxref("NavigatorLanguage.languages")}} {{readonlyInline}}</dt>
 <dd>Returns an array of {{domxref("DOMString")}} representing the languages known to the user, by order of preference.</dd>
 <dt>{{domxref("NavigatorPlugins.mimeTypes")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns an {{domxref("MimeTypeArray")}} listing the MIME types supported by the browser.</dd>
 <dt>{{domxref("NavigatorOnLine.onLine")}} {{readonlyInline}}</dt>
 <dd>Returns a {{domxref("Boolean")}} indicating whether the browser is working online.</dd>
 <dt>{{domxref("Navigator.oscpu")}}</dt>
 <dd>Returns a string that represents the current operating system.</dd>
 <dt>{{domxref("Navigator.permissions")}} {{readonlyinline}}{{experimental_inline}}</dt>
 <dd>Returns a {{domxref("Permissions")}} object that can be used to query and update permission status of APIs covered by the <a href="/en-US/docs/Web/API/Permissions_API">Permissions API</a>.</dd>
 <dt>{{domxref("NavigatorID.platform")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns a string representing the platform of the browser. Do not rely on this function to return a significant value.</dd>
 <dt>{{domxref("NavigatorPlugins.plugins")}} {{readonlyInline}}{{experimental_inline}}</dt>
 <dd>Returns a {{domxref("PluginArray")}} listing the plugins installed in the browser.</dd>
 <dt>{{domxref("NavigatorID.product")}} {{readonlyInline}} {{experimental_inline}}</dt>
 <dd>Always returns <code>'Gecko'</code>, on any browser. This property is kept only for compatibility purpose.</dd>
 <dt>{{domxref("NavigatorID.userAgent")}} {{readonlyInline}}</dt>
 <dd>Returns the user agent string for the current browser.</dd>
 <dt>{{domxref("Navigator.serviceWorker")}} {{readonlyInline}}</dt>
 <dd>Returns a {{domxref("ServiceWorkerContainer")}}&nbsp;object, which provides access to registration, removal, upgrade, and communication with the&nbsp;{{domxref("ServiceWorker")}} objects&nbsp;for the <a href="https://html.spec.whatwg.org/multipage/browsers.html#concept-document-window">associated document</a>.</dd>
</dl>

<h3 id="Methods" name="Methods">Non-standard</h3>

<div class="note">
<p>Firefox OS devices adds more non-standard properties. You can consult them on the <a href="/en-US/docs/Mozilla/Firefox_OS/API/Navigator">Firefox OS Navigator extensions article</a>.</p>
</div>

<dl>
 <dt>{{domxref("Navigator.buildID")}} {{non-standard_inline}}</dt>
 <dd>Returns the build identifier of the browser (e.g., "2006090803").</dd>
 <dt>{{domxref("Navigator.cookieEnabled")}} {{non-standard_inline}}</dt>
 <dd>Returns a boolean indicating whether cookies are enabled in the browser or not.</dd>
 <dt>{{domxref("Navigator.credentials")}} {{non-standard_inline}}</dt>
 <dd>Returns the {{domxref("CredentialsContainer")}} interface which&nbsp;exposes methods to request credentials and notify the user agent when interesting events occur such as successful sign in or sign out.&nbsp;</dd>
 <dt>{{domxref("Navigator.doNotTrack")}} {{non-standard_inline}}</dt>
 <dd>Reports the value of the user's do-not-track preference. When this value is "yes", your web site or application should not track the user.</dd>
 <dt>{{domxref("Navigator.id")}} {{non-standard_inline}}</dt>
 <dd>Returns the {{domxref("window.navigator.id", "id")}} object which you can use to add support for <a href="/en-US/docs/BrowserID" title="BrowserID">BrowserID</a> to your web site.</dd>
 <dt>{{domxref("Navigator.mediaDevices")}}&nbsp;{{non-standard_inline}}</dt>
 <dd>Returns a reference to the {{domxref("MediaDevices")}} interface.</dd>
 <dt>{{domxref("Navigator.mozNotification")}} {{deprecated_inline("22")}} {{non-standard_inline}}<br />
 {{domxref("Navigator.webkitNotification")}}</dt>
 <dd>Returns a {{domxref("navigator.mozNotification", "notification")}} object you can use to deliver notifications to the user from your web application.</dd>
 <dt>{{domxref("Navigator.mozSocial")}} {{non-standard_inline}}</dt>
 <dd>The Object, returned by the <code>navigator.mozSocial</code> property, is available within the social media provider's panel to provide functionality it may need.</dd>
 <dt>{{domxref("Navigator.presentation")}} {{non-standard_inline}}</dt>
 <dd>Returns a reference to the {{domxref("Presentation")}} API.</dd>
 <dt>{{domxref("Navigator.productSub")}} {{non-standard_inline}}</dt>
 <dd>Returns the build number of the current browser (e.g., "20060909").</dd>
 <dt>{{domxref("Navigator.securitypolicy")}} {{non-standard_inline}}</dt>
 <dd>Returns an empty string. In Netscape 4.7x, returns "US &amp; CA domestic policy" or "Export policy".</dd>
 <dt>{{domxref("Navigator.standalone")}} {{non-standard_inline}}</dt>
 <dd>Returns a boolean indicating whether the browser is running in standalone mode. Available on Apple's iOS Safari only.</dd>
 <dt>{{domxref("Navigator.vendor")}} {{non-standard_inline}}</dt>
 <dd>Returns the vendor name of the current browser (e.g., "Netscape6").</dd>
 <dt>{{domxref("Navigator.vendorSub")}} {{non-standard_inline}}</dt>
 <dd>Returns the vendor version number (e.g. "6.1").</dd>
 <dt>{{domxref("Navigator.webkitPointer")}} {{non-standard_inline}}</dt>
 <dd>Returns a PointerLock object for the <a href="/en-US/docs/API/Pointer_Lock_API" title="Mouse Lock API">Mouse Lock API</a>.</dd>
</dl>

<h2 id="Methods" name="Methods">Methods</h2>

<p><em>Doesn't inherit any method, but implements those defined in {{domxref("NavigatorID")}}, {{domxref("NavigatorContentUtils")}}, <em>{{domxref("NavigatorUserMedia")}}, </em>and {{domxref("NavigatorStorageUtils")}}.</em></p>

<h3 id="Standard_2">Standard</h3>

<dl>
 <dt>{{domxref("Navigator.getUserMedia", "NavigatorUserMedia.getUserMedia()")}}</dt>
 <dd>After having prompted the user for permission, returns the audio or video stream associated to a camera or microphone on the local computer.</dd>
 <dt>{{domxref("Navigator.registerContentHandler()")}}</dt>
 <dd>Allows web sites to register themselves as a possible handler for a given MIME type.</dd>
 <dt>{{domxref("Navigator.registerProtocolHandler()")}}</dt>
 <dd>Allows web sites to register themselves as a possible handler for a given protocol.</dd>
 <dt>{{domxref("Navigator.requestMediaKeySystemAccess()")}} {{experimental_inline}}</dt>
 <dd>Returns a&nbsp;<span style="line-height:19.0909080505371px">{{jsxref("Promise")}} for a MediaKeySystemAccess object.</span></dd>
 <dt>{{domxref("Navigator.sendBeacon()")}}{{experimental_inline}}</dt>
 <dd>Used to asynchronously transfer small HTTP data from the User Agent to a web server.</dd>
 <dt>{{domxref("NavigatorID.taintEnabled()")}} {{deprecated_inline("1.7.8")}} {{obsolete_inline("9.0")}} {{experimental_inline}}</dt>
 <dd>Returns <code>false</code>. JavaScript taint/untaint functions removed in JavaScript 1.2.</dd>
 <dt>{{domxref("Navigator.vibrate()")}} {{gecko_minversion_inline("11.0")}}</dt>
 <dd>Causes vibration on devices with support for it. Does nothing if vibration support isn't available.</dd>
</dl>

<h3 id="Specification" name="Specification">Non-standard</h3>

<div class="note">
<p>Firefox OS devices adds more non-standard methods. You can consult them on the <a href="/en-US/docs/Mozilla/Firefox_OS/API/Navigator">Firefox OS Navigator extensions article</a>.</p>
</div>

<dl>
 <dt>{{domxref("Navigator.getVRDevices()")}} {{non-standard_inline}}</dt>
 <dd>Returns a promise that resolves to an array of objects representing any VR devices that are connected to the computer and compatible with the browser.</dd>
 <dt>{{domxref("Navigator.mozIsLocallyAvailable()")}} {{non-standard_inline}}</dt>
 <dd>Lets code check to see if the document at a given URI is available without using the network.</dd>
 <dt>{{domxref("Navigator.mozPay()")}} {{non-standard_inline}}</dt>
 <dd>Allows in-app payment.</dd>
</dl>
Revert to this revision