2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @brief This is the header file for the %SimInfo class.
21 * This header file contains the declarations of the %SimInfo class.
23 #ifndef _FTEL_SIM_INFO_H_
24 #define _FTEL_SIM_INFO_H_
28 #include <FTelTypes.h>
31 namespace Tizen { namespace Telephony
38 * @brief This class provides information of the currently inserted SIM card.
41 * The %SimInfo class provides methods to get information from the SIM card such as MCC, MNC, SPN, ICC ID, the name of operator,
42 * and whether the SIM card is available or not.
44 * The following example demonstrates how to use the %SimInfo class to get the SIM information.
49 * MyClass::GetSimInfo(void)
56 * String operatorName;
59 * SimStateManager simStateManager;
62 * result r = simStateManager.Construct();
68 * r = simStateManager.GetSimInfo(simInfo);
74 * mnc = simInfo.GetMnc();
75 * mcc = simInfo.GetMcc();
76 * spn = simInfo.GetSpn();
77 * iccId = simInfo.GetIccId();
78 * operatorName = simInfo.GetOperatorName();
79 * isAvailable = simInfo.IsAvailable();
80 * simType = simInfo.GetSimType();
87 class _OSP_EXPORT_ SimInfo
88 : public Tizen::Base::Object
92 * This is the default constructor for this class.
99 * Copying of objects using this copy constructor is allowed.
103 * @param[in] rhs An instance of %SimInfo
105 SimInfo(const SimInfo& rhs);
108 * This destructor overrides Tizen::Base::Object::~Object().
112 virtual ~SimInfo(void);
115 * Initializes this instance of %SimInfo.
117 * @brief <i> [Deprecated] </i>
118 * @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.
121 * @feature %http://tizen.org/feature/network.telephony
122 * @return An error code
123 * @exception E_SUCCESS The method is successful.
124 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
125 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
126 * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
127 * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
128 * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
130 result Construct(void);
133 * Gets the Mobile Network Code (MNC) of the SIM International Mobile Subscriber Identity (IMSI) information.
138 * @privilege %http://tizen.org/privilege/telephony
140 * @return The MNC of the SIM card, @n
141 * else @c -1 if the method fails
142 * @exception E_SUCCESS The method is successful.
143 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
144 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
145 * @remarks The specific error code can be accessed using the GetLastResult() method.
147 int GetMnc(void) const;
150 * Gets the Mobile Country Code (MCC) of the SIM IMSI information.
155 * @privilege %http://tizen.org/privilege/telephony
157 * @return The MCC of the SIM card, @n
158 * else @c -1 if the method fails
159 * @exception E_SUCCESS The method is successful.
160 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
161 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
162 * @remarks The specific error code can be accessed using the GetLastResult() method.
164 int GetMcc(void) const;
167 * Gets the Service Provider Name (SPN) string of the SIM card.
172 * @privilege %http://tizen.org/privilege/telephony
174 * @return The SPN of the SIM card, @n
175 * else an empty string if there is no SIM card in the device, or if an SPN is not assigned to the SIM card
176 * @exception E_SUCCESS The method is successful.
177 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
178 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
179 * @remarks The specific error code can be accessed using the GetLastResult() method.
181 Tizen::Base::String GetSpn(void) const;
184 * Gets the Integrated Circuit Card Identifier (ICCID) of the SIM card. @n
185 * One useful case to detect the change of SIM cards is to store this value and compare it with the most recent value.
186 * The %GetIccId() method provides a unique identification number for the SIM card.
191 * @privilege %http://tizen.org/privilege/telephony
193 * @return The ICCID of the SIM card, @n
194 * else an empty string if the method fails
195 * @exception E_SUCCESS The method is successful.
196 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
197 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
198 * @remarks The specific error code can be accessed using the GetLastResult() method.
200 Tizen::Base::String GetIccId(void) const;
203 * Gets the operator name of Common PCN Handset Specification (CPHS) of the SIM card.
208 * @privilege %http://tizen.org/privilege/telephony
210 * @return The operator name of the SIM card, @n
211 * 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
212 * @exception E_SUCCESS The method is successful.
213 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
214 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
215 * @remarks If this method has failed, then this method returns an empty string.
216 * @remarks The specific error code can be accessed using the GetLastResult() method.
218 Tizen::Base::String GetOperatorName(void) const;
221 * Gets the phone number of the SIM card.
226 * @privilege %http://tizen.org/privilege/telephony
228 * @return The phone number of the SIM card, @n
229 * else an empty string if there is no SIM card in the device, or if a Mobile Station International Subscriber Directory Number
230 * (MSISDN) is not assigned to the SIM card
231 * @exception E_SUCCESS The method is successful.
232 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
233 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
234 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
235 * @remarks The specific error code can be accessed using the GetLastResult() method.
237 Tizen::Base::String GetPhoneNumber(void) const;
240 * Gets the International Mobile Subscriber Identity (IMSI) of the SIM card.
245 * @privilege %http://tizen.org/privilege/useridentity
247 * @return The IMSI of the SIM card, @n
248 * else an empty string if the method fails
249 * @exception E_SUCCESS The method is successful.
250 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
251 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
252 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
253 * @remarks The specific error code can be accessed using the GetLastResult() method.
255 Tizen::Base::String GetImsi(void) const;
258 * Gets the type of SIM card.
263 * @privilege %http://tizen.org/privilege/telephony
265 * @return The type of SIM card
267 * @exception E_SUCCESS The method is successful.
268 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
269 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
270 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
271 * @remarks The specified error code can be accessed using the GetLastResult() method.
273 SimType GetSimType(void) const;
276 * Checks whether a SIM card is present in the device or not.
281 * @privilege %http://tizen.org/privilege/telephony
283 * @return @c true if the SIM card is present in the device, @n
285 * @exception E_SUCCESS The method is successful.
286 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
287 * @remarks The specific error code can be accessed using the GetLastResult() method.
289 bool IsAvailable(void) const;
292 * Copying of objects using this copy assignment operator is allowed.
296 * @param[in] rhs An instance of %SimInfo
298 SimInfo& operator =(const SimInfo& rhs);
301 * Compares the specified instance of %SimInfo with the calling instance.
305 * @return @c true if the values match, @n
307 * @param[in] rhs The other Tizen::Base::Object to compare
308 * @see Tizen::Base::Object::Equals()
310 virtual bool Equals(const Tizen::Base::Object& rhs) const;
313 * Gets the hash value of the current instance.
317 * @return The hash value of the current instance
319 virtual int GetHashCode(void) const;
322 _SimInfoImpl* __pSimInfoImpl;
324 friend class _SimInfoImpl;
327 }} // Tizen::Telephony
329 #endif // _FTEL_SIM_INFO_H_