[3.0][online-doc] Added 3.0 api documentation
authorWootak Jung <wootak.jung@samsung.com>
Mon, 21 Mar 2016 07:55:53 +0000 (16:55 +0900)
committerWootak Jung <wootak.jung@samsung.com>
Thu, 24 Mar 2016 05:14:52 +0000 (14:14 +0900)
Change-Id: I8fcf99610e5f134101da1b282856a82e6f9b1b0c
Signed-off-by: Wootak Jung <wootak.jung@samsung.com>
org.tizen.guides/html/native/telephony/telephony_info_n.htm
org.tizen.tutorials/html/native/telephony/telephony_info_tutorial_n.htm

index 4e29c74..b0dbad4 100644 (file)
   <p class="figure">Figure: Telephony APIs and Telephony Service</p> \r
   <p align="center"><img alt="Telephony APIs and Telephony Service" src="../../images/telephony.png" /></p>\r
 \r
+<h2 id="prerequisites" name="prerequisites">Prerequisites</h2>\r
+<p>To use the telephony APIs, the application has to request permission by adding the corresponding privileges to the tizen-manifest.xml file.</p>\r
+<pre class="prettyprint">\r
+&lt;privileges&gt;\r
+    &lt;privilege&gt;http://tizen.org/privilege/telephony&lt;/privilege&gt;\r
+    &lt;privilege&gt;http://tizen.org/privilege/location.coarse&lt;/privilege&gt;\r
+&lt;/privileges&gt;\r
+</pre>\r
+\r
 <h2 id="call" name="call">Call Information</h2>\r
 \r
 <p>The Call API (in <a href="../../../../org.tizen.native.mobile.apireference/group__CAPI__TELEPHONY__INFORMATION__CALL.html">mobile</a> and <a href="../../../../org.tizen.native.wearable.apireference/group__CAPI__TELEPHONY__INFORMATION__CALL.html">wearable</a> applications) provides the following functions:</p>\r
 <p>Gets the application list on the UICC. It returns one of the masking (<span style="font-family: Courier New,Courier,monospace">telephony_sim_application_type_e</span>) values.</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_sim_get_subscriber_id()</span>\r
 <p>Gets the subscriber ID as a string, which needs to be freed by the application.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_sim_get_lock_state()</span>\r
+<p>Gets the SIM card lock state. If SIM card is locked, you can use this function to retrieve lock state.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_sim_get_group_id1()</span>\r
+<p>Gets the Group Identifier Level 1(GID1) embedded in the SIM card.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_sim_get_call_forwarding_indicator_state()</span>\r
+<p>Gets the call forwarding indicator state of the SIM. If the state is true, incoming call will be forwarded to the selected number.</p></li>\r
 </ul>\r
 \r
 <p>To get SIM state change notifications, the application must register for the notifications with the <span style="font-family: Courier New,Courier,monospace">telephony_set_noti_cb()</span> function, by specifying the notification ID.</p>\r
 \r
 <p>The Network API (in <a href="../../../../org.tizen.native.mobile.apireference/group__CAPI__TELEPHONY__INFORMATION__NETWORK.html">mobile</a> and <a href="../../../../org.tizen.native.wearable.apireference/group__CAPI__TELEPHONY__INFORMATION__NETWORK.html">wearable</a> applications) provides the following functions:</p>\r
 <ul><li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_lac()</span>\r
-<p>Gets the LAC (Location Area Code) of the current network.</p></li>\r
+<p>Gets the LAC (Location Area Code) of the current location.</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_cell_id()</span>\r
-<p>Gets the cell identification number.</p></li>\r
+<p>Gets the cell ID of the current location.</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_rssi()</span>\r
 <p>Gets the RSSI (Received Signal Strength Indicator).</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_roaming_status()</span>\r
 <p>Gets the current default subscription for the data service (packet-switched). It returns one of the <span style="font-family: Courier New,Courier,monospace">telephony_network_default_data_subs_e</span> values.</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_default_subscription()</span>\r
 <p>Gets the current default subscription for the voice service (circuit-switched). It returns one of the <span style="font-family: Courier New,Courier,monospace">telephony_network_default_subs_e</span> values.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_selection_mode()</span>\r
