/**
* @class SimInfo
- * @brief This class provides information of the currently inserted SIM card.
+ * @brief This class provides the information of a currently inserted SIM card.
* @since 2.0
*
- * The %SimInfo class provides methods to get information from the SIM card such as MCC, MNC, SPN, ICC ID, the name of operator,
+ * The %SimInfo class provides methods to obtain SIM card information, such as the MCC, the MNC, the SPN, the ICC ID, the name of the operator,
* and whether the SIM card is available or not.
*
- * The following example demonstrates how to use the %SimInfo class to get the SIM information.
+ * The following example demonstrates how to use the %SimInfo class to obtain the SIM information.
*
* @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
*/
*
* @since 2.1
*
- * @param[in] rhs An instance of %SimInfo
+ * @param[in] rhs An instance of %SimInfo to copy
*/
SimInfo(const SimInfo& rhs);
/**
* Initializes this instance of %SimInfo.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @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
+ * @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_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 because the SIM card is not ready.
* @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() methods.
+ * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(void);
/**
* Gets the Mobile Network Code (MNC) of the SIM International Mobile Subscriber Identity (IMSI) information.
*
- * @since 2.0
+ * @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
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetMnc(void) const;
* @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
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetMcc(void) const;
/**
* Gets the Service Provider Name (SPN) string of the SIM card.
*
- * @since 2.0
+ * @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
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * else an empty string if there is no SIM card in the device, or the SPN is not assigned to the SIM card
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetSpn(void) const;
/**
* 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.
+ * One useful way to detect the change of SIM cards is to store this value and compare it with the most recent value.
* The %GetIccId() method provides a unique identification number for the SIM card.
*
* @since 2.0
*
* @privlevel public
- * @privilege %http://tizen.org/privilege/telephony
- *
- * @return The ICCID of the SIM card, @n
- * else an empty string if the method fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @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
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetIccId(void) const;
/**
- * Gets the operator name of Common PCN Handset Specification (CPHS) of the SIM card.
+ * Gets the operator name of the Common PCN Handset Specification (CPHS) of the SIM card.
*
- * @since 2.0
+ * @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
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks If this method has failed, then this method returns an empty string.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * else an empty string if there is no SIM card in the device, or the operator name is not assigned to the SIM card
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - If this method fails, then an empty string is returned.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetOperatorName(void) const;
/**
* Gets the phone number of the SIM card.
*
- * @since 2.0
+ * @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
+ * else an empty string if there is no SIM card in the device, or the Mobile Station International Subscriber Directory Number
* (MSISDN) is not assigned to the SIM card
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetPhoneNumber(void) const;
/**
* Gets the International Mobile Subscriber Identity (IMSI) of the SIM card.
*
- * @since 2.0
+ * @since 2.0
*
* @privlevel partner
- * @privilege %http://tizen.org/privilege/useridentity
+ * @privilege %http://tizen.org/privilege/systemmanager @n
+ * (%http://tizen.org/privilege/useridentity is deprecated.)
*
* @return The IMSI of the SIM card, @n
* else an empty string if the method fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetImsi(void) const;
/**
- * Gets the type of SIM card.
+ * Gets the SIM card type.
*
* @since 2.1
*
* @privlevel public
* @privilege %http://tizen.org/privilege/telephony
*
- * @return The type of SIM card
+ * @return The SIM card type
*
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The operation has failed because the SIM card is missing
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specified error code can be accessed using the GetLastResult() method.
*/
SimType GetSimType(void) const;
/**
- * Checks whether a SIM card is present in the device or not.
+ * Checks whether the SIM card is present in the device or not.
*
* @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
- * @exception E_SUCCESS The method is successful.
+ * @return @c true if the SIM card is present in the device, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
*
* @since 2.1
*
- * @param[in] rhs An instance of %SimInfo
+ * @param[in] rhs An instance of %SimInfo to copy
*/
SimInfo& operator =(const SimInfo& rhs);
/**
- * Compares the specified instance of %SimInfo with the calling instance.
+ * Compares the specified instance of %SimInfo with the current instance.
*
* @since 2.0
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] rhs The other Tizen::Base::Object to compare
+ * @param[in] rhs The Tizen::Base::Object to compare
* @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
projects / platform / framework / native / telephony.git / blobdiff