Documentation status

  • Revision slug: WebAPI/Doc_status
  • Revision title: Documentation status
  • Revision id: 338227
  • Created:
  • Creator: dbruant
  • Is current revision? No
  • Comment

Revision Content

Planned for initial release of B2G (aka Basecamp)

API Bugs Documentation status Notes
Vibration API bug 679966 Needs minor cleanups  
Screen Orientation bug 720794 bug 740188 bug 673922 Mostly done cleanups and syntax highlight needed here and there (and links between lockOrientation and events in a See Also section)
Geolocation API   needs cleanup & compat table Same API since Firefox 3.5
Device Storage API bug 717103 In progress

Need to document Cursor. Need to explain that .get is a convenience method (https://groups.google.com/forum/#!msg/mozilla.dev.webapi/c6-_1vCi6dQ/WcScVdPGO-cJ). Need to explain why FileHandle is different than FileWriter (http://lists.w3.org/Archives/Public/public-webapps/2012JanMar/0886.html)

Oh yeah and... need to test the API also :-) like write app using the thing.

Moving to documenting FileHandle

Mouse Lock API bug 633602 Mostly done some cleanup needed.
Open WebApps bug 697006 Looks done Clean up obselete APIs
Network Information API (W3C) bug 677166 bug 713199 looks done According to the wikimo page, not available for B2G yet
Battery Status API (W3C) bug 678694 Mostly done  
Alarm API bug 749551 drafty Need to update. Needs to put under /WebAPI (instead of the current /API)
Time/Clock API bug 714357, bug 714358 (notification upon time change) none  
Web Activities bug 715814 bug 776027 for Android blocked Started some app pair. It doesn't work (on FirefoxOS simulator), don't know why exactly. Asked for some help. Not conclusive yet
Push Notifications API bug 747907 none Looks complex. Client-side API may be in flux. According to the wikimo page, not available for B2G yet
WebFM API bug 749053 none Will need to fight a bit against the Google grou post (or the bug?) to figure out the API
FileHandle API bug 726593 none wikimo page explains why it's different than filewriter (some more web cruft?). According to the wikimo page, not available for B2G yet
Network Stats API ([1] & [2]) bug 746069 XPCOM is there, but that's pretty much it (so, close to none) According to the wikimo page, not available for B2G yet
WebPayment bug 767818 none long and complicated, security implications. Take the time to write it (maybe first thing)
IndexedDB (W3C) bug 553412 Almost done Janet's working on that IIRC
Archive API bug 772434 none Ready to be doc'ed
Ambient light sensor bug 738465 Done as far as I can tell  
Proximity sensor ([1] [2]) bug 738131 Looks done  

Certified apps doc

API Bugs Documentation status Notes
WebTelephony bug 674726 Mostly done The introduction page really deserves to be fleshed out more to be an actual introduction
WebSMS bug 674725 Mostly done Needs some cleanups and a proper introduction
Idle API bug 715041 none  
Settings API bug 678695 none Privileged API
Power Management API bug 708964 none  
Mobile Connection API bug 729173 none  
TCP Socket API bug 733573 none What's the reference?
WiFi Information API   none https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/7ZgMQiYcX0o WTF
Contacts API bug 674720 none big piece apparently
WebBluetooth bug 674737 none Not implemented. Immature API
Browser API bug 693515 none Ref Not sure it's high priority I assume since few people will want to write a browser or browser-like app.
Permissions API bug 707625 none Actual bug https://bugzilla.mozilla.org/show_bug.cgi?id=770731

See also

Revision Source