+<p>Gets the network selection mode. If returns one of the <span style="font-family: Courier New,Courier,monospace">telephony_network_selection_mode_e</span> values.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_tac()</span>\r
+<p>Gets the TAC (Tracking Area Code) of the current location.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_system_id()</span>\r
+<p>Gets the system ID of the current location.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_network_id()</span>\r
+<p>Gets the network ID of the current location.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_base_station_id()</span>\r
+<p>Gets the base station ID of the current location.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_base_station_latitude()</span>\r
+<p>Gets the base station latitude of the current location.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_network_get_base_station_longitude()</span>\r
+<p>Gets the base station longitude of the current location.</p></li>\r
 </ul>\r
 \r
 <p>To get network-related information change notifications, the application must register for the notifications with the <span style="font-family: Courier New,Courier,monospace">telephony_set_noti_cb()</span> function, by specifying the notification ID.</p>\r
      <td>Default subscription</td>\r
      <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_DEFAULT_SUBSCRIPTION</span></td>\r
    </tr>\r
+   <tr>\r
+     <td>Location Area Code</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_LAC</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>Tracking Area Code</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_TAC</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>System ID</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_SYSTEM_ID</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>Network ID</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_NETWORK_ID</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>Base station ID</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_BS_ID</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>Base station latitude</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_BS_LATITUDE</span></td>\r
+   </tr>\r
+   <tr>\r
+     <td>Base station longitude</td>\r
+     <td><span style="font-family: Courier New,Courier,monospace">TELEPHONY_NOTI_NETWORK_BS_LONGITUDE</span></td>\r
+   </tr>\r
    </tbody> \r
   </table>\r
-\r
-<table class="note"> \r
-     <tbody> \r
-      <tr> \r
-       <th class="note">Note</th> \r
-      </tr> \r
-      <tr> \r
-       <td class="note">Before retrieving information from the network, you must retrieve the network service state. You can get network-related information only if the network service state is <span style="font-family: Courier New,Courier,monospace">TELEPHONY_NETWORK_SERVICE_STATE_IN_SERVICE</span>.</td> \r
-      </tr> \r
-     </tbody> \r
-    </table>\r
   \r
 <h2 id="modem" name="modem">Modem Information</h2>\r
 \r
 <p>Gets the IMEI (International Mobile Station Equipment Identity) of the mobile phone. You get the IMEI as a string, which needs to be freed by the application.</p></li>\r
 <li><span style="font-family: Courier New,Courier,monospace">telephony_modem_get_power_status()</span>\r
 <p>Gets the power status of the modem. It returns one of the <span style="font-family: Courier New,Courier,monospace">telephony_modem_power_status_e</span> values.</p></li>\r
+<li><span style="font-family: Courier New,Courier,monospace">telephony_modem_get_meid()</span>\r
+<p>Gets the MEID (Mobile Equipment Identifier) of a mobile phone. You get the MEID as a string, which needs to be freed by the application.</p></li>\r
 </ul>  \r
 \r
 <script type="text/javascript" src="../../scripts/jquery.zclip.min.js"></script>\r
@@ -327,4 +375,4 @@ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga
 </script>\r
 \r
 </body>\r
-</html>
\ No newline at end of file
+</html>\r
index ebd8e12..eade759 100644 (file)
        <li><a href="#modem">Getting Modem Information</a>
        <p>Access modem information.</p></li>
 </ul>
+<h2 id="prerequisites" name="prerequisites">Prerequisites</h2>
+<p>To use the telephony APIs, the application has to request permission by adding the corresponding privileges to the tizen-manifest.xml file.</p>
+<pre class="prettyprint">
+&lt;privileges&gt;
+    &lt;privilege&gt;http://tizen.org/privilege/telephony&lt;/privilege&gt;
+    &lt;privilege&gt;http://tizen.org/privilege/location.coarse&lt;/privilege&gt;
+&lt;/privileges&gt;
+</pre>
 
 
  <h2 id="init" name="init">Initializing the Telephony Service</h2>