The Bondi push Module - Version 0.3

This API provides functionality of OMA Push delivery to Web Applications running in the widget context, which includes; subscription/unsubscription of web applications to Push messages from the OMA Push enabler, and delivery of received Push messages to the subscribeed application(s).

This module offers the functionality to subscribe to OMA Push messages. A subscription to Push messages will remain active until explicit unsubscription. While subscribed, Push messages that match application preferences will be delivered to the application if possible, through a call to the application-defined Push message listener.

The basic structure of OMA Push messages is very similar to HTTP messages, i.e. they include headers and a content body.

Headers:

• Push Application ID: an OMNA-registered value for BONDI "x-oma-bondi:widget.ua", (see OMA Push Application ID Registry), which is used by OMA Push Clients to route incoming Push to the widget user agent.
• Content Type: MIME type of the Push body.
• Other headers (application specific or standardized).

Content:

• Content: may be a text or binary file. Text files may be in plain text XML, or any other text content type. Text files may be delivered to the terminal in compressed form (e.g. content encoding as WBXML or GZIP), and will be uncompressed before delivery to the subscribed application. OMA Push defines standard XML-based content types of general use for notification/wakeup-type purposes, e.g. the "Service Indication" and "Service Loading" content types.

OMA Push messages are delivered via various bearers and protocols, depending upon the support of the specific device. The specific bearer used is transparent to the application, except as arranged through a specific Push Registration URI (a parameter of the subscription process).

The latest OMA Push Candidate Enabler release is OMA Push 2.3. OMA Push "Over-the-Air" protocol reference: Push-OTA

        [Callback=FunctionOnly, NoInterfaceObject] interface SubscriptionSuccessCallback {
                void onSuccess(in unsigned long subscriptionID);
        };

        [Callback=FunctionOnly, NoInterfaceObject] interface PushEventCallback {
                void onPushEvent(in PushMessage message);
        };

         interface PushManager {
                PendingOperation subscribe(in SubscriptionSuccessCallback successCallback, 
                                in ErrorCallback errorCallback,
                                in PushEventCallback listener,
                                [Optional] in DOMString registrationUri,
                                [Optional] in DOMString accept,
                                [Optional] in DOMString appid,
                                [Optional] in boolean exclusive)
                        raises(SecurityError, DeviceAPIError);

                void unsubscribe(in unsigned long subscriptionID)
                        raises(SecurityError, DeviceAPIError);
        };

  var subscriptionID = 0;

        // Define the success callback to get the subscription ID.
        function successCallback(id) {
                subscriptionID = id;
        }

        // Define the error callback.
        function errorCallback(response) {
                alert( "Push subscription failed. The error code is: " +  response.code);
        }

        // Define listener for received Push messages
        function gotPush(push) {
                var ctype = push.getMessageHeader("Content-Type");
                if (ctype == "text/vnd.wap.si") {
                        serviceIndication(push.messageXML);
                }
                if (ctype == "text/vnd.wap.sl") {
                        serviceLoad(push.messageXML);
                }
                (... etc for other content types as supported by widget)
        }

        // Subscribe to Push messages
        var accept = "text/vnd.wap.si";
        var appid = "x-oma-application:dcd.ua";
        var pendop = bondi.push.subscribe(successCallback, errorCallback, 
                        gotPush, registrationUri, accept, appid, false);

        // Cancel subscription to Push messages
        bondi.push.unsubscribe(subscriptionID);

 

        interface PushMessage {

                 DOMString getAllMessageHeaders();
                 
                 DOMString getMessageHeader(in DOMString header);

                 readonly attribute DOMString messageText;
                 
                 readonly attribute Document messageXML;
        };