Samsung Web API: WebAPIs

© 2013 Samsung Electronics Co., Ltd. All rights reserved.

Introduction

Table of Contents

• 1. Type Definitions
  • 1.1. FilterMatchFlag
  • 1.2. SortModeOrder
  • 1.3. CompositeFilterType
  • 1.4. StringArray
  • 1.5. UnsignedShortArray
  • 1.6. ShortArray
• 2. Interfaces
  • 2.1. WindowWebAPIs
  • 2.2. WebAPIs
  • 2.3. AbstractFilter
  • 2.4. AttributeFilter
  • 2.5. AttributeRangeFilter
  • 2.6. CompositeFilter
  • 2.7. SortMode
  • 2.8. SimpleCoordinates
  • 2.9. WebAPIException
  • 2.10. WebAPIError
  • 2.11. SuccessCallback
  • 2.12. ErrorCallback
• 3. Full WebIDL

Summary of Interfaces and Methods

  enum FilterMatchFlag { "EXACTLY", "FULLSTRING", "CONTAINS", "STARTSWITH", "ENDSWITH", "EXISTS" };

  enum SortModeOrder { "ASC", "DESC" };

  enum CompositeFilterType { "UNION", "INTERSECTION" };

  typedef sequence<DOMString> StringArray;

  typedef sequence<unsigned short> UnsignedShortArray;

  typedef sequence<short> ShortArray;

2. Interfaces

  [NoInterfaceObject] interface WindowWebAPIs {
    readonly attribute WebAPIs webapis;
  };

  Window implements WindowWebAPIs;

  [NoInterfaceObject] interface WebAPIs {

  };

  [NoInterfaceObject] interface AbstractFilter {
  };

  [Constructor(DOMString attributeName, optional FilterMatchFlag? matchFlag, optional any matchValue)]

  interface AttributeFilter : AbstractFilter {


    attribute DOMString attributeName;

    attribute FilterMatchFlag matchFlag;


    attribute any matchValue;
  };

 // Define success callback
 function successCallback(contacts) {
   console.log(contacts.length + " contacts found.");
 }

 // Define error callback
 function errorCallback(error) {
   console.log("An error occurred: " + error.message);
 }

 // Create an attribute filter based on first name: "First name should contain 'Chris' (case insensitive)"
 var filter = new webapis.AttributeFilter("name.firstName", "CONTAINS", "Chris");
 // Send request on contact address book.
 webapis.contact.getDefaultAddressBook().find(successCallback, errorCallback, filter);
 

  [Constructor(DOMString attributeName, optional any initialValue, optional any endValue)]

  interface AttributeRangeFilter : AbstractFilter {

    attribute DOMString attributeName;


    attribute any initialValue;


    attribute any endValue;
  };

 // Define success callback
 function successCallback(events) {
   console.log(events.length + " events today.");
 }

 // Define error callback
 function errorCallback(error) {
   console.log("An error occurred: " + error.message);
 }
 
 // Create an attribute range filter based on event start date: "All events occurring today".
 var now_dt = webapis.time.getCurrentDateTime();
 var today_begin = new webapis.TZDate(now_dt.getFullYear(), now_dt.getMonth(), now_dt.getDate());
 var today_end = today_begin.addDuration(new webapis.TimeDuration(1, "DAYS"));
 var filter = new webapis.AttributeRangeFilter("startDate", today_begin, today_end);
 
 // Send a search request to default event calendar.
 webapis.calendar.getDefaultCalendar("EVENT").find(successCallback, errorCallback, filter);
 

  [Constructor(CompositeFilterType type, optional AbstractFilter[]? filters)]

  interface CompositeFilter : AbstractFilter {


    attribute CompositeFilterType type;
    

    attribute AbstractFilter[] filters;
  };

 // Define success callback
 function successCallback(contacts) {
   console.log(contacts.length + " contacts found.");
 }

 // Define error callback
 function errorCallback(error) {
   console.log("An error occurred: " + error.message);
 }

 // Create an attribute filter based on first name: "First name should contain 'Chris' (case insensitive)
 var firstNameFilter = new webapis.AttributeFilter("name.firstName", "CONTAINS", "Chris");

 // Create an attribute filter based on last name: "Last name should be exactly 'Smith' (case insensitive)
 var lastNameFilter = new webapis.AttributeFilter("name.lastName", "EXACTLY", "Smith"};

 // Create a filter based on the intersection of these two filter:
 // "First name should contain 'Chris' AND last name should be 'Smith'".
 var filter = new webapis.CompositeFilter("INTERSECTION", [firstNameFilter, lastNameFilter]);

 // Send request on contact address book.
 webapis.contact.getDefaultAddressBook().find(successCallback, errorCallback, filter);
 

 [Constructor(DOMString attributeName, optional SortModeOrder? order)] 

  interface SortMode {

    attribute DOMString attributeName;    


    attribute SortModeOrder order setraises(WebAPIException);
  };

 // Define a success callback
 function successCallback(contacts) {
   // The returned contacts are sorted by first name (ascending)
   console.log(contacts.length + " contacts found.");
 }

 // Define an error callback
 function errorCallback(error) {
   console.log("An error occurred: " + error.message);
 }
 
 // Create an attribute filter based on first name: "First name should contain 'Chris' (case insensitive)"
 var filter = new webapis.AttributeFilter("name.firstName", "CONTAINS", "Chris");
 // Sort by first name, ascending
 var sortMode = new webapis.SortMode("name.firstName", "ASC");
 // Send request on contact address book.
 webapis.contact.getDefaultAddressBook().find(successCallback, errorCallback, filter, sortMode);
 

