From 6a55d535e4d7bf10f49b7f56c7fd27e8d0e44dc5 Mon Sep 17 00:00:00 2001 From: Piotr Kosko Date: Wed, 29 Mar 2017 11:42:12 +0200 Subject: [PATCH] [WidgetService] some features are not supported by Web Widget [Feature] The description was added for some functions, that they are not supported by Web Widget. The description of Web Instance.id was updated - this id is volatile. PS2: Reviewed PS3: Reviewed by LB Change-Id: I80bafd3b8098827cd172a2d871f9fe4d60a6728d Signed-off-by: Piotr Kosko --- .../html/web/app_management/widget_app_w.htm | 12 ++++++++++++ .../html/device_api/mobile/tizen/widgetservice.html | 19 +++++++++++++++++-- .../html/device_api/wearable/tizen/widgetservice.html | 15 +++++++++++++-- 3 files changed, 42 insertions(+), 4 deletions(-) diff --git a/org.tizen.guides/html/web/app_management/widget_app_w.htm b/org.tizen.guides/html/web/app_management/widget_app_w.htm index 8ce5966..f62ddd3 100644 --- a/org.tizen.guides/html/web/app_management/widget_app_w.htm +++ b/org.tizen.guides/html/web/app_management/widget_app_w.htm @@ -150,6 +150,12 @@ var name = myWidget.getName('en-us');

Retrieving Widget Instances

Learning how to retrieve information about installed widget instances makes the Widget Service API more useful:

+ +
+ Note + The WidgetInstance.id value is volatile and can change after device reboot. +
+

  1. Define a success handler implementing the WidgetInstancesCallback interface (in mobile and wearable applications). Optionally, you can specify an error handler too.

    @@ -229,6 +235,12 @@ myWidget.removeStateChangeListener(watchId);
       
  2. Send or get content to and from the widget instance.
    3. 
     
 
+
    
+	Note
+	These features are not supported by Web widgets. You can only use them in Web applications to manage installed widgets. For more information, see Web Device API supported by Widget Engine.
+
    
+
   
    Changing the Update Period
    
 
 
    To change the update interval for the widget instance:
    
diff --git a/org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html b/org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html
index 469a3f4..1e1ad75 100755
--- a/org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html
+++ b/org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html
@@ -163,7 +163,7 @@ Do not use "widget" as name for one of your global variables, as it is a global
 
    
 
    1.2. WidgetInstanceId
    
 
    
- The unique ID of the installed widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
           
    
 
      typedef DOMString WidgetInstanceId;
    
 
    
@@ -1037,6 +1037,9 @@ catch (error)
             Since: 
  3.0
             
    
+
     Remark : 
+ This method can only be used with widgets and applications which belong to the same package. Therefore, the widget should belong to the package of the Web application which calls this method.
+            
    
 
    
 
    Parameters:
    
 
      
@@ -1103,6 +1106,9 @@ catch (error)
             Since: 
  3.0
             
      
+
       Remark : 
+ This method can only be used with widgets and applications which belong to the same package. Therefore, the widget should belong to the package of the Web application which calls this method.
+            
      
 
      
 
      Parameters:
      
 
        
@@ -1331,7 +1337,7 @@ Every visual widget element added to the home screen is a single instance of som
 
      • 
                 readonly
 WidgetInstanceId id
        
- The unique ID of the widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
             
        
 
        
             Since: 
@@ -1356,6 +1362,9 @@ Every visual widget element added to the home screen is a single instance of som
             Since: 
  3.0
             
        
+
         Remark : 
+ This method is not supported by Web Widget.
+            
        
 
        
 
        Parameters:
        
 
          
@@ -1420,6 +1429,9 @@ catch (error)
 This function does not wait for a confirmation that the data was updated.
             
          
            
        
+
         Remark : 
+ This method is not supported by Web Widget.
+            
        
 
        
 
        Parameters:
        
 
          
@@ -1499,6 +1511,9 @@ IOError - If a DB operation has failed              
 AbortError - If the operation cannot be finished properly.              
             
        
            
        
+
         Remark : 
+ This method is not supported by Web Widget.
+            
        
 
        
 
        Parameters:
        
 
          
diff --git a/org.tizen.web.apireference/html/device_api/wearable/tizen/widgetservice.html b/org.tizen.web.apireference/html/device_api/wearable/tizen/widgetservice.html
index 16316d3..4edfa9f 100755
--- a/org.tizen.web.apireference/html/device_api/wearable/tizen/widgetservice.html
+++ b/org.tizen.web.apireference/html/device_api/wearable/tizen/widgetservice.html
@@ -163,7 +163,7 @@ Do not use "widget" as name for one of your global variables, as it is a global
 
          
 
          1.2. WidgetInstanceId
          
 
          
- The unique ID of the installed widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
           
          
 
            typedef DOMString WidgetInstanceId;
          
 
          
@@ -679,6 +679,7 @@ catch (error)
     readonly attribute boolean noDisplay;
 
     DOMString getName(optional DOMString? locale) raises(WebAPIException);
+
     void getInstances(WidgetInstancesCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException);
 
     WidgetVariant getVariant(WidgetSizeType sizeType) raises(WebAPIException);
@@ -1331,7 +1332,7 @@ Every visual widget element added to the home screen is a single instance of som
 
        • 
                 readonly
 WidgetInstanceId id
          
- The unique ID of the widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
             
          
 
          
             Since: 
@@ -1356,6 +1357,9 @@ Every visual widget element added to the home screen is a single instance of som
             Since: 
  2.3.2
             
          
+
           Remark : 
+ This method is not supported by Web Widget.
+            
          
 
          
 
          Parameters:
          
 
            
@@ -1420,6 +1424,9 @@ catch (error)
 This function does not wait for a confirmation that the data was updated.
             
            
            
          
+
           Remark : 
+ This method is not supported by Web Widget.
+            
          
 
          
 
          Parameters:
          
 
            
@@ -1499,6 +1506,9 @@ IOError - If a DB operation has failed              
 AbortError - If the operation cannot be finished properly.              
             
          
            
          
+
           Remark : 
+ This method is not supported by Web Widget.
+            
          
 
          
 
          Parameters: