Webinos Logo

Webinos core interface

Webinos API Specifications

3 Sep 2012

Authors


Abstract

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

Table of Contents

  1. Introduction
  2. Interfaces and Dictionaries
    1. Webinos
  3. Enums
    1. States
  4. Features
  5. Full WebIDL

Summary of Methods

Interface Method
Webinos

Introduction

This specification defines the common interface from which all Webinos APIs can be accessed and personal zone information.

This version of the specification defines:
- The core Webinos interface, part of the window global object.
- The personal zone information such as the connected status, pzh name, pzp friendly name and application identifier.

Interfaces and Dictionaries

Interface Webinos

Webinos interface

WebIDL
  interface Webinos {
    readonly attribute DOMString   pzp_name;
    readonly attribute States  pzp_state;
    readonly attribute DOMString  pzh_name;
    readonly attribute DOMString  app_id;
  };

The Webinos root interface is defined as an interface on which the various Webinos APIs that are defined elsewhere graft themselves. A user agent supporting the Webinos interface must do so according to the following WebIDL definition.

Attributes

readonly DOMString pzp_name

Attribute provides the friendly name of the PZP, which has been given by the user. The main aim of this information is to differentiate the PZPs and used for display purpose to find under which PZP application is running.

This attribute is readonly.
readonly States pzp_state

Attribute denotes the PZP status, should be used for checking if the PZP is currently connected to other devices or not. This attribute can be used before invoking any network related APIs.

This attribute is readonly.
readonly DOMString pzh_name

Attribute denotes the PZH name, to identify in which personal zone PZP belongs. Useful to differentiate APPs when connected to multiple PZH.

This attribute is readonly.
readonly DOMString app_id

Attribute denotes the application identifier as assigned by the PZP. This should be unique and useful when communicating outside personal zone.

This attribute is readonly.

Enums

States

PZP states
connected = The PZP is connected to the PZH or a local peer
not-connected = The PZP is not connected either to the PZH or a local peer

WebIDL
  enum States {"connected", "not-connected"};

Values

connected
not-connected

Features

This is the list of URIs used to declare this API's features, for use in the widget config.xml and as identifier for service type in service discovery functionality. For each URI, the list of functions covered is provided.

http://webinos.org/api/corePZinformation

Identifies the webinos core Personal Zone Information service.

Full WebIDL

WebIDL
  partial interface Window {
    readonly attribute Webinos webinos;
  };

  interface Webinos {
    readonly attribute DOMString   pzp_name;
    readonly attribute States  pzp_state;
    readonly attribute DOMString  pzh_name;
    readonly attribute DOMString  app_id;
  };

  enum States {"connected", "not-connected"};