[Constructor(double latitude, double longitude)]  

  interface SimpleCoordinates {


    attribute double latitude setraises(WebAPIException);


    attribute double longitude setraises(WebAPIException);
  };

    interface WebAPIException {


        readonly attribute unsigned short code;


        readonly attribute DOMString name; 
            

        readonly attribute DOMString message;
                   

        const unsigned short INDEX_SIZE_ERR = 1; 
        

        const unsigned short DOMSTRING_SIZE_ERR = 2; 
        

        const unsigned short HIERARCHY_REQUEST_ERR = 3; 
        

        const unsigned short WRONG_DOCUMENT_ERR = 4; 


        const unsigned short INVALID_CHARACTER_ERR = 5;


        const unsigned short NO_DATA_ALLOWED_ERR = 6; 


        const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7; 


        const unsigned short NOT_FOUND_ERR = 8; 


        const unsigned short NOT_SUPPORTED_ERR = 9; 


        const unsigned short INUSE_ATTRIBUTE_ERR = 10; 


        const unsigned short INVALID_STATE_ERR = 11; 


        const unsigned short SYNTAX_ERR = 12; 


        const unsigned short INVALID_MODIFICATION_ERR = 13; 


        const unsigned short NAMESPACE_ERR = 14; 


        const unsigned short INVALID_ACCESS_ERR = 15; 


        const unsigned short VALIDATION_ERR = 16; 
 

        const unsigned short TYPE_MISMATCH_ERR = 17; 
 

        const unsigned short SECURITY_ERR = 18; 
 

        const unsigned short NETWORK_ERR = 19; 
 

        const unsigned short ABORT_ERR = 20; 


        const unsigned short URL_MISMATCH_ERR = 21; 
 

        const unsigned short QUOTA_EXCEEDED_ERR = 22; 
 

        const unsigned short TIMEOUT_ERR = 23; 
 

        const unsigned short INVALID_NODE_TYPE_ERR = 24; 


        const unsigned short DATA_CLONE_ERR = 25; 
  };

 try {
     webapis.contact.getDefaultAddressBook().find();
 } catch (ex) {
     // The value of ex parameter is a WebAPIException object.
    if (ex.code == webapis.WebAPIException.NOT_SUPPORTED_ERR) {
        // find() API is not supported in some platform
    } else if (ex.code == webapis.WebAPIException.TYPE_MISMATCH_ERR)
       // find() API throws "TypeMismatchError"
    }
 } 
 

    interface WebAPIError {


        readonly attribute DOMString name; 
            

        readonly attribute DOMString message;
  };

 function successCallback(contacts) {
   // The returned contacts are sorted by first name (ascending)
   console.log(contacts.length + " contacts found.");
 }

 // Define an error callback
 function errorCallback(error) {
     // error parameter is a WebAPIError object.
     if (error.name == "NotFoundError") {
        // the contacts are not found.
     }
 }
 
 // Send request on contact address book.
 webapis.contact.getDefaultAddressBook().find(successCallback, errorCallback);
 

 }
 

  [Callback=FunctionOnly, NoInterfaceObject]
  interface SuccessCallback {

    void onsuccess();
  };

     function onSuccess() {
         console.log("Application terminated successfully");
     }
     webapis.application.kill(onSuccess, anApp);
 

  [Callback=FunctionOnly, NoInterfaceObject]
  interface ErrorCallback {
 

    void onerror (WebAPIError error);
  };

  // Define the error callback.
  function onError(error) {
    console.log(error.message);
  }

  // Define the success callback.
  function onSuccess(services) {
     //send a message using the found service
  }
  webapis.messaging.getMessageServices("messaging.sms", onSuccess, onError);
 

