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.getTag: Notifications |
bug 899574 | Needs update | Not landed yet |
Network APIs
| API Name | Entry Points | Bugs | Doc status | Notes |
|---|---|---|---|---|
| Mobile Connection API | navigator.mozMobileConnectionMozMobileConnectionMozMobileConnectionInfoMozMobileICCInfoMozMobileNetworkInfoMozMobileCFInfoMozMobileCellInfoIntroductory article: Mobile Connection Paused: MozIccManagerMozStkCommandEventTag: 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.indexedDBIndexedDB 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.mozVoicemailMozVoicemailMozVoicemailEventMozVoicemailStatusTag: 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 | Entry Points | 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
Privileged APIs
Certified APIs
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 | 119 | n/a | 57 (48%) | 10 (9%) | 13 (11%) | 37 (32%) | 6 (6%) | 5 (5%) |
| API: Canvas | 127 | n/a | 0 (0%) | 0 (0%) | 2 (2%) | 67 (53%) | 2 (2%) | 0 (0%) |
| API: DOM | 628 | n/a | 117 (19%) | 14 (3%) | 90 (15%) | 194 (31%) | 213 (34%) | 40 (7%) |
| API: Device API | 79 | n/a | 36 (46%) | 1 (2%) | 2 (3%) | 14 (18%) | 64 (82%) | 3 (4%) |
| API: File API | 33 | n/a | 3 (10%) | 2 (7%) | 2 (7%) | 13 (40%) | n/a | 0 (0%) |
| API: Firefox OS APIs | 65 | n/a | 5 (8%) | 1 (2%) | 1 (2%) | 28 (44%) | n/a | n/a |
| API: HTML API | 374 | n/a | 158 (43%) | 5 (2%) | 54 (15%) | 164 (44%) | 71 (19%) | 8 (3%) |
| API: IndexedDB | 104 | n/a | 2 (2%) | 0 (0%) | 3 (3%) | 5 (5%) | 3 (3%) | 5 (5%) |
| API: SVG API | 100 | n/a | 94 (94%) | 5 (5%) | 9 (9%) | 18 (18%) | n/a | 4 (4%) |
| API: ServiceWorkers | 117 | n/a | 7 (6%) | 2 (2%) | 52 (45%) | 1 (1%) | 0 (0%) | n/a |
| API: Web Animations | 39 | n/a | 0 (0%) | 0 (0%) | 0 (0%) | 0 (0%) | 10 (26%) | 0 (0%) |
| API: WebAudio | 206 | n/a | 5 (3%) | 16 (8%) | 64 (32%) | 10 (5%) | 2 (1%) | 4 (2%) |
| API: WebComponents | 6 | n/a | 0 (0%) | 0 (0%) | 3 (50%) | 3 (50%) | n/a | n/a |
| API: WebCrypto | 20 | n/a | 0 (0%) | 0 (0%) | 1 (5%) | 11 (56%) | n/a | n/a |
| API: WebGL | 273 | n/a | 0 (0%) | 0 (0%) | 0 (0%) | 8 (3%) | 9 (4%) | n/a |
| API: WebRTC | 191 | n/a | 9 (5%) | 2 (2%) | 21 (11%) | 12 (7%) | 20 (11%) | 35 (19%) |
| API: WebSockets | 7 | n/a | 3 (43%) | 0 (0%) | 3 (43%) | 1 (15%) | 8 (115%) | 2 (29%) |
| API: WebSpeech | 88 | n/a | 0 (0%) | 0 (0%) | 0 (0%) | 0 (0%) | n/a | n/a |
| API: WebStorage | 10 | n/a | 0 (0%) | 0 (0%) | 1 (10%) | 6 (60%) | n/a | n/a |
| API: WebVR | 77 | n/a | 0 (0%) | 0 (0%) | 1 (2%) | 0 (0%) | n/a | n/a |
| API: WebWorkers | 38 | n/a | 1 (3%) | 0 (0%) | 5 (14%) | 15 (40%) | 4 (11%) | 5 (14%) |
| Total | 2701 | 0 | 497 | 58 | 327 | 607 | 412 | 111 |