As documentation is moving forward, this page as been reorganized: APIs that are fully documented are pushed at the bottom of the page where 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: bug 772765 Needs extension and update Landed FxOS 1.2 only. Certified Apps only
Network Stats API Tag: bug 858003
bug 858005
bug 887699
Needs update Not landed yet
Notification API Notification.get

Tag:
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: http://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:
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

Dev-doc-needed

View on Bugzilla.

Found 60 bugs.

Bug summary target_milestone
900551 Provide a mechanism to get/set shared background image for privileged apps using mozSettings 2.1 S4 (12sep)
846200 Support for granting the 'settings' permission on a per-permission basis 2.1 S3 (29aug)
878533 WebSMS: Move SmsFilter to WebIDL dictionary 2.1 S3 (29aug)
745283 Expose a client UDP datagram socket API to web applications 2.1 S3 (29aug)
855952 [DeviceStorage] support append file operation on b2g device 2.0 S4 (20june)
983747 [Browser API] Add a method to download a file 2.0 S4 (20june)
814629 [DSDS] WebMobileConnection API: support multiple sim cards 1.3 Sprint 5 - 11/22
814637 WebIccManager API: support multiple sim cards 1.3 Sprint 5 - 11/22
885679 B2G MMS: Add 'subject' to {Thread} object. 1.3 Sprint 4 - 11/8
885701 [DOMRequest] Implement DOMRequestService.fireDetailedError 1.1 QE3 (26jun)
813978 B2G SMS: getMessages cursor is slow when SMS database contains large number of messages B2G C4 (2jan on)
823974 Geolocation should require a manifest entry for apps B2G C4 (2jan on)
778093 B2G RIL: support Cell Broadcast B2G C2 (20nov-10dec)
775997 Message app crashes when run OOP B2G C1 (to 19nov)
856971 WebSMS: s/nsIDOMMozSmsFilter/nsIDOMMozMobileMessageFilter for a generic term ---
805130 Add error codes for validation failures in navigator.mozPay() ---
902565 this.done in cursor callback of naviagtor.getDeviceStorage("sdcard").enumerate is undefined ---
857414 [meta] B2G RIL: Move all icc/sim-related stuff from mozMobileConnection to mozIccManager ---
1036604 Add VRDevice interface and getVRDevices mozilla36
1022193 Add a "forceIdSelection" to navigator.getMobileIdAssertion mozilla33
987954 [Camera][Gecko] Remove last direct JS_*() calls from DOMCameraControl.cpp mozilla32
988469 MSISDN verification API for privileged apps mozilla32
876980 Expose mozAlarms API to installed apps on Firefox desktop mozilla31
960426 Support Network Information API in Firefox OS mozilla31
910412 Change DeviceStorage API to use FileSystem API spec mozilla30
811635 B2G Wifi: Support Wifi Direct mozilla29
858005 B2G Network Stats: Add support to usage alarms mozilla28
876397 Inter-App Communication API mozilla26
903403 [sms][mms] Make getSegmentInfoForText() Asynchronous to Improve Typing Performance mozilla26
772765 B2G telephony: support conference calls mozilla26
850140 B2G MMS: implement MmsService.handleDeliveryIndication() to handle delivery report mozilla25
823958 There is no way to know if navigator.mozTelephony is ready to access calls infos mozilla24
860585 B2G RIL: Move cardLock related API from mozMobileConnection to mozIccManager mozilla24
876936 Alarm API should immediately fire alarms set in the 'past' rather than error. mozilla24
847741 B2G RIL: Move mozContact.getSimContacts to IccManager mozilla23
849739 B2G MMS: provide nsIDOMMobileMessageManager.getThreads() mozilla23
854790 B2G SMS & MMS: support filtering by thread ID mozilla23
843445 B2G MMS: provide nsIDOMMobileMessageManager.retrieveMMS() to retrieve MMS for the deferred retrieval mode mozilla23
858416 Device Storage - Create a composite interface mozilla23
847736 B2G MMS: provide nsIDOMMobileMessageManager.delete() mozilla22
810067 B2G MMS: support automatic/manual/never retrieval modes mozilla22
847738 B2G MMS: provide nsIDOMMobileMessageManager.getMessage() mozilla22
847756 B2G MMS: provide nsIDOMMobileMessageManager.markMessageRead() mozilla22
849741 B2G MMS: provide nsIDOMMobileMessageManager.onreceived event mozilla22
850530 B2G MMS: Use the same attribute name for delivery (s/state/delivery) like SMS mozilla22
840780 (webicc) WebICC - Secure Elements mozilla22
844431 B2G MMS: provide nsIDOMMobileMessageManager interface (with sendMMS() first) mozilla22
834595 Create a device storage api which only returns media state (ready, unavailable, etc..) mozilla21
804754 B2G MMS: support UAProfile in HTTP header mozilla20
811605 B2G RIL: enable ril debugging output in run-time mozilla19
791935 B2G STK: Implement 'MT Call Event', 'Call Connected' and 'Call Disconnected' Envelope commands mozilla18
777665 [b2g-bluetooth] hook up to settings API mozilla18
787420 B2G RIL: add setting for switching between 2G/3G mozilla18
795047 Wifi: Add support for scan_ssid to search for hidden networks mozilla18
715788 Add A-GPS support for gonk mozilla17
736710 Voicemail API based on SMS Message Waiting mozilla17
738528 Android still image support for getUserMedia mozilla16
759637 B2G RIL: Add DOM APIs for automatic and manual network selection mode mozilla16
761482 WebMobileConnection: make {voice|data}.operator an nsIDOMMozMobileOperatorInfo mozilla16
729173 WebMobileConnection mozilla14

