WebAPIs & Apps - Mozilla London

FIREFOX OS WebAPIs & Apps

@robertnyman

Using HTML5, CSS andJavaScript together with anumber of APIs to build appsand customize the UI.

https://addons.mozilla.org/firefox/addon/firefox-os- simulator/

Droid@Screenhttp://blog.ribomation.com/droid-at-screen/

Open Web Apps

Web apps are apps built using standard Web technologies. They work in any modern Web browser.The Open Web apps project proposes some small additions to existing sites to turn them into apps. These apps run on desktop browsers and mobile devices.

https://developer.mozilla.org/docs/Apps/ Getting_Started

Steps to Take

Develop Web App using1. HTML5, CSS, & Javascript2. Create an app manifest ﬁle3. Publish/install the app

1.Develop Web App usingHTML5, CSS & JavaScript

Reuse any existing web site/app or develop from scratch with open web standards. Utilize HTML5 features such as localStorage, oﬄine manifest, IndexedDB and access Web APIs for more options. Responsive web design for adapting to varying resolutions and screen orientation.

2.Create an app manifest ﬁle

Create a ﬁle with a .webapp extension

{ "version": "1.0", "name": "MozillaBall", "description": "Exciting Open Web development action!", "icons": { "16": "/img/icon-16.png", "48": "/img/icon-48.png", "128": "/img/icon-128.png" }, "developer": { "name": "Mozilla Labs", "url": "http://mozillalabs.com" }, "installs_allowed_from": ["*"], "appcache_path": "/cache.manifest", "locales": { "es": { "description": "¡Acción abierta emocionante del desarrollo del Web!", "developer": { "url": "http://es.mozillalabs.com/" } }, "it": { "description": "Azione aperta emozionante di sviluppo difotoricettore!", "developer": { "url": "http://it.mozillalabs.com/" } } }, "default_locale": "en"}

MANIFEST CHECKER http://appmanifest.org/

Serve with Content-type/MIME type:application/x-web-app-manifest+json

Apache - in mime.types:application/x-web-app-manifest+json webappApache - in .htaccess:AddType application/x-web-app-manifest+json webappNGinx - in mime.types:types { text/html html htm shtml; text/css css; text/xml xml; application/x-web-app-manifest+jsonwebapp;}

IIS:In IIS Manager, right-click the localcomputer, and click Properties.Click the MIME Types button.Click New.In the Extension box, type the file nameextension.In the MIME type box, type a descriptionthat exactly matches the file type definedon the computer.Click OK.

curl -I http://mozillalabs.com/manifest.webapp

3.Publish/install the app

Firefox Marketplace

https://marketplace.firefox.com/

https://marketplace.firefox.com/developers/

Installing/hosting the app

