Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.
This API is available on Firefox OS for privileged or certified applications only.
The getStructuredData() method of the HTMLIFrameElement interface retrieves any structured microdata (and hCard and hCalendar microformat data) contained in the HTML loaded in the browser <iframe> and returns it as JSON.
Syntax
var instanceOfDOMRequest = instanceOfHTMLIframeElement.getStructuredData();
Returns
A DOMRequest to handle the getStructuredData() request's success and error cases. If the request is successful, the request.result is a JSON object representation of all microdata contained on the page loaded in the browser.
Parameters
None.
Examples
var browser = document.querySelector('iframe');
browser.addEventListener('mozbrowserloadend',function() {
var request = browser.getStructuredData();
request.onsuccess = function() {
console.log(request.result);
}
});
Running this code in a Browser API app and then loading up a page that contains microdata (such as the website of British alt-country band Salter Cane) will result in a JSON object being returned, along the lines of:
{
"items":
[
{
"type":["http://microformats.org/profile/hcard"],
"properties":{"fn":["Chris Askew"],
"n":[
{
"properties":
{
"given-name":["Chris"],
"family-name":["Askew"],
...
Specification
Not part of any specification.
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | Not supported | Not supported | Not supported |
| Feature | Android | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | 2.5 | Not supported | Not supported | Not supported |
Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.
