This page lists all API specifications that are defined or referenced/used within the webinos project.

The APIs listed here are to be considered 'work in progress'. The official stable webinos API specifications are located at http://dev.webinos.org/deliverables/wp3/Deliverable34/

webinos is exposed under the window.webinos object. The webinos Core Interface, the webinos Discovery API and a few more webinos APIs are available directly under this name space.

However, one of the key elements of webinos is that the framework provides means to bind to a service object in a remote execution environment. The webinos Discovery API defines how a service is discovered and how an application can bind to a remote service. The service object will act as proxy for sending/receiving events to/from the remote peer and hides the complexity of sending/receiving message between the peers in a trusted manner. This mechanism is not limited to webinos defined APIs but is also available for the APIs defined by W3C referenced below and also to user defined APIs.

Most webinos APIs defines services that are discoverable through the webinos Discovery API and are therefore not exposed directly under the window.webinos object. Instead these APIs inherit the general webinos Service Interface that is defined in the webinos Discovery API

The Github repository for the webinos API specifications source files is Github webinos API specifications.

APIs Specified by webinos

SpecificationSummary
The Generic Actuator API

The webinos Generic Actuator API provides applications with an API to control actuators.

App2App Messaging API

Interface for exchanging messages between applications, locally and/or remotely, using named channels.

AppState Synchronisation API

Interface to enable and manage application synchronisation.

Authentication API

Provides information to applications about the current authentication status of users

Contacts API

This API provides access to a user unified address book.

Context API

Context API client side reference.

Device Interaction API

The webinos The Device Interaction API allow you to control various components in the device.

Device Status API

The webinos Device Status API lets you get information about various "aspects" of a device.

The Event Handling API

The Webinos Event Handling API provides means to exchange data in terms of events among addressable entities (e.g., applications, services), either locally or remotely.

AppLauncher API

Allows activation of webinos applications installed locally on the device.

MediaContent API

This api provides access to multimedia contents and related information.

MediaPlay API

The Webinos MediaPlay API can be used to invoke playback of media files in external media player software, instead of using playback in the widget/browser runtime.

Navigation API

The webinos Navigation API provides mechanism to interact with on-board navigation software.

NFC API

Near Field Communication (NFC) support.

The Web Notifications API

The webinos Web Notifications specification provides an API to display notifications to alert users outside the context of a web page.

Payment API

Interface for Payment functions.

The Remote UI API

The webinos remoteUI API provides means to create and access a UI on a remote device using DOM manipulation commands.

Secure Element API

The Webinos Secure Element API provides web applications with an API to access secure elements.

The Generic Sensor API

The Webinos Generic Sensor API provides Web Applications with an API to access data from sensors in the device or in another device.

Discovery API

The Webinos Discovery API provides web applications with an API to discover services without any previous knowledge of the service.

TV Control API

Interface for TV control and managment.

Vehicle API

The webinos vehicle API provides access to specific vehicle data.

Webinos core interface

Common interface from which all Webinos APIs can be accessed and it also includes information about the webinos personal zone

webinos Widget API

Webinos specific extensions to W3C Widget Interface

Referred APIs used by webinos

SpecificationSummaryInheritance of webinos Service interfaceFeature URI
The W3C DeviceOrientation Event specification

This specification defines several new DOM event types that provide information about the physical orientation and motion of a hosting device.

interface DeviceOrientation : Service {
...
};
http://webinos.org/api/w3c/deviceorientation
The W3C File API

This specification provides an API for representing file objects in web applications, as well as programmatically selecting them and accessing their data.

N/Ahttp://webinos.org/api/w3c/file (all file APIs)
http://webinos.org/api/w3c/file/read (file read only)
The W3C File API: Writer

This specification defines an API for writing to files from web applications. This API is designed to be used in conjunction with, and depends on definitions in, other APIs and elements on the web platform such as the W3C File API.

N/Ahttp://webinos.org/api/w3c/file (all file APIs)
http://webinos.org/api/w3c/file/write (file write only)
The W3C File API: Directories and System

This specification defines an API to navigate file system hierarchies, and defines a means by which a user agent may expose sandboxed sections of a user local filesystem to web applications. It builds on the File Writer API, which in turn built on the File API, each adding a different kind of functionality.

interface LocalFileSystem : Service {
...
};

interface LocalFileSystemSync : Service {
...
};
http://webinos.org/api/w3c/file (all file APIs)
The W3C Geolocation API

This specification defines an API that provides scripted access to geographical location information associated with the hosting device.

interface Geolocation : Service {
...
};
http://webinos.org/api/w3c/geolocation
The W3C Media Capture and Streams API

This specification defines an API that provides access to the audio, image and video capture capabilities of the device.

interface NavigatorUserMedia : Service {
...
};
http://webinos.org/api/w3c/mediastream
The W3C WebRTC API

This specification defines an API that allows to establish peer-to-peer connections between browsers, and transmit media streams and data over these connections.

N/Ahttp://webinos.org/api/w3c/webrtc