var request = navigator.mozApps.install( "http://mozillalabs.com/MozillaBall.webapp", { user_id: "some_user" });request.onsuccess = function() { // Success! Notiﬁcation, launch page etc}request.onerror = function() { // Failed. this.error.name has details}

var request = navigator.mozApps.installPackage( "http://mozillalabs.com/manifest.webapp");request.onsuccess = function() { // Success!}request.onerror = function() { // Failed.}

Packaged vs. Hosted Apps

A packaged app is an Open Web App that has all of its resources(HTML, CSS, JavaScript, app manifest, and so on) contained in a zip ﬁle, instead of having its resources on a Web server.A packaged app is simply a zip ﬁle with the app manifest in its root directory. The manifest must be named manifest.webapp.

Can be privileged apps with more API access than hosted appsSpecial protocol internal to the zip file: app://<uuid>Manifest file must be named manifest.webappResources are accessed from the zip file, which is stored on the device where theapp is installedInstalled with a different mozApps API function: installPackage()Enforce a specific Content Security Policy for all application contentCan embed remote content in iframes, but that content will not have access toprivileged APIs nor will it have the default CSP applied to itHave an update process for getting new versions of the app to users. Hostedapps do not need this process.

https://developer.mozilla.org/docs/Apps/ For_Web_developers

WebAPIs

The Mozilla WebAPI team is pushing theenvelope of the web to include --- and in placesexceed --- the capabilities of competing stacks.

https://wiki.mozilla.org/WebAPI

Security Levels

Granted by default Granted by authorized storeSafe web APIs that don’t expose privacy Privacy and security sensitive APIs suchsensitive data. WebGL, fullscreen, as Contacts APIaudio, etc. Verified by signatureGranted by user Highly privileged APIs such as radiolocation, camera, file system access access (dialer)Granted when installedNo quota for localStorage, IndexedDB,offline cache

Web Content Certiﬁed Web AppRegular web content Device-critical applicationsInstalled Web AppA regular web appPrivileged Web AppMore access, more responsibility

https://wiki.mozilla.org/WebAPI#Planned_for_initial_release_of_B2G_. 28aka_Basecamp.29

"permissions": { "contacts": { "description": "Required for autocompletion in the share screen", "access": "readcreate" }, "alarms": { "description": "Required to schedule notifications" }}

AlarmAPI FMRadioBrowserAPI geolocationContacts systemXHRdevice-storage:music/device-storage:videos/ TCP Socket APIdevice-storage:pictures/device-storage:sdcard: wake-lock-screen Add, read, or modify ﬁles stored at a central location on the device. access property required: one of readonly, readwrite, readcreate, or createonly. NEED PERMISSION

Vibration API (W3C) Web ActivitiesScreen Orientation Push Notiﬁcations APIGeolocation API WebFM APIMouse Lock API (W3C) WebPaymentOpen WebApps IndexedDB (W3C)Network Information API (W3C) Ambient light sensorBattery Status API (W3C) Proximity sensorAlarm API Notiﬁcation REGULAR APIS

BATTERY STATUSAPI

var battery = navigator.battery;if (battery) { var batteryLevel = Math.round(battery.level * 100) + "%", charging = (battery.charging)? "" : "not ", chargingTime = parseInt(battery.chargingTime / 60, 10, dischargingTime = parseInt(battery.dischargingTime / 60, 10); // Set events battery.addEventListener("levelchange", setStatus, false); battery.addEventListener("chargingchange", setStatus, false); battery.addEventListener("chargingtimechange", setStatus, false); battery.addEventListener("dischargingtimechange", setStatus, false);}

NOTIFICATION

var notification = navigator.mozNotification;notification.createNotification( "See this", "This is a notification", iconURL);

SCREENORIENTATION API

// Portrait mode:screen.mozLockOrientation("portrait");/* Possible values: "landscape" "portrait" "landscape-primary" "landscape-secondary" "portrait-primary" "portrait-secondary"*/

VIBRATION API

// Vibrate for one secondnavigator.vibrate(1000);// Vibration pattern [vibrationTime, pause,…]navigator.vibrate([200, 100, 200, 100]);// Vibrate for 5 secondsnavigator.vibrate(5000);// Turn off vibrationnavigator.vibrate(0);

WEB PAYMENTS

var pay = navigator.mozPay(paymentToken);pay.onsuccess = function (event) { // Weee! Money!};

NETWORKINFORMATION API

var connection = window.navigator.mozConnection, online = connection.bandwidth > 0, metered = connection.metered;

ALARM API

var alarmId1, request = navigator.mozAlarms.add( new Date("May 15, 2012 16:20:00"), "honorTimezone", { mydata: "my event" } );request.onsuccess = function (event) { alarmId1 = event.target.result;};request.onerror = function (event) { console.log(event.target.error.name);};

var request = navigator.mozAlarms.getAll();request.onsuccess = function (event) { console.log(JSON.stringify(event.target.result));};request.onerror = function (event) { console.log(event.target.error.name);};

navigator.mozAlarms.remove(alarmId1);

navigator.mozSetMessageHandler( "alarm", function (message) { // Note: message has to be set in the manifest file console.log("Alarm fired: " + JSON.stringify(message)); });

{ "messages": ["alarm"]}

DEVICEPROXIMITY

window.addEventListener("deviceproximity", function (event) { // Current device proximity, in centimeters console.log(event.value); // The maximum sensing distance the sensor is // able to report, in centimeters console.log(event.max); // The minimum sensing distance the sensor is // able to report, in centimeters console.log(event.min);});

AMBIENT LIGHTEVENTS

window.addEventListener("devicelight", function (event) { // The level of the ambient light in lux console.log(event.value);});

window.addEventListener("lightlevel", function (event) { // Possible values: "normal", "bright", "dim" console.log(event.value);});

window.addEventListener("devicelight", function (event) { // The lux values for "dim" typically begin below 50, // and the values for "bright" begin above 10000 console.log(event.value);});

Device Storage APIBrowser APITCP Socket APIContacts APIsystemXHR PRIVILEGED APIS

DEVICE STORAGEAPI

var deviceStorage = navigator.getDeviceStorage("videos");

// "external", "shared", or "default".deviceStorage.type;// Add a file - returns DOMRequest with file namedeviceStorage.add(blob);// Same as .add, with provided namedeviceStorage.addNamed(blob, name);// Returns DOMRequest/non-editable File objectdeviceStorage.get(name);// Returns editable FileHandle objectdeviceStorage.getEditable(name);// Returns DOMRequest with success or failuredeviceStorage.delete(name);// Enumerates filesdeviceStorage.enumerate([directory]);// Enumerates files as FileHandlesdeviceStorage.enumerateEditable([directory]);

CONTACTS API

WebTelephony WebBluetoothWebSMS Permissions APIIdle API Network Stats APISettings API Camera APIPower Management API Time/Clock APIMobile Connection API Attention screenWiFi Information API Voicemail CERTIFIED APIS

WEBTELEPHONY

// Telephony objectvar tel = navigator.mozTelephony;// Check if the phone is muted (read/write property)console.log(tel.muted);// Check if the speaker is enabled (read/write property)console.log(tel.speakerEnabled);

// Place a callvar cal = tel.dial(“123456789”);

// Receiving a calltel.onincoming = function (event) { var incomingCall = event.call; // Get the number of the incoming call console.log(incomingCall.number); // Answer the call incomingCall.answer();};// Disconnect a callcall.hangUp();// Iterating over calls, and taking action depending on theirchanged statustel.oncallschanged = function (event) { tel.calls.forEach(function (call) { // Log the state of each call console.log(call.state); });};

WEBSMS

// SMS objectvar sms = navigator.mozSMS;// Send a messagesms.send("123456789", "Hello world!");

// Recieve a messagesms.onreceived = function (event) { // Read message console.log(event.message);};

WEB ACTIVITIES

{ "activities": { "share": { "filters": { type: ["image/png", "image/gif"], } "href": "sharing.html", "disposition": "window" } }}

var register = navigator.mozRegisterActivityHandler({ name: "view", disposition: "inline", filters: { type: "image/png" }});register.onerror = function () { console.log("Failed to register activity");}

navigator.mozSetMessageHandler("activity", function (a) { var img = getImageObject(); img.src = a.source.url; // Call a.postResult() or a.postError() if // the activity should return a value});

Future APIs

Resource lock API Spellcheck APIUDP Datagram Socket API LogAPIPeer to Peer API Keyboard/IME APIWebNFC WebRTCWebUSB FileHandle APIHTTP-cache API Sync APICalendar API

Web Apps from Mozilla

Dialer Alarm ClockContacts CameraSettings NotesSMS First Run ExperienceWeb browser NotiﬁcationsGallery Home ScreenVideo Player Mozilla MarketplaceMusic Player System UpdaterE-mail (POP, IMAP) Localization SupportCalendar

https://hacks.mozilla.org/2013/01/hacking-gaia-for- firefox-os-part-1/

Installing apps

FIREFOX OS BOILERPLATE APPhttps://github.com/robnyman/Firefox-OS-Boilerplate-App

FXOSSTUBhttps://hacks.mozilla.org/2012/12/fxosstub-a-minimalists-working-example-of-the-design-guide-rules-for-firefox-os/

MORTARhttps://hacks.mozilla.org/2013/01/writing-web-apps-quickly-with-mortar/

Getting help

irc://irc.mozilla.org/ #openwebapps

https://lists.mozilla.org/listinfo/dev-webapps

Trying things out

Robert Nymanrobertnyman.comrobert@mozilla.comMozilla @robertnyman

https://hacks.mozilla.org	955
https://twitter.com	43
http://hacks.mozilla.org	37
http://www.newsblur.com	33
http://lanyrd.com	23
http://drbeat.li	22
http://webdesigning.collected.info	16
http://newsblur.com	15
http://www.wamigo.com	13
http://schoolofweb.org	8
http://www.twylah.com	8
http://thewebdesign.collected.info	6
http://embedded.dreamwidth.net	6
http://webcache.googleusercontent.com	4
http://xianguo.com	3
http://www.hanrss.com	3
http://127.0.0.1	2
http://beta-feeds.elpinetech.com	1
http://www.ofelio.com	1
http://www.verious.com	1
http://www.diffbot.com&_=1360736761805 HTTP	1
http://www.diffbot.com&_=1360736204523 HTTP	1
http://main.front.kamel.dev.mo-si.eu	1
http://htmlfive.collected.info	1
http://www.diffbot.com&_=1360268085519 HTTP	1
http://1kpl.us	1
http://planet.david-reichling.de	1
http://slidefox.tv	1
http://www.tuicool.com	1

WebAPIs & Apps - Mozilla London

by Robert Nyman on Jan 18, 2013

Accessibility

Categories

Upload Details

Usage Rights

29 Embeds 1,209

Statistics

WebAPIs & Apps - Mozilla London Presentation Transcript