Add a description on imei, meid, icc_id getter API

 - According to ACR-1451,
   For an application with api-version lower than 5.5,
   having public level singing and having http://tizen.org/privilege/telephony privilege,
   a pseudo value will be returned instead of permission denied error.

Change-Id: Ibc384213e293a3aa258d8b374c006b46d7875029
Signed-off-by: sinikang <sinikang@samsung.com>

diff --git a/doc/telephony_doc.h b/doc/telephony_doc.h
index 978b040..d4d4433 100644 (file)
--- a/doc/telephony_doc.h
+++ b/doc/telephony_doc.h
@@ -73,8 +73,7 @@
  *   \#include <telephony.h>
  *
  * @section CAPI_TELEPHONY_INFORMATION_NETWORK_OVERVIEW Overview
- * The Telephony Network Information API allows you to access, but not change the
- * information about the current cellular network and telephony service.
+ * The Telephony Network Information API allows you to access information about the current cellular network and telephony service, but not to change the information.
  * @section CAPI_TELEPHONY_INFORMATION_NETWORK_FEATURE Related Features
  * This API is related with the following feature:\n
  * - http://tizen.org/feature/network.telephony
@@ -97,7 +96,7 @@
  *   \#include <telephony.h>
  *
  * @section CAPI_TELEPHONY_INFORMATION_SIM_OVERVIEW Overview
- * The Telephony SIM API allows you to extract information stored on a SIM card, but not change the information.
+ * The Telephony SIM API allows you to extract information stored on a SIM card, but not to change the information.
  * @section CAPI_TELEPHONY_INFORMATION_SIM_FEATURE Related Features
  * This API is related with the following feature:\n
  * - http://tizen.org/feature/network.telephony
@@ -120,7 +119,7 @@
  *   \#include <telephony.h>
  *
  * @section CAPI_TELEPHONY_INFORMATION_MODEM_OVERVIEW Overview
- * The Telephony Modem Information API allows you to access, but not change the information about IMEI.
+ * The Telephony Modem Information API allows you to get modem information such as IMEI, but not to change the information.
  * @section CAPI_TELEPHONY_INFORMATION_MODEM_FEATURE Related Features
  * This API is related with the following feature:\n
  * - http://tizen.org/feature/network.telephony

diff --git a/include/telephony_modem.h b/include/telephony_modem.h
index 1ef8d01..c37b6a1 100644 (file)
--- a/include/telephony_modem.h
+++ b/include/telephony_modem.h
@@ -55,6 +55,39 @@ typedef enum {
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @remarks You must release @c imei using free() on success case.
+ * @remarks  Since 5.5, privilege level and return type are changed.<br>
+The following table shows the impact of changes:
+<table>
+<thead>
+<tr>
+       <th style='text-align:center;'> Version </th>
+       <th style='text-align:center;'> 5.0 and lower </th>
+       <th style='text-align:center;'> 5.5 and higher </th>
+       <th style='text-align:center;'> Remarks </th>
+       </tr>
+</thead>
+<tbody>
+       <tr>
+               <td>Privilege</td>
+               <td>http://tizen.org/privilege/telephony</td>
+               <td>http://tizen.org/privilege/securesysteminfo</td>
+                <td>The required privilege is changed.</td>
+       </tr>
+       <tr>
+               <td>Privilege level</td>
+               <td>Public</td>
+               <td>Partner</td>
+               <td>The application having partner level privilege can use this API </td>
+       </tr>
+       <tr>
+               <td>Error</td>
+               <td>#TELEPHONY_ERROR_NONE</td>
+               <td>#TELEPHONY_ERROR_PERMISSION_DENIED</td>
+                <td> If the application doesn't have the required privilege,  the error is returned.
+       </tr>
+       </tbody>
+</table>
+ * @remarks The applications developed on Tizen 5.0 and lower version having only http://tizen.org/privilege/telephony privilege should check 'permission denied' error.
  *
  * @param[in] handle The handle from telephony_init()
  * @param[out] imei The International Mobile Station Equipment Identity
@@ -100,6 +133,39 @@ int telephony_modem_get_power_status(telephony_h handle, telephony_modem_power_s
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @remarks You must release @c meid using free() on success case.
+ * @remarks  Since 5.5, privilege level and return type are changed.<br>
+The following table shows the impact of changes:
+<table>
+<thead>
+<tr>
+       <th style='text-align:center;'> Version </th>
+       <th style='text-align:center;'> 5.0 and lower </th>
+       <th style='text-align:center;'> 5.5 and higher </th>
+       <th style='text-align:center;'> Remarks </th>
+       </tr>
+</thead>
+<tbody>
+       <tr>
+               <td>Privilege</td>
+               <td>http://tizen.org/privilege/telephony</td>
+               <td>http://tizen.org/privilege/securesysteminfo</td>
+                <td>The required privilege is changed.</td>
+       </tr>
+       <tr>
+               <td>Privilege level</td>
+               <td>Public</td>
+               <td>Partner</td>
+               <td>The application having partner level privilege can use this API </td>
+       </tr>
+       <tr>
+               <td>Error</td>
+               <td>#TELEPHONY_ERROR_NONE</td>
+               <td>#TELEPHONY_ERROR_PERMISSION_DENIED</td>
+                <td> If the application doesn't have the required privilege,  the error is returned.
+       </tr>
+       </tbody>
+</table>
+ * @remarks The applications developed on Tizen 5.0 and lower version having only http://tizen.org/privilege/telephony privilege should check 'permission denied' error.
  *
  * @param[in] handle The handle from telephony_init()
  * @param[out] meid The Mobile Equipment Identifier

diff --git a/include/telephony_sim.h b/include/telephony_sim.h
index feb3d8b..491cf7e 100644 (file)
--- a/include/telephony_sim.h
+++ b/include/telephony_sim.h
@@ -77,6 +77,39 @@ typedef enum {
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @remarks You must release @c icc_id using free() on success case.
+ * @remarks  Since 5.5, privilege level and return type are changed.<br>
+The following table shows the impact of changes:
+<table>
+<thead>
+<tr>
+       <th style='text-align:center;'> Version </th>
+       <th style='text-align:center;'> 5.0 and lower </th>
+       <th style='text-align:center;'> 5.5 and higher </th>
+       <th style='text-align:center;'> Remarks </th>
+       </tr>
+</thead>
+<tbody>
+       <tr>
+               <td>Privilege</td>
+               <td>http://tizen.org/privilege/telephony</td>
+               <td>http://tizen.org/privilege/securesysteminfo</td>
+                <td>The required privilege is changed.</td>
+       </tr>
+       <tr>
+               <td>Privilege level</td>
+               <td>Public</td>
+               <td>Partner</td>
+               <td>The application having partner level privilege can use this API </td>
+       </tr>
+       <tr>
+               <td>Error</td>
+               <td>#TELEPHONY_ERROR_NONE</td>
+               <td>#TELEPHONY_ERROR_PERMISSION_DENIED</td>
+                <td> If the application doesn't have the required privilege,  the error is returned.
+       </tr>
+       </tbody>
+</table>
+ * @remarks The applications developed on Tizen 5.0 and lower version having only http://tizen.org/privilege/telephony privilege should check 'permission denied' error.
  *
  * @param[in] handle The handle from telephony_init()
  * @param[out] icc_id The Integrated Circuit Card Identification