Changed SysLog -> SysSecureLog.
[platform/framework/native/telephony.git] / inc / FTelSimInfo.h
index 1b6f9ca..2cbef98 100755 (executable)
@@ -45,42 +45,58 @@ class _SimInfoImpl;
  *
  * @code
  *
- *     result
- *     MyClass::GetSimInfo(void)
- *     {
- *             int mnc;
- *             int mcc;
- *             bool isAvailable;
- *             String spn;
- *             String iccId;
- *             String operatorName;
- *             SimType simType;
+ *  #include <FBase.h>
+ *  #include <FTelephony.h>
  *
- *             SimStateManager simStateManager;
- *             SimInfo simInfo;
+ *   using namespace Tizen::Base;
+ *   using namespace Tizen::Telephony;
  *
- *             result r = simStateManager.Construct();
- *             if (IsFailed(r))
- *             {
- *                     return r;
- *             }
+ *   class MyClass
+ *      : public Object
+ *   {
+ *   public:
+ *      void GetSimInfo(void);
+ *   };
  *
- *             r = simStateManager.GetSimInfo(simInfo);
- *             if (IsFailed(r))
- *             {
- *                     return r;
- *             }
+ *   void
+ *   MyClass::GetSimInfo(void)
+ *   {
+ *      int mnc;
+ *      int mcc;
+ *      bool isAvailable;
+ *      String spn;
+ *      String iccId;
+ *      String operatorName;
+ *      SimType simType;
  *
- *             mnc = simInfo.GetMnc();
- *             mcc = simInfo.GetMcc();
- *             spn = simInfo.GetSpn();
- *             iccId = simInfo.GetIccId();
- *             operatorName = simInfo.GetOperatorName();
- *             isAvailable = simInfo.IsAvailable();
- *             simType = simInfo.GetSimType();
+ *      SimStateManager* pSimStateManager = new (std::nothrow) SimStateManager();
+ *      SimInfo simInfo;
+ *
+ *      result r = pSimStateManager->Construct();
+ *      if (IsFailed(r))
+ *      {
+ *              delete pSimStateManager;
+ *              return;
+ *      }
+ *
+ *      r = pSimStateManager->GetSimInfo(simInfo);
+ *      if (IsFailed(r))
+ *      {
+ *              delete pSimStateManager;
+ *              return;
+ *      }
+ *
+ *      mnc = simInfo.GetMnc();
+ *      mcc = simInfo.GetMcc();
+ *      spn = simInfo.GetSpn();
+ *      iccId = simInfo.GetIccId();
+ *      operatorName = simInfo.GetOperatorName();
+ *      isAvailable = simInfo.IsAvailable();
+ *      simType = simInfo.GetSimType();
+ *
+ *      delete pSimStateManager;
+ *   }
  *
- *             return E_SUCCESS;
- *     }
  *
  * @endcode
  */
@@ -115,14 +131,18 @@ public:
         * Initializes this instance of %SimInfo.
         *
         * @brief   <i> [Deprecated] </i>
-        * @deprecated  This method is deprecated. Instead of using this method, it is recommended to use the SimManager::GetSimInfo() method to get the initialized SimInfo instance.
+        * @deprecated  This method is deprecated. Instead of using this method, it is recommended to use the SimStateManager::GetSimInfo() method to get the initialized %SimInfo instance.
         *
         * @since               2.0
-        *
+        * @feature %http://tizen.org/feature/network.telephony
         * @return              An error code
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_SYSTEM        The method cannot proceed due to a severe system error.
         * @exception   E_DEVICE_UNAVAILABLE    The operation has failed due to a missing SIM card.
+        * @exception   E_UNSUPPORTED_OPERATION  The Emulator or target device does not support the required feature. @b Since: @b 2.1
+        *                                                                               For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+        * @remarks     Before calling this method, check whether the feature is supported by 
+        *                      Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
         */
        result Construct(void);
 
@@ -132,7 +152,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return      The MNC of the SIM card, @n
         *              else @c -1 if the method fails
@@ -149,7 +170,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return      The MCC of the SIM card, @n
         *              else @c -1 if the method fails
@@ -166,7 +188,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return      The SPN of the SIM card, @n
         *              else an empty string if there is no SIM card in the device, or if an SPN is not assigned to the SIM card
@@ -180,12 +203,13 @@ public:
        /**
         * Gets the Integrated Circuit Card Identifier (ICCID) of the SIM card. @n
         * One useful case to detect the change of SIM cards is to store this value and compare it with the most recent value.
-        * This method provides a unique identification number for the SIM card.
+        * The %GetIccId() method provides a unique identification number for the SIM card.
         *
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return  The ICCID of the SIM card, @n
         *          else an empty string if the method fails
@@ -202,7 +226,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return      The operator name of the SIM card, @n
         *              else an empty string if there is no SIM card in the device, or if an operator name is not assigned to the SIM card
@@ -220,7 +245,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return      The phone number of the SIM card, @n
         *              else an empty string if there is no SIM card in the device, or if a Mobile Station International Subscriber Directory Number
@@ -239,7 +265,7 @@ public:
         * @since       2.0
         *
         * @privlevel  partner
-        * @privilege   http://tizen.org/privilege/useridentity
+        * @privilege   %http://tizen.org/privilege/useridentity
         *
         * @return      The IMSI of the SIM card, @n
         *              else an empty string if the method fails
@@ -257,7 +283,7 @@ public:
         * @since       2.1
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+        * @privilege   %http://tizen.org/privilege/telephony
         *
         * @return              The type of SIM card
         *
@@ -275,7 +301,8 @@ public:
         * @since       2.0
         *
         * @privlevel   public
-        * @privilege   http://tizen.org/privilege/telephony
+     * @privilege   %http://tizen.org/privilege/telephony @n
+     *                                 (%http://tizen.org/privilege/systeminfo is deprecated.)
         *
         * @return  @c true if the SIM card is present in the device, @n
         *          else @c false
@@ -301,8 +328,8 @@ public:
         *
         * @return              @c true if the values match, @n
         *                              else @c false
-        * @param[in]   rhs     The other Object to be compared
-        * @see                 Object::Equals()
+        * @param[in]   rhs     The other Tizen::Base::Object to compare
+        * @see                 Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Tizen::Base::Object& rhs) const;
 
@@ -311,7 +338,7 @@ public:
         *
         * @since               2.0
         *
-        * @return      The current instance's hash value
+        * @return      The hash value of the current instance
         */
        virtual int GetHashCode(void) const;