Implementation in progress

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

API Name Entry Points Bugs Doc status Notes
AudioChannels   bug 853101
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:
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: http://www.w3.org/TR/web-alarms/
MXR: MozAlarmsManager
WikiMo: AlarmAPI
Ambient Light Events DeviceLightEvent
window.ondevicelight
devicelight event
Introductory article: Using Light Events

Tag:

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: http://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:
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: http://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:

Unimplemented but in the spec
window.oncompassneedscalibration
compassneedscalibration event
bug 615597 done The introductory still need a quick technical review.

Spec: http://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:
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(?): http://dev.w3.org/2006/webapi/FileAPI/ http://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:
  done Editorial review complete.

Spec: http://www.w3.org/TR/geolocation-API/

Maybe add basic examples?
Network Information API NetworkInformation.connection
NetworkInformation
Introductory article: Network Information

Tag:

bug 677166 bug 713199
bug 960426
 

done Spec: http://w3c.github.io/netinfo/
MXR: Connection
Notification API Notification
Introductory article: Using Web Notifications

Tag:
bug 782211 done Spec: http://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:
 
bug 633602 done Spec: http://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:
bug 738131 done Still needs some review here and there but it shouldn't be really troublesome.

Spec: http://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:
bug 720794
bug 740188
bug 673922
done Spec: http://www.w3.org/TR/screen-orientation/
MXR: Screen
WikiMo: ScreenOrientation
Simple Push Notification API window.navigator.push
PushManager
Introductory article: Simple Push API

Tag:
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:
bug 813253
bug 887364
bug 828261
bug 839912
bug 887836 (URLQuery)
done Spec: http://url.spec.whatwg.org/
Vibration API Navigator.vibrate()
Introductory article: Vibration

Tag:
bug 679966 done Spec: http://www.w3.org/TR/vibration/
Web activities MozActivity
MozActivityOptions
MozActivityRequestHandler
window.navigator.mozSetMessageHandler()
window.navigator.mozHasPendingMessage()
Introductory article: Web Activities

Tag:

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:
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:
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:
bug 693515 Done Still need editorial and technical reviews

WikiMo: BrowserAPI
Contacts API window.navigator.mozContacts
mozContact
ContactManager
MozContactChangeEvent
Introductory article: Contacts API

Tag:
bug 674720 done

Needs a quick technical review

Spec: http://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:
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:
(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:
  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:
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:
bug 746069 done MXR: NetworkStatsNetworkStatsManager
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:
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:
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:
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:
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:
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:
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: ?
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 108 n/a 59 (55%) 0 (0%) 7 (7%) 0 (0%) 4 (4%) 1 (1%)
API: Canvas 112 n/a 0 (0%) 0 (0%) 0 (0%) 0 (0%) 0 (0%) 0 (0%)
API: DOM 630 n/a 73 (12%) 0 (0%) 90 (15%) 0 (0%) 178 (29%) 16 (3%)
API: Device API 79 n/a 40 (51%) 0 (0%) 3 (4%) 0 (0%) 60 (76%) 4 (6%)
API: File API 32 n/a 2 (7%) 0 (0%) 0 (0%) 0 (0%) n/a 1 (4%)
API: HTML API 221 n/a 174 (79%) 0 (0%) 21 (10%) 28 (13%) 51 (24%) 0 (0%)
API: IndexedDB 102 n/a 4 (4%) 0 (0%) 62 (61%) 0 (0%) 19 (19%) 0 (0%)
API: SVG API 81 n/a 78 (97%) 0 (0%) 1 (2%) 0 (0%) n/a 0 (0%)
API: WebAudio 149 n/a 2 (2%) 0 (0%) 47 (32%) 0 (0%) 5 (4%) 0 (0%)
API: WebRTC 83 n/a 2 (3%) 0 (0%) 3 (4%) 0 (0%) 12 (15%) 6 (8%)
API: WebSockets 3 n/a 0 (0%) 0 (0%) 0 (0%) 0 (0%) 8 (267%) 4 (134%)
API: WebWorkers 34 n/a 0 (0%) 0 (0%) 6 (18%) 0 (0%) 6 (18%) 3 (9%)
Total 1634 0 434 0 240 28 343 35

See also

Document Tags and Contributors

Last updated by: kscarfone,