<li>
BATTERY </li>
<li>
-CPU </li>
+BUILD </li>
<li>
-STORAGE </li>
+CAMERA_FLASH (<b>Since</b>: 3.0) </li>
<li>
-DISPLAY </li>
+CELLULAR_NETWORK </li>
+ <li>
+CPU </li>
<li>
DEVICE_ORIENTATION </li>
<li>
-BUILD </li>
+DISPLAY </li>
<li>
-LOCALE </li>
+ETHERNET_NETWORK (<b>Since</b>: 3.0) </li>
<li>
-NETWORK </li>
+LOCALE (<b>Since</b>: 2.1) </li>
<li>
-WIFI_NETWORK </li>
+MEMORY (<b>Since</b>: 2.3) </li>
<li>
-ETHERNET_NETWORK (<b>Since</b>: 2.4) </li>
+NETWORK </li>
<li>
-CELLULAR_NETWORK </li>
+PERIPHERAL (<b>Since</b>: 2.1) </li>
<li>
-NET_PROXY_NETWORK (<b>Since</b>: 3.0) </li>
- <li>
SIM </li>
<li>
-PERIPHERAL </li>
+STORAGE </li>
+ <li>
+NET_PROXY_NETWORK (<b>Since</b>: 3.0) </li>
<li>
-MEMORY </li>
+WIFI_NETWORK </li>
</ul>
<p>
Not all above properties may be available on every Tizen device. For instance, a device may not support the telephony feature. In that case, <var>CELLULAR_NETWORK</var> and <var>SIM</var> are not available.<br><br>To check the available <var>SystemInfoPropertyId</var>, <em>tizen.systeminfo.getCapability()</em> can be used.
<li>
BATTERY - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/battery"</em>) </li>
<li>
- DISPLAY - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/screen"</em>) </li>
- <li>
- WIFI_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.wifi"</em>) </li>
+ CAMERA_FLASH - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/camera.back.flash"</em>) </li>
<li>
CELLULAR_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.telephony"</em>) </li>
<li>
- NET_PROXY_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.net_proxy"</em>) </li>
+ DISPLAY - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/screen"</em>) </li>
+ <li>
+ ETHERNET_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.ethernet"</em>) </li>
<li>
SIM - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.telephony"</em>) </li>
+ <li>
+ NET_PROXY_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.net_proxy"</em>) </li>
+ <li>
+ WIFI_NETWORK - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/network.wifi"</em>) </li>
</ul>
<p>
For more information on the SystemInfo features, see <a href="https://developer.tizen.org/development/guides/web-application/tizen-features/system/system-information">System Information Guide</a>.
<h2>Table of Contents</h2>
<ul class="toc">
<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
-<li>1.1. <a href="#SystemInfoPropertyId">SystemInfoPropertyId</a>
+<li>
+ 1.1. <a href="#SystemInfoPropertyId">SystemInfoPropertyId</a>
</li>
-<li>1.2. <a href="#SystemInfoNetworkType">SystemInfoNetworkType</a>
+<li>
+ 1.2. <a href="#SystemInfoNetworkType">SystemInfoNetworkType</a>
</li>
-<li>1.3. <a href="#SystemInfoDeviceOrientationStatus">SystemInfoDeviceOrientationStatus</a>
+<li>
+ 1.3. <a href="#SystemInfoDeviceOrientationStatus">SystemInfoDeviceOrientationStatus</a>
</li>
-<li>1.4. <a href="#SystemInfoSimState">SystemInfoSimState</a>
+<li>
+ 1.4. <a href="#SystemInfoSimState">SystemInfoSimState</a>
</li>
-<li>1.5. <a href="#SystemInfoProfile">SystemInfoProfile</a>
+<li class="deprecated">
+ 1.5. <a href="#SystemInfoProfile">SystemInfoProfile</a>
</li>
-<li>1.6. <a href="#SystemInfoLowMemoryStatus">SystemInfoLowMemoryStatus</a>
+<li>
+ 1.6. <a href="#SystemInfoLowMemoryStatus">SystemInfoLowMemoryStatus</a>
</li>
</ul>
</li>
</li>
<li>2.2. <a href="#SystemInfo">SystemInfo</a>
</li>
-<li>2.3. <a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a>
+<li
class="deprecated">2.3. <a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a>
</li>
<li>2.4. <a href="#SystemInfoOptions">SystemInfoOptions</a>
</li>
</li>
<li>2.23. <a href="#SystemInfoMemory">SystemInfoMemory</a>
</li>
+<li>2.24. <a href="#SystemInfoCameraFlash">SystemInfoCameraFlash</a>
+</li>
</ul>
</li>
<li>3. <a href="#api-features">Related Feature</a>
</tr>
<tr>
<td><a href="#SystemInfo">SystemInfo</a></td>
-<td>long long <a href="#SystemInfo::getTotalMemory">getTotalMemory</a> ()<br>
- long long <a href="#SystemInfo::getAvailableMemory">getAvailableMemory</a> ()<br>
- <a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a> <a href="#SystemInfo::getCapabilities">getCapabilities</a> ()<br>
- any <a href="#SystemInfo::getCapability">getCapability</a> (DOMString key)<br>
- long <a href="#SystemInfo::getCount">getCount</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property)<br>
- void <a href="#SystemInfo::getPropertyValue">getPropertyValue</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertySuccessCallback">SystemInfoPropertySuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)<br>
- void <a href="#SystemInfo::getPropertyValueArray">getPropertyValueArray</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertyArraySuccessCallback">SystemInfoPropertyArraySuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)<br>
- unsigned long <a href="#SystemInfo::addPropertyValueChangeListener">addPropertyValueChangeListener</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertySuccessCallback">SystemInfoPropertySuccessCallback</a> successCallback, optional <a href="#SystemInfoOptions">SystemInfoOptions</a>? options, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)<br>
- unsigned long <a href="#SystemInfo::addPropertyValueArrayChangeListener">addPropertyValueArrayChangeListener</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertyArraySuccessCallback">SystemInfoPropertyArraySuccessCallback</a> successCallback, optional <a href="#SystemInfoOptions">SystemInfoOptions</a>? options, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)<br>
- void <a href="#SystemInfo::removePropertyValueChangeListener">removePropertyValueChangeListener</a> (unsigned long listenerId)</td>
+<td>
+<div>long long <a href="#SystemInfo::getTotalMemory">getTotalMemory</a> ()</div>
+<div>long long <a href="#SystemInfo::getAvailableMemory">getAvailableMemory</a> ()</div>
+<div class="deprecated">
+<a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a> <a href="#SystemInfo::getCapabilities">getCapabilities</a> ()</div>
+<div>any <a href="#SystemInfo::getCapability">getCapability</a> (DOMString key)</div>
+<div>long <a href="#SystemInfo::getCount">getCount</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property)</div>
+<div>void <a href="#SystemInfo::getPropertyValue">getPropertyValue</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertySuccessCallback">SystemInfoPropertySuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#SystemInfo::getPropertyValueArray">getPropertyValueArray</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertyArraySuccessCallback">SystemInfoPropertyArraySuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>unsigned long <a href="#SystemInfo::addPropertyValueChangeListener">addPropertyValueChangeListener</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertySuccessCallback">SystemInfoPropertySuccessCallback</a> successCallback, optional <a href="#SystemInfoOptions">SystemInfoOptions</a>? options, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>unsigned long <a href="#SystemInfo::addPropertyValueArrayChangeListener">addPropertyValueArrayChangeListener</a> (<a href="#SystemInfoPropertyId">SystemInfoPropertyId</a> property, <a href="#SystemInfoPropertyArraySuccessCallback">SystemInfoPropertyArraySuccessCallback</a> successCallback, optional <a href="#SystemInfoOptions">SystemInfoOptions</a>? options, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#SystemInfo::removePropertyValueChangeListener">removePropertyValueChangeListener</a> (unsigned long listenerId)</div>
+</td>
</tr>
<tr>
-<td><a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a></td>
+<td
class="deprecated"><a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a></td>
<td></td>
</tr>
<tr>
</tr>
<tr>
<td><a href="#SystemInfoPropertySuccessCallback">SystemInfoPropertySuccessCallback</a></td>
-<td>void <a href="#SystemInfoPropertySuccessCallback::onsuccess">onsuccess</a> (<a href="#SystemInfoProperty">SystemInfoProperty</a> property)</td>
+<td><div>void <a href="#SystemInfoPropertySuccessCallback::onsuccess">onsuccess</a> (<a href="#SystemInfoProperty">SystemInfoProperty</a> property)</div></td>
</tr>
<tr>
<td><a href="#SystemInfoPropertyArraySuccessCallback">SystemInfoPropertyArraySuccessCallback</a></td>
-<td>void <a href="#SystemInfoPropertyArraySuccessCallback::onsuccess">onsuccess</a> (<a href="#SystemInfoProperty">SystemInfoProperty</a>[] properties)</td>
+<td><div>void <a href="#SystemInfoPropertyArraySuccessCallback::onsuccess">onsuccess</a> (<a href="#SystemInfoProperty">SystemInfoProperty</a>[] properties)</div></td>
</tr>
<tr>
<td><a href="#SystemInfoProperty">SystemInfoProperty</a></td>
<td><a href="#SystemInfoMemory">SystemInfoMemory</a></td>
<td></td>
</tr>
+<tr>
+<td><a href="#SystemInfoCameraFlash">SystemInfoCameraFlash</a></td>
+<td><div>void <a href="#SystemInfoCameraFlash::setBrightness">setBrightness</a> (double brightness)</div></td>
+</tr>
</tbody>
</table>
<div class="typedefs" id="typedefs-section">
<div class="brief">
The device property identifier.
</div>
-<pre class="webidl prettyprint"> enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };</pre>
+<pre class="webidl prettyprint"> enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };</pre>
<p><span class="version">
Since: </span>
2.0
</p>
<p><span class="remark"> Remark : </span>
- <em>LOCALE</em> and <em>PERIPHERAL</em> are supported since Tizen 2.1
+ <em>CAMERA_FLASH</em> is supported since Tizen 3.0
</p>
<p><span class="remark"> Remark : </span>
- <em>MEMORY</em> is supported since Tizen 2.3
+ <em>ETHERNET_NETWORK</em> is supported since Tizen 3.0
</p>
<p><span class="remark"> Remark : </span>
- <em>ETHERNET_NETWORK</em> is supported since Tizen 2.4
+ <em>LOCALE</em> and <em>PERIPHERAL</em> are supported since Tizen 2.1
+ </p>
+<p><span class="remark"> Remark : </span>
+ <em>MEMORY</em> is supported since Tizen 2.3
</p>
<p><span class="remark"> Remark : </span>
<em>NET_PROXY_NETWORK</em> is supported since Tizen 3.0
<p><span class="version">
Since: </span>
2.0
-</p>
+ </p>
<p><span class="remark"> Remark : </span>
-<em>NET_PROXY</em> is supported since Tizen 3.0
+ <em>NET_PROXY</em> is supported since Tizen 3.0
</p>
</div>
<div class="enum" id="SystemInfoDeviceOrientationStatus">
2.1
</p>
</div>
-<div class="enum" id="SystemInfoProfile">
+<div class="enum deprecated" id="SystemInfoProfile">
<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfoProfile"></a><h3>1.5. SystemInfoProfile</h3>
<div class="brief">
Device Profile.
</pre>
</div>
</dd>
-<dt class="method" id="SystemInfo::getCapabilities">
+<dt class="deprecated method" id="SystemInfo::getCapabilities">
<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfo::getCapabilities"></a><code><b><span class="methodName">getCapabilities</span></b></code>
</dt>
-<dd>
+<dd class="deprecated">
<div class="brief">
Gets the capabilities of the device.
</div>
<p class="deprecated"><b>Deprecated.</b>
- Deprecated since 2.3. Instead, use getCapability().
+ Deprecated since 2.3. Instead, use getCapability().
</p>
<div class="synopsis"><pre class="signature prettyprint"><a href="#SystemInfoDeviceCapability">SystemInfoDeviceCapability</a> getCapabilities();
</pre></div>
NotSupportedError - If the given <var>property</var> is not supported. (since Tizen 2.3) </li>
</ul>
</div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
<p><span class="remark"> Remark : </span>
If the given <var>property</var> is not supported, <em>NotSupportedError</em> would be passed through a <em>ErrorCallback()</em> since Tizen 2.3.
</p>
<p><span class="remark"> Remark : </span>
If system provides more than one value for the system property, the primary(first) system property is returned through SystemInfoSuccessCallback.
</p>
+<p><span class="remark"> Remark : </span>
+ <b>http://tizen.org/privilege/telephony</b> has been required only for <a href="#SystemInfoPropertyId">CELLULAR_NETWORK</a> property since Tizen 3.0.
+ </p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
<ul>
<li class="list"><p>
with error type UnknownError in any other error case.
</p></li>
+<li class="list"><p>
+ with error type SecurityError, this error is only thrown for <em>CELLULAR_NETWORK</em> property when an application does not declare http://tizen.org/privilege/telephony privilege in config.xml.
+ </p></li>
</ul>
</li></ul>
</div>
NotSupportedError - If the given <var>property</var> is not supported. </li>
</ul>
</div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
<p><span class="remark"> Remark : </span>
see getCount().
</p>
+<p><span class="remark"> Remark : </span>
+ <b>http://tizen.org/privilege/telephony</b> has been required only for <a href="#SystemInfoPropertyId">CELLULAR_NETWORK</a> property since Tizen 3.0.
+ </p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
<ul>
</div>
<div class="exceptionlist">
<p><span class="except">Exceptions:</span></p>
- <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ <ul class="exception"><li>WebAPIException<ul>
+<li class="list"><p>
with error type TypeMismatchError, if the input parameter is not compatible with the expected type.
- </p></li></ul>
+ </p></li>
+<li class="list"><p>
+ with error type SecurityError, this error is only thrown for <em>CELLULAR_NETWORK</em> property when an application does not declare http://tizen.org/privilege/telephony privilege in config.xml.
+ </p></li>
+</ul>
</li></ul>
</div>
<div class="example">
</li>
</ul>
</div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
<p><span class="remark"> Remark : </span>
The <em>errorCallback()</em> is newly added as an optional parameter since Tizen 2.3.
</p>
+<p><span class="remark"> Remark : </span>
+ <b>http://tizen.org/privilege/telephony</b> has been required only for <a href="#SystemInfoPropertyId">CELLULAR_NETWORK</a> property since Tizen 3.0.
+ </p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
<ul>
</li>
<li class="param">
<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
- An object containing the various options for fetching the properties requested. See <a href="#SystemInfoOptions">details</a>.
+ An object containing the various options for fetching the properties requested. See <a href="./systeminfo.html#::SystemInfo::SystemInfoOptions">details</a>.
</li>
<li class="param">
<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
<li class="list"><p>
with error type UnknownError in any other error case.
</p></li>
+<li class="list"><p>
+ with error type SecurityError, this error is only thrown for <em>CELLULAR_NETWORK</em> property when an application does not declare http://tizen.org/privilege/telephony privilege in config.xml.
+ </p></li>
</ul>
</li></ul>
</div>
any identifier of these properties, but the listener added for them will not be invoked.
</p>
</div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
+<p><span class="remark"> Remark : </span>
+ <b>http://tizen.org/privilege/telephony</b> has been required only for <a href="#SystemInfoPropertyId">CELLULAR_NETWORK</a> property since Tizen 3.0.
+ </p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
<ul>
<li class="list"><p>
with error type UnknownError in any other error case.
</p></li>
+<li class="list"><p>
+ with error type SecurityError, this error is only thrown for <em>CELLULAR_NETWORK</em> property when an application does not declare http://tizen.org/privilege/telephony privilege in config.xml.
+ </p></li>
</ul>
</li></ul>
</div>
</dl>
</div>
</div>
-<div class="interface" id="SystemInfoDeviceCapability">
+<div class="interface deprecated" id="SystemInfoDeviceCapability">
<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfoDeviceCapability"></a><h3>2.3. SystemInfoDeviceCapability</h3>
<div class="brief">
SystemInfoDeviceCapability object.
2.1
</p>
</li>
-<li class="attribute" id="SystemInfoStorageUnit::isRemoveable">
+<li class="attribute deprecated" id="SystemInfoStorageUnit::isRemoveable">
<span class="attrName"><span class="readonly"> readonly
</span><span class="type">boolean </span><span class="name">isRemoveable</span></span><div class="brief">
true if this unit can be removed from the system (such as an sdcard unplugged), false otherwise.
};</pre>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
<div class="attributes">
</div>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
</li>
<li class="attribute" id="SystemInfoEthernetNetwork::status">
</div>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
</li>
<li class="attribute" id="SystemInfoEthernetNetwork::ipAddress">
</div>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
</li>
<li class="attribute" id="SystemInfoEthernetNetwork::ipv6Address">
</div>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
</li>
<li class="attribute" id="SystemInfoEthernetNetwork::macAddress">
</div>
<p><span class="version">
Since: </span>
- 2.4
+ 3.0
</p>
</li>
</ul>
<div class="interface" id="SystemInfoNetProxyNetwork">
<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfoNetProxyNetwork"></a><h3>2.20. SystemInfoNetProxyNetwork</h3>
<div class="brief">
-This property reflects the information of the net_proxy network in this system.
-</div>
-<pre class="webidl prettyprint"> [NoInterfaceObject] interface SystemInfoNetProxyNetwork : <a href="#SystemInfoProperty">SystemInfoProperty</a> {
- readonly attribute DOMString status;
-};</pre>
+ This property reflects the information of the net_proxy network in this system.
+ </div>
+<pre class="webidl prettyprint">
[NoInterfaceObject] interface SystemInfoNetProxyNetwork : <a href="#SystemInfoProperty">SystemInfoProperty</a> {
+ readonly attribute DOMString status;
+ };</pre>
<p><span class="version">
-Since: </span>
-3.0
-</p>
-<div class="attributes">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="attributes">
<h4>Attributes</h4>
<ul><li class="attribute" id="SystemInfoNetProxyNetwork::status">
-<span class="attrName"><span class="readonly"> readonly
+<span class="attrName"><span class="readonly"> readonly
</span><span class="type">DOMString </span><span class="name">status</span></span><div class="brief">
-Represents the status (ON or OFF) of the net_proxy network.
-</div>
+ Represents the status (ON or OFF) of the net_proxy network.
+ </div>
<p><span class="version">
-Since: </span>
-3.0
-</p>
+ Since: </span>
+ 3.0
+ </p>
</li></ul>
</div>
</div>
</li></ul>
</div>
</div>
+<div class="interface" id="SystemInfoCameraFlash">
+<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfoCameraFlash"></a><h3>2.24. SystemInfoCameraFlash</h3>
+<div class="brief">
+ The SystemInfoCameraFlash provides the way to control the attached the camera flash.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface SystemInfoCameraFlash : <a href="#SystemInfoProperty">SystemInfoProperty</a> {
+ readonly attribute double brightness raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
+ readonly attribute DOMString camera;
+
+ readonly attribute long levels raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
+ void setBrightness(double brightness) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };</pre>
+
+ <div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="SystemInfoCameraFlash::brightness">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">brightness</span></span><div class="brief">
+ Brightness level of the camera flash (0~1)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/led
+ </p>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ with error type SecurityError, if this attribute is not allowed.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> tizen.systeminfo.getPropertyValue("CAMERA_FLASH",
+ function (flash) {
+ console.log("Flash brightness is set to: " + (flash.brightness * 100).toFixed(0) + "%");
+ },
+ function (error) {
+ console.log("Error, name: " + error.name + ", message: " + error.message);
+ }
+ );
+ </pre>
+</div>
+</li>
+<li class="attribute" id="SystemInfoCameraFlash::camera">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">camera</span></span><div class="brief">
+ Specifies camera to which this flash belongs
+ </div>
+<div class="description">
+ <ul>
+ <li>
+BACK - back camera flash </li>
+ <li>
+FRONT - front camera flash </li>
+ <li>
+EXTERNAL - external camera flash </li>
+ <li>
+OTHER - a flash attached to any other camera </li>
+ </ul>
+ </div>
+<div class="description">
+ <p>
+The <em>getPropertyValue()</em> method retrieves the <var>SystemInfoCameraFlash</var> for <var>BACK</var> camera.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SystemInfoCameraFlash::levels">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">levels</span></span><div class="brief">
+ Number of brightness levels supported by the flash (other than 0 brightness)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/led
+ </p>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ with error type SecurityError, if this attribute is not allowed.
+ </p></li></ul>
+</li></ul>
+ </div>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="SystemInfoCameraFlash::setBrightness">
+<a class="backward-compatibility-anchor" name="::SystemInfo::SystemInfoCameraFlash::setBrightness"></a><code><b><span class="methodName">setBrightness</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sets the brightness value of the flash that is located next to the camera.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void setBrightness(double brightness);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If the specified brightness value is not supported by the device, the brightness is rounded down to the nearest supported brightness value.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/led
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">brightness</span>:
+ The brightness value of LED (0~1)
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul>
+<li class="list"><p>
+ with error type InvalidValuesError, if any of the input parameters contain an invalid value.
+ </p></li>
+<li class="list"><p>
+ with error type SecurityError, if the application does not have the privilege to call this method or if the author signature does not match that of the designated application.
+ </p></li>
+<li class="list"><p>
+ with error type UnknownError, if the method cannot be completed because of an unknown error.
+ </p></li>
+</ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> tizen.systeminfo.getPropertyValue("CAMERA_FLASH",
+ function (flash) {
+ try {
+ flash.setBrightness(1);
+ } catch (error) {
+ console.log("Setting flash brightness failed: " + error.message);
+ }
+ },
+ function (error) {
+ console.log("Error, name: " + error.name + ", message: " + error.message);
+ }
+ );
+ </pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
</div>
<h2 id="api-features">3. Related Feature</h2>
<div id="def-api-features" class="def-api-features">
<div class="def-api-feature">
<p><div class="description">
<p>
-To guarantee the running of this application on a device which supports Wi-Fi, declare the following feature requirements in the config file:
+To guarantee the running of the application on a device which has camera back flash and control it, declare the following feature requirements in the config file:
</p>
</div></p>
-<li class="feature">http://tizen.org/feature/network.wifi</li>
+<li class="feature">http://tizen.org/feature/camera.back.flash</li>
</div>
<div class="def-api-feature">
<p><div class="description">
<p>
-To guarantee the running of this application on a device which supports telephony feature, declare the following feature requirements in the config file:
+To guarantee the running of the application on a device which supports telephony feature, declare the following feature requirements in the config file:
</p>
</div></p>
<li class="feature">http://tizen.org/feature/network.telephony</li>
<div class="def-api-feature">
<p><div class="description">
<p>
-To guarantee the running of this application on a device which supports net_proxy feature, declare the following feature requirements in the config file:
+To guarantee the running of the application on a device which supports Wi-Fi, declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/network.wifi</li>
+</div>
+<div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee the running of the application on a device which supports network proxy for internet connection, declare the following feature requirements in the config file:
</p>
</div></p>
<li class="feature">http://tizen.org/feature/network.net_proxy</li>
<h2 id="full-webidl">4. Full WebIDL</h2>
<pre class="webidl prettyprint">module SystemInfo {
- enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };
+ enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };
enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "NET_PROXY", "UNKNOWN" };
};
+ [NoInterfaceObject] interface SystemInfoCameraFlash : <a href="#SystemInfoProperty">SystemInfoProperty</a> {
+ readonly attribute double brightness raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
+ readonly attribute DOMString camera;
+
+ readonly attribute long levels raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+
+ void setBrightness(double brightness) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };
+
};</pre>
</div>
<div id="page-footer">
projects / sdk / online-doc.git / commitdiff