<h2 id="Planned_for_initial_release_of_B2G_(aka_Basecamp)">Planned for initial release of B2G (aka Basecamp)</h2>
<table border="1" cellpadding="2">
  <tbody>
    <tr>
      <th>API</th>
      <th>Bugs</th>
      <th>Documentation status</th>
      <th>Notes</th>
    </tr>
    <tr>
      <td><a class="external text" href="/en-US/docs/DOM/window.navigator.vibrate" rel="nofollow">Vibration API</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=679966" rel="nofollow">bug 679966</a></td>
      <td>Needs minor cleanups</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/DOM/window.screen.lockOrientation" title="/en-US/docs/DOM/window.screen.lockOrientation">Screen Orientation</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=720794" rel="nofollow">bug 720794</a> <a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=740188" rel="nofollow">bug 740188</a> <a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=673922" rel="nofollow">bug 673922</a></td>
      <td>Mostly done</td>
      <td>cleanups and syntax highlight needed here and there (and links between lockOrientation and events in a See Also section)</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/Using_geolocation" title="/en-US/docs/Using_geolocation">Geolocation API</a></td>
      <td>&nbsp;</td>
      <td>needs cleanup &amp; compat table</td>
      <td>Same API since Firefox 3.5</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/WebAPI/Device_Storage_API" title="/en-US/docs/WebAPI/Device_Storage_API">Device Storage API</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=717103" rel="nofollow">bug 717103</a></td>
      <td>In progress</td>
      <td>
        <p>Need to document Cursor. Need to explain that <code>.get</code> is a convenience method (https://groups.google.com/forum/#!msg/mozilla.dev.webapi/c6-_1vCi6dQ/WcScVdPGO-cJ). Need to explain why FileHandle is different than FileWriter (http://lists.w3.org/Archives/Public/public-webapps/2012JanMar/0886.html)</p>
        <p>Oh yeah and... need to test the API also :-) like write app using the thing.</p>
        <p>Moving to documenting FileHandle</p>
      </td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/API/Pointer_Lock_API" title="/en-US/docs/API/Pointer_Lock_API"><span class="external text">Mouse Lock API</span></a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=633602" rel="nofollow">bug 633602</a></td>
      <td>Mostly done</td>
      <td>some cleanup needed.</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/Apps/Apps_JavaScript_API" title="/en-US/docs/Apps/Apps_JavaScript_API"><span class="external text">Open WebApps</span></a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=697006" rel="nofollow">bug 697006</a></td>
      <td>Looks done</td>
      <td>Clean up obselete APIs</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/DOM/window.navigator.connection" title="/en-US/docs/DOM/window.navigator.connection"><span class="external text">Network Information API</span> (W3C)</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=677166" rel="nofollow">bug 677166</a> <a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=713199" rel="nofollow">bug 713199</a></td>
      <td>looks done</td>
      <td>According to the wikimo page, not available for B2G yet</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/DOM/window.navigator.battery" title="/en-US/docs/DOM/window.navigator.battery"><span class="external text">Battery Status API</span> (W3C)</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=678694" rel="nofollow">bug 678694</a></td>
      <td>Mostly done</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/API/Alarm_API" title="/en-US/docs/API/Alarm_API">Alarm API</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=749551" rel="nofollow">bug 749551</a></td>
      <td>drafty</td>
      <td>Need to update. Needs to put under /WebAPI (instead of the current /API)</td>
    </tr>
    <tr>
      <td>Time/Clock API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=714357" rel="nofollow">bug 714357</a>, <a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=714358" rel="nofollow">bug 714358</a> (notification upon time change)</td>
      <td>none</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/WebAPI/Web_Activities" title="/en-US/docs/WebAPI/Web_Activities">Web Activities</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=715814" rel="nofollow">bug 715814</a> <a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=776027" rel="nofollow">bug 776027</a> for Android</td>
      <td>blocked</td>
      <td><a href="https://github.com/DavidBruant/MozApps/tree/locally" title="https://github.com/DavidBruant/MozApps/tree/locally">Started some app pair.</a> It doesn't work (on FirefoxOS simulator), don't know why exactly. <a href="https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/bqLecX0eDAE" title="https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/bqLecX0eDAE">Asked for some help</a>. Not conclusive yet</td>
    </tr>
    <tr>
      <td>Push Notifications API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=747907" rel="nofollow">bug 747907</a></td>
      <td>none</td>
      <td>Looks complex. Client-side API may be in flux. According to the wikimo page, not available for B2G yet</td>
    </tr>
    <tr>
      <td><span class="external text">WebFM API</span></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=749053" rel="nofollow">bug 749053</a></td>
      <td>none</td>
      <td>Will need to fight a bit against the Google grou post (or the bug?) to figure out the API</td>
    </tr>
    <tr>
      <td>FileHandle API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=726593" rel="nofollow">bug 726593</a></td>
      <td>none</td>
      <td>wikimo page explains why it's different than filewriter (some more web cruft?). According to the wikimo page, not available for B2G yet</td>
    </tr>
    <tr>
      <td>Network Stats API (<a href="/en-US/docs/XPCOM_Interface_Reference/nsIDOMMozNetworkStatsManager" title="/en-US/docs/XPCOM_Interface_Reference/nsIDOMMozNetworkStatsManager">[1]</a> &amp; <a href="/en-US/docs/XPCOM_Interface_Reference/nsIDOMMozNetworkStatsData" title="/en-US/docs/XPCOM_Interface_Reference/nsIDOMMozNetworkStatsData">[2]</a>)</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=746069" rel="nofollow">bug 746069</a></td>
      <td>XPCOM is there, but that's pretty much it (so, close to none)</td>
      <td>According to the wikimo page, not available for B2G yet</td>
    </tr>
    <tr>
      <td>WebPayment</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=767818" rel="nofollow">bug 767818</a></td>
      <td>none</td>
      <td>long and complicated, security implications. Take the time to write it (maybe first thing)</td>
    </tr>
    <tr>
      <td><span class="external text">IndexedDB</span> (W3C)</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=553412" rel="nofollow">bug 553412</a></td>
      <td>Almost done</td>
      <td>Janet's working on that IIRC</td>
    </tr>
    <tr>
      <td>Archive API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=772434" rel="nofollow">bug 772434</a></td>
      <td>none</td>
      <td>Ready to be doc'ed</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/DOM/DeviceLightEvent" title="/en-US/docs/DOM/DeviceLightEvent"><span class="external text">Ambient light sensor</span></a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=738465" rel="nofollow">bug 738465</a></td>
      <td>Done as far as I can tell</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><span class="external text">Proximity sensor</span> (<a href="/en-US/docs/DOM/DeviceProximityEvent" title="/en-US/docs/DOM/DeviceProximityEvent">[1]</a> <a href="/en-US/docs/DOM/UserProximityEvent" title="/en-US/docs/DOM/UserProximityEvent">[2]</a>)</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=738131" rel="nofollow">bug 738131</a></td>
      <td>Looks done</td>
      <td>&nbsp;</td>
    </tr>
  </tbody>
