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.
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 device does not support the telephony feature. @b Since: @b 2.1
128 result Construct(void);
131 * Gets the Mobile Network Code (MNC) of the SIM International Mobile Subscriber Identity (IMSI) information.
136 * @privilege %http://tizen.org/privilege/telephony
138 * @return The MNC of the SIM card, @n
139 * else @c -1 if the method fails
140 * @exception E_SUCCESS The method is successful.
141 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
142 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
143 * @remarks The specific error code can be accessed using the GetLastResult() method.
145 int GetMnc(void) const;
148 * Gets the Mobile Country Code (MCC) of the SIM IMSI information.
153 * @privilege %http://tizen.org/privilege/telephony
155 * @return The MCC of the SIM card, @n
156 * else @c -1 if the method fails
157 * @exception E_SUCCESS The method is successful.
158 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
159 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
160 * @remarks The specific error code can be accessed using the GetLastResult() method.
162 int GetMcc(void) const;
165 * Gets the Service Provider Name (SPN) string of the SIM card.
170 * @privilege %http://tizen.org/privilege/telephony
172 * @return The SPN of the SIM card, @n
173 * else an empty string if there is no SIM card in the device, or if an SPN is not assigned to the SIM card
174 * @exception E_SUCCESS The method is successful.
175 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
176 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
177 * @remarks The specific error code can be accessed using the GetLastResult() method.
179 Tizen::Base::String GetSpn(void) const;
182 * Gets the Integrated Circuit Card Identifier (ICCID) of the SIM card. @n
183 * One useful case to detect the change of SIM cards is to store this value and compare it with the most recent value.
184 * The %GetIccId() method provides a unique identification number for the SIM card.
189 * @privilege %http://tizen.org/privilege/telephony
191 * @return The ICCID of the SIM card, @n
192 * else an empty string if the method fails
193 * @exception E_SUCCESS The method is successful.
194 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
195 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
196 * @remarks The specific error code can be accessed using the GetLastResult() method.
198 Tizen::Base::String GetIccId(void) const;
201 * Gets the operator name of Common PCN Handset Specification (CPHS) of the SIM card.
206 * @privilege %http://tizen.org/privilege/telephony
208 * @return The operator name of the SIM card, @n
209 * 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
210 * @exception E_SUCCESS The method is successful.
211 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
212 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
213 * @remarks If this method has failed, then this method returns an empty string.
214 * @remarks The specific error code can be accessed using the GetLastResult() method.
216 Tizen::Base::String GetOperatorName(void) const;
219 * Gets the phone number of the SIM card.
224 * @privilege %http://tizen.org/privilege/telephony
226 * @return The phone number of the SIM card, @n
227 * else an empty string if there is no SIM card in the device, or if a Mobile Station International Subscriber Directory Number
228 * (MSISDN) is not assigned to the SIM card
229 * @exception E_SUCCESS The method is successful.
230 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
231 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
232 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
233 * @remarks The specific error code can be accessed using the GetLastResult() method.
235 Tizen::Base::String GetPhoneNumber(void) const;
238 * Gets the International Mobile Subscriber Identity (IMSI) of the SIM card.
243 * @privilege %http://tizen.org/privilege/useridentity
245 * @return The IMSI of the SIM card, @n
246 * else an empty string if the method fails
247 * @exception E_SUCCESS The method is successful.
248 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
249 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
250 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
251 * @remarks The specific error code can be accessed using the GetLastResult() method.
253 Tizen::Base::String GetImsi(void) const;
256 * Gets the type of SIM card.
261 * @privilege %http://tizen.org/privilege/telephony
263 * @return The type of SIM card
265 * @exception E_SUCCESS The method is successful.
266 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
267 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
268 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
269 * @remarks The specified error code can be accessed using the GetLastResult() method.
271 SimType GetSimType(void) const;
274 * Checks whether a SIM card is present in the device or not.
279 * @privilege %http://tizen.org/privilege/telephony
281 * @return @c true if the SIM card is present in the device, @n
283 * @exception E_SUCCESS The method is successful.
284 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
285 * @remarks The specific error code can be accessed using the GetLastResult() method.
287 bool IsAvailable(void) const;
290 * Copying of objects using this copy assignment operator is allowed.
294 * @param[in] rhs An instance of %SimInfo
296 SimInfo& operator =(const SimInfo& rhs);
299 * Compares the specified instance of %SimInfo with the calling instance.
303 * @return @c true if the values match, @n
305 * @param[in] rhs The other Tizen::Base::Object to compare
306 * @see Tizen::Base::Object::Equals()
308 virtual bool Equals(const Tizen::Base::Object& rhs) const;
311 * Gets the hash value of the current instance.
315 * @return The hash value of the current instance
317 virtual int GetHashCode(void) const;
320 _SimInfoImpl* __pSimInfoImpl;
322 friend class _SimInfoImpl;
325 }} // Tizen::Telephony
327 #endif // _FTEL_SIM_INFO_H_