[Sensor] Updating start method documentation 18/147618/1
authorSzymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
Tue, 5 Sep 2017 06:24:40 +0000 (08:24 +0200)
committerSzymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
Tue, 5 Sep 2017 06:24:40 +0000 (08:24 +0200)
+ Adding list of possible error types launched in ErrorCallback.
+ Adding some brief info to the method description.
- Removing UnknownError error type from the list of synchronously thrown
exceptions because only TypeMismatchError may be thrown synchronously.
The change of implementation was requested by GunWang Jeong (ethan.jeong).

Change-Id: I1998214f1b0d5538409f3952fc5a22accd008060
Signed-off-by: Szymon Jastrzebski <s.jastrzebsk@partner.samsung.com>
org.tizen.web.apireference/html/device_api/mobile/tizen/sensor.html
org.tizen.web.apireference/html/device_api/wearable/tizen/sensor.html

index e0a05be..dc46e10 100755 (executable)
@@ -555,6 +555,22 @@ console.log("capable sensor: " + sensorCapabilities[0]);
             Since: </span>
  2.3
             </p>
+<div class="description">
+            <p>
+The <em>SuccessCallback</em> will be invoked when the first event from the sensor is fired.
+            </p>
+           </div>
+<div class="description">
+            <p>
+The <em>ErrorCallback</em> method is launched with these error types:
+            </p>
+            <ul>
+              <li>
+NotSupportedError - if the sensor is not supported on the device.              </li>
+              <li>
+UnknownError - if starting the sensor fails because of an unknown error.              </li>
+            </ul>
+           </div>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>
index 1263626..a96d32c 100755 (executable)
@@ -557,6 +557,22 @@ console.log("capable sensor: " + sensorCapabilities[0]);
             Since: </span>
  2.3
             </p>
+<div class="description">
+            <p>
+The <em>SuccessCallback</em> will be invoked when the first event from the sensor is fired.
+            </p>
+           </div>
+<div class="description">
+            <p>
+The <em>ErrorCallback</em> method is launched with these error types:
+            </p>
+            <ul>
+              <li>
+NotSupportedError - if the sensor is not supported on the device.              </li>
+              <li>
+UnknownError - if starting the sensor fails because of an unknown error.              </li>
+            </ul>
+           </div>
 <div class="parameters">
 <p><span class="param">Parameters:</span></p>
 <ul>