</table>
<h2 id="Certified_apps_doc">Certified apps doc</h2>
<table border="1" cellpadding="2">
  <tbody>
    <tr>
      <th>API</th>
      <th>Bugs</th>
      <th>Documentation status</th>
      <th>Notes</th>
    </tr>
    <tr>
      <td><a href="https://developer.mozilla.org/en-US/docs/API/WebTelephony" title="WebAPI/WebTelephony">WebTelephony</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=674726" rel="nofollow">bug 674726</a></td>
      <td>Mostly done</td>
      <td>The <a href="https://developer.mozilla.org/en-US/docs/API/WebTelephony/Introduction_to_WebTelephony" title="https://developer.mozilla.org/en-US/docs/API/WebTelephony/Introduction_to_WebTelephony">introduction</a> page really deserves to be fleshed out more to be an actual introduction</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/API/WebSMS" title="/en-US/docs/API/WebSMS">WebSMS</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=674725" rel="nofollow">bug 674725</a></td>
      <td>Mostly done</td>
      <td>Needs some cleanups and a proper introduction</td>
    </tr>
    <tr>
      <td>Idle API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=715041" rel="nofollow">bug 715041</a></td>
      <td>none</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td>Settings API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=678695" rel="nofollow">bug 678695</a></td>
      <td>none</td>
      <td>Privileged API</td>
    </tr>
    <tr>
      <td>Power Management API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=708964" rel="nofollow">bug 708964</a></td>
      <td>none</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><a href="/en-US/docs/DOM/window.navigator.connection" title="/en-US/docs/DOM/window.navigator.connection">Mobile Connection API</a></td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=729173" rel="nofollow">bug 729173</a></td>
      <td>none</td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td>TCP Socket API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=733573" rel="nofollow">bug 733573</a></td>
      <td>none</td>
      <td>What's the reference?</td>
    </tr>
    <tr>
      <td><span class="external text">WiFi Information API</span></td>
      <td>&nbsp;</td>
      <td>none</td>
      <td><a href="https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/7ZgMQiYcX0o" title="https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/7ZgMQiYcX0o">https://groups.google.com/forum/?fromgroups=#!topic/mozilla.dev.webapi/7ZgMQiYcX0o</a> WTF</td>
    </tr>
    <tr>
      <td>Contacts API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=674720" rel="nofollow">bug 674720</a></td>
      <td>none</td>
      <td>big piece apparently</td>
    </tr>
    <tr>
      <td>WebBluetooth</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=674737" rel="nofollow">bug 674737</a></td>
      <td>none</td>
      <td>Not implemented. Immature API</td>
    </tr>
    <tr>
      <td>Browser API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=693515" rel="nofollow">bug 693515</a></td>
      <td>none</td>
      <td><a href="https://wiki.mozilla.org/WebAPI/EmbeddedBrowserAPI" title="https://wiki.mozilla.org/WebAPI/EmbeddedBrowserAPI">Ref</a> Not sure it's high priority I assume since few people will want to write a browser or browser-like app.</td>
    </tr>
    <tr>
      <td>Permissions API</td>
      <td><a class="external text" href="https://bugzilla.mozilla.org/show_bug.cgi?id=707625" rel="nofollow">bug 707625</a></td>
      <td>none</td>
      <td>Actual bug https://bugzilla.mozilla.org/show_bug.cgi?id=770731</td>
    </tr>
  </tbody>
