[web API doc][alarm] remove TypeMismatchError, add changed Alarm policy

- http://168.219.209.56/jira/browse/TWDAPI-34 : remove TypeMismatchError
- http://168.219.209.56/jira/browse/TWDAPI-52 : alarm new policy

Change-Id: I3e7bb8f3a537ba90b2a4196ce9c8c6b0e8a3f0d7
Signed-off-by: Hyunjin park <hj.na.park@samsung.com>

diff --git a/org.tizen.web.apireference/html/device_api/mobile/tizen/alarm.html b/org.tizen.web.apireference/html/device_api/mobile/tizen/alarm.html
index 058f5db..da268a1 100644 (file)
--- a/org.tizen.web.apireference/html/device_api/mobile/tizen/alarm.html
+++ b/org.tizen.web.apireference/html/device_api/mobile/tizen/alarm.html
@@ -308,9 +308,6 @@ If an alarm goes off, it will be removed from the storage automatically.
  with error type NotFoundError, if this alarm identifier cannot be found in the storage.
                 </p></li>
 <li class="list"><p>
- with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
-                </p></li>
-<li class="list"><p>
  with error type InvalidValuesError, if any input parameter does not contain a valid value.
                 </p></li>
 <li class="list"><p>
@@ -414,9 +411,6 @@ Because each application has its own alarm storage, this method removes alarms o
  with error type NotFoundError, if this alarm identifier cannot be found in the storage.
                 </p></li>
 <li class="list"><p>
- with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
-                </p></li>
-<li class="list"><p>
  with error type InvalidValuesError, if any input parameter does not contain a valid value.
                 </p></li>
 <li class="list"><p>
@@ -527,6 +521,12 @@ This alarm triggers after a duration mentioned in the <em>delay</em> attribute f
 If a <em>period</em> is provided, the alarm keeps triggering for the given interval.
           </p>
          </div>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 behaviour of this alarm has changed. In order to decrease the power consumption,
+the operating system decides when this alarm is going to be fired and what is the period between subsequent executions.
+It is guaranteed that this alarm will be fired after at least <em>delay</em> seconds.
+If <em>period</em> is provided, it will be adjusted by the operating system, however this value will not be lower than 600 seconds.
+          </p>
 <div class="example">
 <span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Gets the current application ID.
  var appId = tizen.application.getCurrentApplication().appInfo.id;
@@ -535,8 +535,8 @@ If a <em>period</em> is provided, the alarm keeps triggering for the given inter
  var alarm1 = new tizen.AlarmRelative(3 * tizen.alarm.PERIOD_HOUR);
  tizen.alarm.add(alarm1, appId);
 
- // Sets an alarm in one hour, recurring after every 2 minutes
- var alarm2 = new tizen.AlarmRelative(tizen.alarm.PERIOD_HOUR, 2 * tizen.alarm.PERIOD_MINUTE);
+ // Sets an alarm in one hour, recurring after every 10 minutes
+ var alarm2 = new tizen.AlarmRelative(tizen.alarm.PERIOD_HOUR, 10 * tizen.alarm.PERIOD_MINUTE);
  tizen.alarm.add(alarm2, appId);
  </pre>
 </div>
@@ -557,6 +557,9 @@ If a <em>period</em> is provided, the alarm keeps triggering for the given inter
             Since: </span>
  1.0
             </p>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
+            </p>
 </li>
 <li class="attribute" id="AlarmRelative::period">
 <span class="attrName"><span class="readonly">                readonly
@@ -568,6 +571,9 @@ By default, this attribute is set to <var>null</var>, indicating that this alarm
             Since: </span>
  1.0
             </p>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
+            </p>
 </li>
 </ul>
 </div>

diff --git a/org.tizen.web.apireference/html/device_api/wearable/tizen/alarm.html b/org.tizen.web.apireference/html/device_api/wearable/tizen/alarm.html
index d8ed81f..068c3de 100644 (file)
--- a/org.tizen.web.apireference/html/device_api/wearable/tizen/alarm.html
+++ b/org.tizen.web.apireference/html/device_api/wearable/tizen/alarm.html
@@ -328,9 +328,6 @@ If an alarm goes off, it will be removed from the storage automatically.
  with error type NotFoundError, if this alarm identifier cannot be found in the storage.
                 </p></li>
 <li class="list"><p>
- with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
-                </p></li>
-<li class="list"><p>
  with error type InvalidValuesError, if any input parameter does not contain a valid value.
                 </p></li>
 <li class="list"><p>
@@ -434,9 +431,6 @@ Because each application has its own alarm storage, this method removes alarms o
  with error type NotFoundError, if this alarm identifier cannot be found in the storage.
                 </p></li>
 <li class="list"><p>
- with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
-                </p></li>
-<li class="list"><p>
  with error type InvalidValuesError, if any input parameter does not contain a valid value.
                 </p></li>
 <li class="list"><p>
@@ -547,6 +541,12 @@ This alarm triggers after a duration mentioned in the <em>delay</em> attribute f
 If a <em>period</em> is provided, the alarm keeps triggering for the given interval.
           </p>
          </div>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 behaviour of this alarm has changed. In order to decrease the power consumption,
+the operating system decides when this alarm is going to be fired and what is the period between subsequent executions.
+It is guaranteed that this alarm will be fired after at least <em>delay</em> seconds.
+If <em>period</em> is provided, it will be adjusted by the operating system, however this value will not be lower than 600 seconds.
+          </p>
 <div class="example">
 <span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Gets the current application ID.
  var appId = tizen.application.getCurrentApplication().appInfo.id;
@@ -555,8 +555,8 @@ If a <em>period</em> is provided, the alarm keeps triggering for the given inter
  var alarm1 = new tizen.AlarmRelative(3 * tizen.alarm.PERIOD_HOUR);
  tizen.alarm.add(alarm1, appId);
 
- // Sets an alarm in one hour, recurring after every 2 minutes
- var alarm2 = new tizen.AlarmRelative(tizen.alarm.PERIOD_HOUR, 2 * tizen.alarm.PERIOD_MINUTE);
+ // Sets an alarm in one hour, recurring after every 10 minutes
+ var alarm2 = new tizen.AlarmRelative(tizen.alarm.PERIOD_HOUR, 10 * tizen.alarm.PERIOD_MINUTE);
  tizen.alarm.add(alarm2, appId);
  </pre>
 </div>
@@ -577,6 +577,9 @@ If a <em>period</em> is provided, the alarm keeps triggering for the given inter
             Since: </span>
  1.0
             </p>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
+            </p>
 </li>
 <li class="attribute" id="AlarmRelative::period">
 <span class="attrName"><span class="readonly">                readonly
@@ -588,6 +591,9 @@ By default, this attribute is set to <var>null</var>, indicating that this alarm
             Since: </span>
  1.0
             </p>
+<p><span class="remark"> Remark : </span>
+ Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
+            </p>
 </li>
 </ul>
 </div>