3. Full WebIDL

module WebAPIs {
    

  enum FilterMatchFlag { "EXACTLY", "FULLSTRING", "CONTAINS", "STARTSWITH", "ENDSWITH", "EXISTS" };
  

  enum SortModeOrder { "ASC", "DESC" };
  

  enum CompositeFilterType { "UNION", "INTERSECTION" };


  typedef sequence<DOMString> StringArray;


  typedef sequence<unsigned short> UnsignedShortArray;


  typedef sequence<short> ShortArray;
  

  [NoInterfaceObject] interface WindowWebAPIs {
    readonly attribute WebAPIs webapis;
  };

  Window implements WindowWebAPIs;


  [NoInterfaceObject] interface WebAPIs {

  };


  [NoInterfaceObject] interface AbstractFilter {
  };
  

  [Constructor(DOMString attributeName, optional FilterMatchFlag? matchFlag, optional any matchValue)]

  interface AttributeFilter : AbstractFilter {


    attribute DOMString attributeName;

    attribute FilterMatchFlag matchFlag;


    attribute any matchValue;
  };  

  [Constructor(DOMString attributeName, optional any initialValue, optional any endValue)]

  interface AttributeRangeFilter : AbstractFilter {

    attribute DOMString attributeName;


    attribute any initialValue;


    attribute any endValue;
  };

  [Constructor(CompositeFilterType type, optional AbstractFilter[]? filters)]

  interface CompositeFilter : AbstractFilter {


    attribute CompositeFilterType type;
    

    attribute AbstractFilter[] filters;
  };
  
 [Constructor(DOMString attributeName, optional SortModeOrder? order)] 

  interface SortMode {

    attribute DOMString attributeName;    


    attribute SortModeOrder order setraises(WebAPIException);
  };
  
[Constructor(double latitude, double longitude)]  

  interface SimpleCoordinates {


    attribute double latitude setraises(WebAPIException);


    attribute double longitude setraises(WebAPIException);
  };


    interface WebAPIException {


        readonly attribute unsigned short code;


        readonly attribute DOMString name; 
            

        readonly attribute DOMString message;
                   

        const unsigned short INDEX_SIZE_ERR = 1; 
        

        const unsigned short DOMSTRING_SIZE_ERR = 2; 
        

        const unsigned short HIERARCHY_REQUEST_ERR = 3; 
        

        const unsigned short WRONG_DOCUMENT_ERR = 4; 


        const unsigned short INVALID_CHARACTER_ERR = 5;


        const unsigned short NO_DATA_ALLOWED_ERR = 6; 


        const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7; 


        const unsigned short NOT_FOUND_ERR = 8; 


        const unsigned short NOT_SUPPORTED_ERR = 9; 


        const unsigned short INUSE_ATTRIBUTE_ERR = 10; 


        const unsigned short INVALID_STATE_ERR = 11; 


        const unsigned short SYNTAX_ERR = 12; 


        const unsigned short INVALID_MODIFICATION_ERR = 13; 


        const unsigned short NAMESPACE_ERR = 14; 


        const unsigned short INVALID_ACCESS_ERR = 15; 


        const unsigned short VALIDATION_ERR = 16; 
 

        const unsigned short TYPE_MISMATCH_ERR = 17; 
 

        const unsigned short SECURITY_ERR = 18; 
 

        const unsigned short NETWORK_ERR = 19; 
 

        const unsigned short ABORT_ERR = 20; 


        const unsigned short URL_MISMATCH_ERR = 21; 
 

        const unsigned short QUOTA_EXCEEDED_ERR = 22; 
 

        const unsigned short TIMEOUT_ERR = 23; 
 

        const unsigned short INVALID_NODE_TYPE_ERR = 24; 


        const unsigned short DATA_CLONE_ERR = 25; 
  };
  

    interface WebAPIError {


        readonly attribute DOMString name; 
            

        readonly attribute DOMString message;
  };
  

  [Callback=FunctionOnly, NoInterfaceObject]
  interface SuccessCallback {

    void onsuccess();
  };



  [Callback=FunctionOnly, NoInterfaceObject]
  interface ErrorCallback {
 

    void onerror (WebAPIError error);
  };
};