</table>
<h2 id="See_also">See also</h2>
<ul>
  <li><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=673923" title="https://bugzilla.mozilla.org/show_bug.cgi?id=673923">Meta bug on Bugzilla</a></li>
  <li><a href="https://wiki.mozilla.org/WebAPI" title="https://wiki.mozilla.org/WebAPI">https://wiki.mozilla.org/WebAPI</a></li>
  <li><a href="https://developer.mozilla.org/en-US/docs/Project:Subject-matter_experts" title="https://developer.mozilla.org/en-US/docs/Project:Subject-matter_experts">Subject experts</a></li>
  <li><a href="https://github.com/mozilla-b2g/gaia" title="https://github.com/mozilla-b2g/gaia">Some app examples in Gaia</a></li>
  <li><a href="https://docs.google.com/spreadsheet/ccc?key=0AiBigu584YY7dGlNSlY0QzhJb3M5anRBa1gxalV0Y3c#gid=13" title="https://docs.google.com/spreadsheet/ccc?key=0AiBigu584YY7dGlNSlY0QzhJb3M5anRBa1gxalV0Y3c#gid=13">Milestone document</a></li>
  <li><a href="https://docs.google.com/spreadsheet/ccc?key=0Akyz_Bqjgf5pdENVekxYRjBTX0dCXzItMnRyUU1RQ0E#gid=0" title="https://docs.google.com/spreadsheet/ccc?key=0Akyz_Bqjgf5pdENVekxYRjBTX0dCXzItMnRyUU1RQ0E#gid=0">Permissions</a></li>
  <li><a href="https://etherpad.mozilla.org/gaia-activities-audit" title="https://etherpad.mozilla.org/gaia-activities-audit">Gaia Web Activities Audit</a></li>
  <li><a href="https://wiki.mozilla.org/Gaia/System/Activities" title="https://wiki.mozilla.org/Gaia/System/Activities">Gaia/System/Activities</a></li>
</ul>
Revert to this revision