API documentation status overview

As documentation is moving forward, this page will be updated accordingly: APIs that are fully documented are pushed at the bottom of the page and ongoing documentation is put on top.

Ongoing documentation work

See the WebAPI doc schedule for details on our schedule for completing this content.

Update Required

The support for Promise as been landed (bug 856410). When turn on on B2G (bug 897913), it will have many impacts on Web APIs' documentation. This need to be tracked carfully.

API Name	Entry Points	Bugs	Doc status	Notes
WebTelephony (support for Conf Call)	Tag: Telephony	bug 772765	Needs extension and update	Landed FxOS 1.2 only. Certified Apps only
Network Stats API	Tag: Network Stats	bug 858003 bug 858005 bug 887699	Needs update	Not landed yet
Notification API	`Notification.get` Tag: Notifications	bug 899574	Needs update	Not landed yet

Network APIs

API Name	Entry Points	Bugs	Doc status	Notes
Mobile Connection API	`navigator.mozMobileConnection` `MozMobileConnection` `MozMobileConnectionInfo` `MozMobileICCInfo` `MozMobileNetworkInfo` `MozMobileCFInfo` `MozMobileCellInfo` Introductory article: Mobile Connection Paused: `MozIccManager` `MozStkCommandEvent` Tag: none yet	bug 729173 bug 857414	partial	Paused: The STK stack is a big piece and needs further investigation. It doesn't look like a high priority API to document. Tech review of everything not related to STK asked to Vicamo Yang and Ken Chang. MXR: MobileConnection WikiMo: WebMobileConnection

Data Management APIs

API Name	Entry Points	Bugs	Doc status	Notes
IndexedDB	`window.indexedDB` IndexedDB root page: /IndexedDB	bug 553412	almost done	The whole documentation lives under /IndexedDB. Shouldn't we moved it under /Web ? We are waiting the end of the switch to WebIDL to update the documentation Spec: https://www.w3.org/TR/IndexedDB/ (the draft is more accurate)

Other APIs

API Name	Entry Points	Bugs	Doc status	Notes
Inter-App communication API		bug 876397	none	WikiMo: Inter-App Communication
Open WebApps		bug 697006	almost done	Needs some clean up
Voicemail API	`window.navigator.mozVoicemail` `MozVoicemail` `MozVoicemailEvent` `MozVoicemailStatus` Tag: voicemail	bug 773068	Partial	The basic reference documentation is okay but it still need some proper introductory article. It also requires to make the difference between the FxOS 1.0 and 1.3 API (enhancement for multi-sim cards) WikiMo: WebVoicemail, WebVoicemail (multi SIM)
Microphone API		bug 894848	none	Landed in B2G 1.2

Implementation in progress

Those are APIs in progress. They are NOT ready to be documented yet.

API Name	Bugs	Doc status	Notes
AudioChannels	bug 1113086 bug 876631	none	WikiMo: AudioChannels
DataStore	bug 871445	none	WikiMo: DataStore
Virtual Keyboard API	bug 737110	none	WikiMo: KeboardIME
WebNFC	bug 674741	none	WikiMo: WebNFC
WebUSB	bug 674718	none	WikiMo: WebUSB
Speaker Manager API	bug 854753	none	WikiMo: unknown
FM RDS (extension of FM API)	bug 864327	none	WebAPI forum
ServiceWorker API	bug 903441	none	Github

Documentation complete

Web content or installed APIs

