#include <FBase.h>
+#include <FTelTypes.h>
namespace Tizen { namespace Telephony
{
class _SimInfoImpl;
+
/**
* @class SimInfo
* @brief This class provides information of the currently inserted SIM card.
* String spn;
* String iccId;
* String operatorName;
+ * SimType simType;
+ *
+ * SimStateManager simStateManager;
+ * SimInfo simInfo;
*
- * SimInfo* pSimInfo = new SimInfo();
+ * result r = simStateManager.Construct();
+ * if (IsFailed(r))
+ * {
+ * return r;
+ * }
*
- * result r = pSimInfo->Construct();
+ * r = simStateManager.GetSimInfo(simInfo);
* if (IsFailed(r))
* {
- * delete pSimInfo;
* return r;
* }
*
- * mnc = pSimInfo->GetMnc();
- * mcc = pSimInfo->GetMcc();
- * spn = pSimInfo->GetSpn();
- * iccId = pSimInfo->GetIccId();
- * operatorName = pSimInfo->GetOperatorName();
- * isAvailable = pSimInfo->IsAvailable();
+ * mnc = simInfo.GetMnc();
+ * mcc = simInfo.GetMcc();
+ * spn = simInfo.GetSpn();
+ * iccId = simInfo.GetIccId();
+ * operatorName = simInfo.GetOperatorName();
+ * isAvailable = simInfo.IsAvailable();
+ * simType = simInfo.GetSimType();
*
- * delete pSimInfo;
* return E_SUCCESS;
* }
*
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
- *
- * @since 2.0
- */
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ */
SimInfo(void);
/**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
+ * Copying of objects using this copy constructor is allowed.
+ *
+ * @since 2.1
+ *
+ * @param[in] rhs An instance of %SimInfo
+ */
+ SimInfo(const SimInfo& rhs);
+
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
virtual ~SimInfo(void);
/**
- * Initializes this instance of %SimInfo.
- *
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
- */
+ * 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 SimStateManager::GetSimInfo() method to get the initialized %SimInfo instance.
+ *
+ * @since 2.0
+ *
+ * @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 device does not support the telephony feature. @b Since: @b 2.1
+ */
result Construct(void);
/**
- * Gets the Mobile Network Code (MNC) of the SIM International Mobile Subscriber Identity (IMSI) information.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * Gets the Mobile Network Code (MNC) of the SIM International Mobile Subscriber Identity (IMSI) information.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
int GetMnc(void) const;
/**
- * Gets the Mobile Country Code (MCC) of the SIM IMSI information.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * Gets the Mobile Country Code (MCC) of the SIM IMSI information.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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.
+ * @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
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * Gets the Service Provider Name (SPN) string of the SIM card.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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.
+ * @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.
- * This method provides a unique identification number for the SIM card.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * 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.
+ * 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.
+ * @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.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- */
+ * Gets the operator name of Common PCN Handset Specification (CPHS) of the SIM card.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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.
+ */
Tizen::Base::String GetOperatorName(void) const;
/**
- * Gets the phone number of the SIM card.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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
- * (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 A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ * Gets the phone number of the SIM card.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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
+ * (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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
Tizen::Base::String GetPhoneNumber(void) const;
/**
- * @if VISPARTNER
- * Gets the International Mobile Subscriber Identity (IMSI) of the SIM card.
- *
- * @since 2.0
- *
- * @visibility partner
- * @privilege %http://tizen.org/privilege/useridentity
- *
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @endif
- */
+ * Gets the International Mobile Subscriber Identity (IMSI) of the SIM card.
+ *
+ * @since 2.0
+ *
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/useridentity
+ *
+ * @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
Tizen::Base::String GetImsi(void) const;
/**
- * Checks whether a SIM card is present in the device or not.
- *
- * @since 2.0
- *
- * @privilege %http://tizen.org/privilege/systeminfo
- *
- * @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.
- */
- bool IsAvailable(void) const;
+ * Gets the type of SIM card.
+ *
+ * @since 2.1
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @return The type of 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.
+ * @remarks The specified error code can be accessed using the GetLastResult() method.
+ */
+ SimType GetSimType(void) const;
-private:
/**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %SimInfo
- */
- SimInfo(const SimInfo& rhs);
+ * Checks whether a SIM card is present in the device or not.
+ *
+ * @since 2.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/telephony
+ *
+ * @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.
+ */
+ bool IsAvailable(void) const;
/**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %SimInfo
- */
+ * Copying of objects using this copy assignment operator is allowed.
+ *
+ * @since 2.1
+ *
+ * @param[in] rhs An instance of %SimInfo
+ */
SimInfo& operator =(const SimInfo& rhs);
+ /**
+ * Compares the specified instance of %SimInfo with the calling 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
+ * @see Tizen::Base::Object::Equals()
+ */
+ virtual bool Equals(const Tizen::Base::Object& rhs) const;
+
+ /**
+ * Gets the hash value of the current instance.
+ *
+ * @since 2.0
+ *
+ * @return The hash value of the current instance
+ */
+ virtual int GetHashCode(void) const;
+
private:
_SimInfoImpl* __pSimInfoImpl;
}; // SimInfo
}} // Tizen::Telephony
+
#endif // _FTEL_SIM_INFO_H_
projects / platform / framework / native / telephony.git / blobdiff