Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
*
* The origin of this IDL file is
*
* © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and
* Opera Software ASA. You are granted a license to use, reproduce
* and create derivative works of this document.
*/
interface URI;
[HeaderFile="Navigator.h",
Exposed=Window,
InstrumentedProps=(canShare,
clearAppBadge,
setAppBadge,
share,
userActivation,
wakeLock)]
interface Navigator {
// objects implementing this interface also implement the interfaces given below
};
Navigator includes NavigatorID;
Navigator includes NavigatorLanguage;
Navigator includes NavigatorOnLine;
Navigator includes NavigatorContentUtils;
Navigator includes NavigatorStorageUtils;
Navigator includes NavigatorConcurrentHardware;
Navigator includes NavigatorStorage;
Navigator includes NavigatorAutomationInformation;
Navigator includes NavigatorGPU;
Navigator includes GlobalPrivacyControl;
interface mixin NavigatorID {
// WebKit/Blink/Trident/Presto support this (hardcoded "Mozilla").
[Constant, Cached, Throws]
readonly attribute DOMString appCodeName; // constant "Mozilla"
[Constant, Cached]
readonly attribute DOMString appName; // constant "Netscape"
[Constant, Cached, Throws, NeedsCallerType]
readonly attribute DOMString appVersion;
[Pure, Cached, Throws, NeedsCallerType]
readonly attribute DOMString platform;
[Pure, Cached, Throws, NeedsCallerType]
readonly attribute DOMString userAgent;
[Constant, Cached]
readonly attribute DOMString product; // constant "Gecko"
[Exposed=Window]
boolean taintEnabled(); // constant false
};
interface mixin NavigatorLanguage {
// These two attributes are cached because this interface is also implemented
// by Workernavigator and this way we don't have to go back to the
// main-thread from the worker thread anytime we need to retrieve them. They
// are updated when pref intl.accept_languages is changed.
[Pure, Cached]
readonly attribute DOMString? language;
[Pure, Cached, Frozen]
readonly attribute sequence<DOMString> languages;
};
interface mixin NavigatorOnLine {
readonly attribute boolean onLine;
};
interface mixin NavigatorContentUtils {
// content handler registration
[Throws, ChromeOnly]
undefined checkProtocolHandlerAllowed(DOMString scheme, URI handlerURI, URI documentURI);
[Throws, SecureContext]
undefined registerProtocolHandler(DOMString scheme, DOMString url);
// NOT IMPLEMENTED
//undefined unregisterProtocolHandler(DOMString scheme, DOMString url);
};
[SecureContext]
interface mixin NavigatorStorage {
readonly attribute StorageManager storage;
};
interface mixin NavigatorStorageUtils {
// NOT IMPLEMENTED
//undefined yieldForStorageUpdates();
};
partial interface Navigator {
[Throws, SameObject]
readonly attribute Permissions permissions;
};
partial interface Navigator {
[Throws, SameObject]
readonly attribute MimeTypeArray mimeTypes;
[Throws, SameObject]
readonly attribute PluginArray plugins;
readonly attribute boolean pdfViewerEnabled;
};
partial interface Navigator {
readonly attribute DOMString doNotTrack;
};
interface mixin GlobalPrivacyControl {
[Pref="privacy.globalprivacycontrol.functionality.enabled"]
readonly attribute boolean globalPrivacyControl;
};
interface mixin NavigatorGeolocation {
[Throws, Pref="geo.enabled"]
readonly attribute Geolocation geolocation;
};
Navigator includes NavigatorGeolocation;
partial interface Navigator {
// ChromeOnly to prevent web content from fingerprinting users' batteries.
[Throws, ChromeOnly, Pref="dom.battery.enabled"]
Promise<BatteryManager> getBattery();
};
partial interface Navigator {
// We don't support sequences in unions yet
//boolean vibrate ((unsigned long or sequence<unsigned long>) pattern);
[Pref="dom.vibrator.enabled"]
boolean vibrate(unsigned long duration);
[Pref="dom.vibrator.enabled"]
boolean vibrate(sequence<unsigned long> pattern);
};
partial interface Navigator {
[NeedsCallerType]
readonly attribute long maxTouchPoints;
};
[Exposed=Window]
partial interface Navigator {
[SameObject]
readonly attribute MediaCapabilities mediaCapabilities;
};
// Mozilla-specific extensions
// Chrome-only interface for Vibration API permission handling.
partial interface Navigator {
/* Set permission state to device vibration.
* @param permitted permission state (true for allowing vibration)
* @param persistent make the permission session-persistent
*/
[ChromeOnly]
undefined setVibrationPermission(boolean permitted,
optional boolean persistent = true);
};
partial interface Navigator {
[Throws, Constant, Cached, NeedsCallerType]
readonly attribute DOMString oscpu;
// WebKit/Blink support this; Trident/Presto do not.
readonly attribute DOMString vendor;
// WebKit/Blink supports this (hardcoded ""); Trident/Presto do not.
readonly attribute DOMString vendorSub;
// WebKit/Blink supports this (hardcoded "20030107"); Trident/Presto don't
readonly attribute DOMString productSub;
// WebKit/Blink/Trident/Presto support this.
readonly attribute boolean cookieEnabled;
[Throws, Constant, Cached, NeedsCallerType]
readonly attribute DOMString buildID;
// WebKit/Blink/Trident/Presto support this.
[Affects=Nothing, DependsOn=Nothing]
boolean javaEnabled();
};
// Addon manager bits
partial interface Navigator {
[Throws, Func="mozilla::AddonManagerWebAPI::IsAPIEnabled"]
readonly attribute AddonManager mozAddonManager;
};
// NetworkInformation
partial interface Navigator {
[Throws, Pref="dom.netinfo.enabled"]
readonly attribute NetworkInformation connection;
};
partial interface Navigator {
[Throws, Pref="dom.gamepad.enabled"]
sequence<Gamepad?> getGamepads();
};
partial interface Navigator {
[Throws, Pref="dom.gamepad.test.enabled"]
GamepadServiceTest requestGamepadServiceTest();
};
// Chrome-only interface for acquiring all gamepads. Normally, a gamepad can
// only become visible if it gets interacted by the user. This function bypasses
// this restriction; it allow requesting all gamepad info without user
// interacting with the gamepads.
partial interface Navigator {
[Throws, ChromeOnly]
Promise<sequence<Gamepad>> requestAllGamepads();
};
partial interface Navigator {
[NewObject, SecureContext, Pref="dom.vr.enabled"]
Promise<sequence<VRDisplay>> getVRDisplays();
[SecureContext, Frozen, Cached, Pure, Pref="dom.vr.enabled"]
readonly attribute sequence<VRDisplay> activeVRDisplays;
[ChromeOnly, Pref="dom.vr.enabled"]
readonly attribute boolean isWebVRContentDetected;
[ChromeOnly, Pref="dom.vr.enabled"]
readonly attribute boolean isWebVRContentPresenting;
[ChromeOnly, Pref="dom.vr.enabled"]
undefined requestVRPresentation(VRDisplay display);
};
partial interface Navigator {
[Throws, Pref="dom.vr.puppet.enabled"]
VRServiceTest requestVRServiceTest();
};
partial interface Navigator {
[SecureContext, SameObject, Throws, Pref="dom.vr.webxr.enabled"]
readonly attribute XRSystem xr;
};
partial interface Navigator {
[NewObject, Func="Navigator::HasMidiSupport"]
Promise<MIDIAccess> requestMIDIAccess(optional MIDIOptions options = {});
};
callback NavigatorUserMediaSuccessCallback = undefined (MediaStream stream);
callback NavigatorUserMediaErrorCallback = undefined (MediaStreamError error);
partial interface Navigator {
[Throws, Func="Navigator::HasUserMediaSupport"]
readonly attribute MediaDevices mediaDevices;
// Deprecated. Use mediaDevices.getUserMedia instead.
[Deprecated="NavigatorGetUserMedia", Throws,
Func="Navigator::HasUserMediaSupport",
NeedsCallerType,
UseCounter]
undefined mozGetUserMedia(MediaStreamConstraints constraints,
NavigatorUserMediaSuccessCallback successCallback,
NavigatorUserMediaErrorCallback errorCallback);
};
// Service Workers/Navigation Controllers
partial interface Navigator {
[Func="ServiceWorkersEnabled", SameObject, BinaryName="serviceWorkerJS"]
readonly attribute ServiceWorkerContainer serviceWorker;
};
partial interface Navigator {
[Throws, Pref="beacon.enabled"]
boolean sendBeacon(DOMString url,
optional BodyInit? data = null);
};
partial interface Navigator {
[NewObject, Func="mozilla::dom::TCPSocket::ShouldTCPSocketExist"]
readonly attribute LegacyMozTCPSocket mozTCPSocket;
};
partial interface Navigator {
[NewObject]
Promise<MediaKeySystemAccess>
requestMediaKeySystemAccess(DOMString keySystem,
sequence<MediaKeySystemConfiguration> supportedConfigurations);
};
interface mixin NavigatorConcurrentHardware {
readonly attribute unsigned long long hardwareConcurrency;
};
partial interface Navigator {
[Pref="security.webauth.webauthn", SecureContext, SameObject]
readonly attribute CredentialsContainer credentials;
};
interface mixin NavigatorAutomationInformation {
[Constant, Cached]
readonly attribute boolean webdriver;
};
partial interface Navigator {
[SecureContext, SameObject]
readonly attribute Clipboard clipboard;
};
// Used for testing of origin trials.
partial interface Navigator {
[Trial="TestTrial"]
readonly attribute boolean testTrialGatedAttribute;
};
partial interface Navigator {
[SecureContext, NewObject, Func="Navigator::HasShareSupport"]
Promise<undefined> share(optional ShareData data = {});
[SecureContext, Func="Navigator::HasShareSupport"]
boolean canShare(optional ShareData data = {});
};
dictionary ShareData {
USVString title;
USVString text;
USVString url;
// Note: we don't actually support files yet
// we have it here for the .canShare() checks.
sequence<File> files;
};
[Exposed=Window]
partial interface Navigator {
[SameObject]
readonly attribute MediaSession mediaSession;
};
[SecureContext]
interface mixin NavigatorLocks {
readonly attribute LockManager locks;
};
Navigator includes NavigatorLocks;
enum AutoplayPolicy {
"allowed",
"allowed-muted",
"disallowed"
};
enum AutoplayPolicyMediaType {
"mediaelement",
"audiocontext"
};
partial interface Navigator {
[Pref="dom.media.autoplay-policy-detection.enabled"]
AutoplayPolicy getAutoplayPolicy(AutoplayPolicyMediaType type);
[Pref="dom.media.autoplay-policy-detection.enabled"]
AutoplayPolicy getAutoplayPolicy(HTMLMediaElement element);
[Pref="dom.media.autoplay-policy-detection.enabled"]
AutoplayPolicy getAutoplayPolicy(AudioContext context);
};
partial interface Navigator {
[SameObject] readonly attribute UserActivation userActivation;
};
[SecureContext]
partial interface Navigator {
[SameObject, Pref="dom.screenwakelock.enabled"]
readonly attribute WakeLock wakeLock;
};
[SecureContext]
partial interface Navigator {
[SameObject, Trial="PrivateAttributionV2"]
readonly attribute PrivateAttribution privateAttribution;
};