API Name	Entry Points	Bugs	Doc status	Notes
Alarm API	`navigator.mozAlarms` `MozAlarmsManager` Introductory article: Alarm Tag: alarm	bug 749551	done	Needs editorial review and technical review. Discuss with Mounir and Genelian about the spec. It is not stable enough to plan any change in the current implementation. Spec: https://www.w3.org/TR/web-alarms/ MXR: MozAlarmsManager WikiMo: AlarmAPI
Ambient Light Events	`DeviceLightEvent` `window.ondevicelight` `devicelight` event Introductory article: Using Light Events Tag: Ambient Light Postoned documentation because the API is at risk: `LightLevelEvent` `window.onlightlevel` `lightlevel` event	bug 738465 bug 842952	done	~~Discussed with Doug Turner about the state of the spec and the implementation of `LightLevelEvent`: even if it's not implemented yet, we should document the `LightLevelEvent` interface~~ Discussed with Annvek the opportunity to drop `LightLevelEvent` from the spec. Spec: https://www.w3.org/TR/ambient-light/ (the draft is more accurate) MXR: DeviceLightEvent
Battery Status API	`navigator.battery` `BatteryManager` `chargingchange` event `chargingtimechange` event `dischargingtimechange` event `levelchange` event Introductory article: Battery Status Tag: Battery	bug 678694	done	Don't be fooled by the BatteryManager red link, it's just due to migration from DOM to Web/API within the domxref template. Needs editorial review Spec: https://www.w3.org/TR/battery-status/ (the draft is more accurate) MXR: BatteryManager
Device Orientation	`DeviceOrientationEvent` `DeviceMotionEvent` `window.ondeviceorientation` `window.ondevicemotion` `deviceorientation` event `devicemotion` event Introductory article: Detecting device orientation Tag: Device Orientation Unimplemented but in the spec `window.oncompassneedscalibration` `compassneedscalibration` event	bug 615597	done	The introductory still need a quick technical review. Spec: https://www.w3.org/TR/orientation-event/ (the draft is more accurate) MXR: DeviceOrientationEvent, DeviceMotion WikiMo: ScreenOrientation
FileHandle API	`FileHandle` `LockedFile` `FileRequest` Introductory article: FileHandle API Tag: Files	bug 726593	done	Still need technical review `IDBDatabase.mozCreateFileHandle` need to be documented but it is not urgent as it is a transitory API and it does not do anything special (it's just a factory to get `FileHandle` objects) Spec(?): https://dev.w3.org/2006/webapi/FileAPI/ https://w3c.github.io/filesystem-api/Overview.html MXR: FileHandle, LockedFile, FileRequest WikiMo: FileHandleAPI
Geolocation API	`NavigatorGeolocation` (incl. methods/properties) `Geolocation` (incl. methods/properties) `Position` (incl. methods/properties) `Coordinates` (incl. methods/properties) `PositionError` (incl. methods/properties) `PositionOptions` (incl. methods/properties) Introductory article: Using geolocation Tag: Geolocation API		done	Editorial review complete. Spec: https://www.w3.org/TR/geolocation-API/ Maybe add basic examples?
Network Information API	`NetworkInformation.connection` `NetworkInformation` Introductory article: Network Information Tag: Network Information	bug 677166 bug 713199 bug 960426	done	Spec: https://w3c.github.io/netinfo/ MXR: Connection
Notification API	`Notification` Introductory article: Using Web Notifications Tag: Notifications	bug 782211	done	Spec: https://www.w3.org/TR/notifications/ (W3C draft, WHATWG draft) MXR: Notification
Pointer Lock API	`Element.requestPointerLock()` `Document.pointerLockElement` `Document.exitPointerLock()` `MouseEvent` `MouseEvent.movementX` `MouseEvent.movementY` Introductory article: Pointer Lock API Tag: mouse lock	bug 633602	done	Spec: https://www.w3.org/TR/pointerlock/ (the draft is more accurate)
Proximity Events	`DeviceProximityEvent` `UserProximityEvent` `window.ondeviceproximity` `window.onuserproximity` `deviceproximity` event `userproximity` event Introductory article: Proximity API Tag: Proximity	bug 738131	done	Still needs some review here and there but it shouldn't be really troublesome. Spec: https://www.w3.org/TR/proximity/ (the draft is more accurate)
Screen Orientation	`Screen.orientation` `Screen.lockOrientation()` `Screen.unlockOrientation()` `Screen.onorientationchange` `orientationchange` event Introductory article: Managing screen orientation Tag: Screen Orientation	bug 720794 bug 740188 bug 673922	done	Spec: https://www.w3.org/TR/screen-orientation/ MXR: Screen WikiMo: ScreenOrientation
Simple Push Notification API	`window.navigator.push` `PushManager` Introductory article: Simple Push API Tag: Simple Push API	bug 831816 bug 822712 --- See also : bug 747907 bug 763198	done	Simpler push API for B2G. It seams it completely replace the original Push API (see bug 776501) Spec: https://dvcs.w3.org/hg/push/raw-file/default/index.html WikiMo: SimplePush
URL API	`URL` `URL()` `URL.createObjectURL()` `URL.revokeObjectURL()` `URLUtils` `URLUtils.protocol` `URLUtils.host` `URLUtils.hostname` `URLUtils.port` `URLUtils.pathname` `URLUtils.search` `URLUtils.hash` `URLUtils.username` `URLUtils.password` `URLUtils.origin` `URLUtils.toString()` `URLUtilsReadOnly` `URLUtilsReadOnly.protocol` `URLUtilsReadOnly.host` `URLUtilsReadOnly.hostname` `URLUtilsReadOnly.port` `URLUtilsReadOnly.pathname` `URLUtilsReadOnly.search` `URLUtilsReadOnly.hash` `URLUtilsReadOnly.toString()` `Location` (adaptation) `WorkerLocation` (adaptation) `HTMLAnchorElement` (adaptation) `HTMLAreaElement` (adaptation) `URLQuery` <--- not yet landed!! Introductory article: none, pretty obvious Tag: URL API	bug 813253 bug 887364 bug 828261 bug 839912 bug 887836 (URLQuery)	done	Spec: https://url.spec.whatwg.org/
Vibration API	`Navigator.vibrate()` Introductory article: Vibration Tag: Vibration	bug 679966	done	Spec: https://www.w3.org/TR/vibration/
Web activities	`MozActivity` `MozActivityOptions` `MozActivityRequestHandler` `window.navigator.mozSetMessageHandler()` `window.navigator.mozHasPendingMessage()` Introductory article: Web Activities Tag: Web Activities Postponed API: ~~`MozActivityHandlerDescription`~~ ~~`window.navigator.mozRegisterActivityHandler()`~~ ~~`window.navigator.mozUnregisterActivityHandler()`~~ ~~`window.navigator.mozIsActivityHandlerRegistered()`~~	bug 715814, bug 776027 for Android Si also bug 755245	done	Technical review performed by Mounir Lamouri Needs editorial review Discuss the API with Vivien. MXR: Activity, ActivityOptions, ActivityHandlerDescription, ActivityRequestHandler, NavigatorActivities, NavigatorSystemMessages WikiMo: WebActivities Started some app pair. It doesn't work (on FirefoxOS simulator), don't know why exactly. Asked for some help. Not conclusive yet
WebFM API	`navigator.mozFMRadio` `FMRadio` Introductory article: WebFM API Tag: WebFM	bug 749053 bug 779500	done	The events name still need to be documented but as they have nothing special it's not a high priority. MXR: FMRadio
WebPayment	`navigator.mozPay()` Introductary article: In-app payment Tag: Web Payment	bug 767818	done	Maybe we could write something on How to sign a JWT server side. WikiMo: WebPayment

Privileged APIs

API Name	Entry Points	Bugs	Doc status	Notes
Browser API	Introductory article: Using the Browser API Extentions to iframe: `HTMLIFrameElement.reload` `HTMLIFrameElement.stop` `HTMLIFrameElement.getCanGoBack` `HTMLIFrameElement.goBack` `HTMLIFrameElement.getCanGoForward` `HTMLIFrameElement.goForward` `HTMLIFrameElement.setVisible` `HTMLIFrameElement.getVisible` `HTMLIFrameElement.purgeHistory` `HTMLIFrameElement.sendMouseEvent` `HTMLIFrameElement.sendTouchEvent` `HTMLIFrameElement.addNextPaintListener` `HTMLIFrameElement.removeNextPaintListener` `HTMLIFrameElement.getScreenshot` Events `mozbrowserasyncscroll` `mozbrowserclose` `mozbrowsercontextmenu` `mozbrowsererror` `mozbrowsericonchange` `mozbrowserloadend` `mozbrowserloadstart` `mozbrowserlocationchange` `mozbrowseropenwindow` `mozbrowsersecuritychange` `mozbrowsershowmodalprompt` `mozbrowsertitlechange` `mozbrowserusernameandpasswordrequired` Tag: Browser	bug 693515	Done	Still need editorial and technical reviews WikiMo: BrowserAPI
Contacts API	`window.navigator.mozContacts` `mozContact` `ContactManager` `MozContactChangeEvent` Introductory article: Contacts API Tag: Contact	bug 674720	done	Needs a quick technical review Spec: https://www.w3.org/TR/contacts-manager-api/ MXR: ContactManager, ContactProperties, ContactChangeEvent WikiMo: ContactsAPI Also see the intern presentation on Mozilla Air.
Device Storage API	`navigator.getDeviceStorages()` `navigator.getDeviceStorage()` `DeviceStorage` `DeviceStorageChangeEvent` Introductory article: Device Storage Tag: Device Storage	bug 717103	Done	`getDeviceStorages` needs some investigation but it doesn't look urgente. Technical review asked to Doug Turner. MXR: DeviceStorage WikiMo: DeviceStorageAPI
TCP Socket API	`navigator.mozTCPSocket` `TCPSocket` `TCPServerSocket` Introductory article: TCP Socket API Tag: TCP Socket	(FxOS 1.0) bug 733573 ------------ (FxOS 1.2) bug 797561 bug 784816	done	Still needs review. MXR: TCPSocket

Certified APIs

API Name	Entry Points	Bugs	Doc status	Notes
Camera API	`navigator.mozCameras` `CameraManager` `CameraControl` `CameraCapabilities` Tag: camera		done	Tech review perform by Mike Habicher Properties need an editorial review Maybe needs an introductory article. ML: Discussion thread MXR: CameraManager
Idle API	`navigator.addIdleObserver` `navigator.removeIdleObserver` Introductory article: Idle API Tag: Idle	bug 715041	done	Needs editorial review. Spec: Not yet (part of sysapps) WikiMo: IdleAPI
Network Stats API	`navigator.mozNetworkStats` `MozNetworkStats` `MozNetworkStatsData` `MozNetworkStatsManager` Introductory article: Network stats Tag: Network Stats	bug 746069	done	MXR: NetworkStats, NetworkStatsManager
Permissions API	`navigator.mozPermissionSettings` `PermissionSettings` Introductory article: Permissions API	bug 707625 bug 770731	done	MXR: PermissionSettings
Power Management API	`navigator.mozPower` `PowerManager` `navigator.requestWakeLock` Introductory article: Power Management Tag: Power Management	bug 708964	done	Tech review perform by Justin Lebar. Needs an editorial review MXR: PowerManager WikiMo: PowerManagementAPI
Settings API	`navigator.mozSettings` `SettingsManager` `SettingsLock` `MozSettingsEvent` Introductory article: Settings API Tag: Settings	bug 678695	done	Tech review perform by Gregor Wagner Needs editorial review MXR: SettingsManager WikiMo: SettingsAPI
Time/Clock API	`navigator.mozTime` `MozTimeManager` `window.onmoztimechange` `moztimechange` event Introductory article: Time and Clock Tag: Time	bug 714357, bug 714358 (notification upon time change)	done	The `moztimechange` event still need to be documented but as it has nothing special it's not a high priority. MXR: TimeManager
WebBluetooth	`window.navigator.mozBluetooth` `BluetoothManager` `BluetoothAdapter` `BluetoothDevice` `BluetoothDeviceEvent` `BluetoothStatusChangedEvent` Introductory article: WebBluetooth Tag: Web Bluetooth	bug 674737	Done	Technical review ask to Eric Chou The introductory article only conver pairing, therefor it serously need to be improved. However, the API should be rework for Firefox 1.4 so maybe it is wise to delay until that. MXR: bluetooth WikiMo: WebBluetooth
WebSMS	`navigator.mozMobileMessage` `MozSmsMessage` `MozSmsEvent` `MozSmsFilter` `MozSmsSegmentInfo` `MozMobileMessageManager` `MozMmsMessage` `MozMmsEvent` `MozMobileMessageThread` Introductory article: WebSMS Deprecated: `navigator.mozSms` `MozSmsManager` Tag: WebSMS	bug 674725 --- bug 903403	Done	Spec: Messaging API (Editor's draft) WikiMo: WebSMS
WebTelephony	`navigator.mozTelephony` `Telephony` `TelephonyCall` `CallEvent` Introductory article: WebTelephony, introduction to WebTelephony and Using the Telephony API Tag: Telephony	bug 674726	done	The Introduction to WebTelephony and Using the Telephony API articles need to be seriously reworked. WikiMo: WebTelephony
WiFi Information API	`navigator.mozWifiManager` `WifiManager` `MozWifiConnectionInfoEvent` `MozWifiStatusChangeEvent` Introductory article: Wifi Information API Tag: WiFi?	bug 717123 bug 864932	done	MXR: dom/wifi

Discontinued APIs

API Name	Entry Points	Bugs	Doc status	Notes
Archive API		bug 772434	none	Discuss the API with Mounir Lamouri: this API is not active by default in any build and there is discussion to figure if it must be kept or not. MXR: ArchiveReader, ArchiveRequest, Tests WikiMo: ArchiveAPI

Document status overview

Section	Pages	No tags	Needs* tags	Editorial reviews	Technical reviews	Outdated pages	Dev-doc-needed bugs	Documentation requests
API: CSSOM	111	n/a	58 (53%)	3 (3%)	12 (11%)	0 (0%)	6 (6%)	3 (3%)
API: Canvas	127	n/a	0 (0%)	0 (0%)	1 (1%)	19 (15%)	0 (0%)	0 (0%)
API: DOM	746	n/a	97 (14%)	94 (13%)	183 (25%)	8 (2%)	202 (28%)	13 (2%)
API: Device API	80	n/a	36 (45%)	1 (2%)	3 (4%)	0 (0%)	64 (80%)	4 (5%)
API: File API	33	n/a	2 (7%)	0 (0%)	1 (4%)	1 (4%)	n/a	1 (4%)
API: Firefox OS APIs	659	n/a	9 (2%)	37 (6%)	221 (34%)	5 (1%)	n/a	n/a
API: HTML API	313	n/a	160 (52%)	2 (1%)	18 (6%)	20 (7%)	66 (22%)	5 (2%)
API: IndexedDB	110	n/a	3 (3%)	3 (3%)	5 (5%)	0 (0%)	3 (3%)	1 (1%)
API: SVG API	82	n/a	78 (96%)	0 (0%)	1 (2%)	0 (0%)	n/a	1 (2%)
API: ServiceWorkers	99	n/a	7 (8%)	10 (11%)	59 (60%)	0 (0%)	7 (8%)	n/a
API: Web Animations	15	n/a	1 (7%)	0 (0%)	0 (0%)	0 (0%)	7 (47%)	0 (0%)
API: WebAudio	153	n/a	2 (2%)	2 (2%)	47 (31%)	1 (1%)	5 (4%)	0 (0%)
API: WebGL	143	n/a	8 (6%)	0 (0%)	0 (0%)	0 (0%)	35 (25%)	n/a
API: WebRTC	96	n/a	3 (4%)	5 (6%)	8 (9%)	0 (0%)	20 (21%)	5 (6%)
API: WebSockets	6	n/a	2 (34%)	0 (0%)	0 (0%)	0 (0%)	8 (134%)	1 (17%)
API: WebSpeech	88	n/a	0 (0%)	0 (0%)	0 (0%)	0 (0%)	n/a	n/a
API: WebVR	39	n/a	0 (0%)	37 (95%)	37 (95%)	0 (0%)	n/a	n/a
API: WebWorkers	35	n/a	1 (3%)	0 (0%)	6 (18%)	0 (0%)	3 (9%)	1 (3%)
Total	2935	0	467	194	602	54	426	35