[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 <p.kosko@samsung.com>

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 (file)
--- 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');
 <h3 id="instances" name="instances">Retrieving Widget Instances</h3>
 
 <p>Learning how to retrieve information about installed widget instances makes the Widget Service API more useful:</p>
+
+<div class="note">
+       <strong>Note</strong>
+       The <a href="../../../../org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html#WidgetInstance::id">WidgetInstance.id</a> value is volatile and can change after device reboot.
+</div>
+
   <ol>
    <li><p>Define a success handler implementing the <code>WidgetInstancesCallback</code> interface (in <a href="../../../../org.tizen.web.apireference/html/device_api/mobile/tizen/widgetservice.html#WidgetInstancesCallback">mobile</a> and <a href="../../../../org.tizen.web.apireference/html/device_api/wearable/tizen/widgetservice.html#WidgetInstancesCallback">wearable</a> applications). Optionally, you can specify an error handler too.</p>
 <pre class="prettyprint">
@@ -229,6 +235,12 @@ myWidget.removeStateChangeListener(watchId);
       <li>Send or get content to and from the widget instance.</li>
     </ul>
 
+<div class="note">
+       <strong>Note</strong>
+       These features are not supported by Web widgets. You can only use them in Web applications to manage installed widgets. For more information, see <a href="
+https://developer.tizen.org/dev-guide/2.3.2/org.tizen.web.apireference/html/widget_spec/web_widget.html#user-content-web-device-api">Web Device API supported by Widget Engine</a>.
+</div>
+
   <h3 id="period" name="period">Changing the Update Period</h3>
 
 <p>To change the update interval for the widget instance:</p>

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 (executable)
--- 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
 <div class="typedef" id="WidgetInstanceId">
 <a class="backward-compatibility-anchor" name="::WidgetService::WidgetInstanceId"></a><h3>1.2. WidgetInstanceId</h3>
 <div class="brief">
- The unique ID of the installed widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
           </div>
 <pre class="webidl prettyprint">  typedef DOMString WidgetInstanceId;</pre>
 <p><span class="version">
@@ -1037,6 +1037,9 @@ catch (error)
             Since: </span>
  3.0
             </p>
+<p><span class="remark"> Remark : </span>
+ 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.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1103,6 +1106,9 @@ catch (error)
             Since: </span>
  3.0
             </p>
+<p><span class="remark"> Remark : </span>
+ 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.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1331,7 +1337,7 @@ Every visual widget element added to the home screen is a single instance of som
 <li class="attribute" id="WidgetInstance::id">
 <span class="attrName"><span class="readonly">                readonly
 </span><span class="type">WidgetInstanceId </span><span class="name">id</span></span><div class="brief">
- The unique ID of the widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
             </div>
 <p><span class="version">
             Since: </span>
@@ -1356,6 +1362,9 @@ Every visual widget element added to the home screen is a single instance of som
             Since: </span>
  3.0
             </p>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1420,6 +1429,9 @@ catch (error)
 This function does not wait for a confirmation that the data was updated.
             </p>
            </div>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1499,6 +1511,9 @@ IOError - If a DB operation has failed              </li>
 AbortError - If the operation cannot be finished properly.              </li>
             </ul>
            </div>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>

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 (executable)
--- 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
 <div class="typedef" id="WidgetInstanceId">
 <a class="backward-compatibility-anchor" name="::WidgetService::WidgetInstanceId"></a><h3>1.2. WidgetInstanceId</h3>
 <div class="brief">
- The unique ID of the installed widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
           </div>
 <pre class="webidl prettyprint">  typedef DOMString WidgetInstanceId;</pre>
 <p><span class="version">
@@ -679,6 +679,7 @@ catch (error)
     readonly attribute boolean noDisplay;
 
     DOMString getName(optional DOMString? locale) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
     void getInstances(<a href="#WidgetInstancesCallback">WidgetInstancesCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
 
     <a href="#WidgetVariant">WidgetVariant</a> getVariant(<a href="#WidgetSizeType">WidgetSizeType</a> sizeType) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
@@ -1331,7 +1332,7 @@ Every visual widget element added to the home screen is a single instance of som
 <li class="attribute" id="WidgetInstance::id">
 <span class="attrName"><span class="readonly">                readonly
 </span><span class="type">WidgetInstanceId </span><span class="name">id</span></span><div class="brief">
- The unique ID of the widget instance.
+ ID of the widget instance, this value is volatile and may change after reboot.
             </div>
 <p><span class="version">
             Since: </span>
@@ -1356,6 +1357,9 @@ Every visual widget element added to the home screen is a single instance of som
             Since: </span>
  2.3.2
             </p>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1420,6 +1424,9 @@ catch (error)
 This function does not wait for a confirmation that the data was updated.
             </p>
            </div>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1499,6 +1506,9 @@ IOError - If a DB operation has failed              </li>
 AbortError - If the operation cannot be finished properly.              </li>
             </ul>
            </div>
+<p><span class="remark"> Remark : </span>
+ This method is not supported by Web Widget.
+            </p>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
@@ -1822,6 +1832,7 @@ To guarantee that the widget application runs on a system which supports Widgets
     readonly attribute boolean noDisplay;
 
     DOMString getName(optional DOMString? locale) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
     void getInstances(<a href="#WidgetInstancesCallback">WidgetInstancesCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
 
     <a href="#WidgetVariant">WidgetVariant</a> getVariant(<a href="#WidgetSizeType">WidgetSizeType</a> sizeType) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);