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.
18 * @file FTelSimStateManager.h
19 * @brief This is the header file for the %SimStateManager class.
21 * This header file contains the declarations of the %SimStateManager class.
23 #ifndef _FTEL_SIM_STATE_MANAGER_H_
24 #define _FTEL_SIM_STATE_MANAGER_H_
28 #include <FTelTypes.h>
29 #include <FTelSimInfo.h>
30 #include <FTelITelephonySimEventListener.h>
31 #include <FTelISimStateManagerGetPinLockSettingResultListener.h>
34 namespace Tizen { namespace Telephony
36 class _SimStateManagerImpl;
39 * @class SimStateManager
40 * @brief This class provides methods to obtain information and events about the SIM card.
43 * The %SimStateManager class provides methods to obtain information and events about the SIM card.
46 class _OSP_EXPORT_ SimStateManager
47 : public Tizen::Base::Object
51 * 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.
55 SimStateManager(void);
58 * This destructor overrides Tizen::Base::Object::~Object().
62 virtual ~SimStateManager(void);
65 * Initializes this instance of %SimStateManager.
68 * @feature %http://tizen.org/feature/network.telephony
69 * @return An error code
71 * @exception E_SUCCESS The method is successful.
72 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
73 * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1
74 * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/manifest_features.htm">Application Filtering</a>.
75 * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
77 result Construct(void);
80 * Sets the listener for receiving SIM-related events.
85 * @privilege %http://tizen.org/privilege/telephony
87 * @return An error code
89 * @param[in] pListener An ITelephonySimEventListener instance @n
90 * The parameter can be set to @c null to remove listener.
92 * @exception E_SUCCESS The method is successful.
93 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
94 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, @n
95 * because the caller thread is a worker thread.
97 result SetSimEventListener(ITelephonySimEventListener* pListener);
100 * Requests for the PIN lock setting information. @n
101 * The %GetPinLockSetting() method is asynchronous.
106 * @privilege %http://tizen.org/privilege/telephony
108 * @return An error code
110 * @param[in] pListener An ISimStateManagerGetPinLockSettingResultListener instance
111 * @exception E_SUCCESS The method is successful.
112 * @exception E_INVALID_ARG The specified @c pListener must not be @c null.
113 * @exception E_IN_PROGRESS The previous request is in progress.
114 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
115 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
116 * @exception E_SYSTEM The method cannot proceed due to a severe system error.
117 * @see ISimStateManagerGetPinLockSettingResultListener::OnSimStateManagerGetPinLockSettingResultReceived()
119 result GetPinLockSetting(ISimStateManagerGetPinLockSettingResultListener* pListener);
122 * Gets the current state of SIM card.
127 * @privilege %http://tizen.org/privilege/telephony
129 * @return The state of SIM card, @n
130 * else @c SIM_STATE_UNKNOWN if the method fails
132 * @exception E_SUCCESS The method is successful.
133 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
135 SimState GetSimState(void) const;
138 * Gets the SIM card information.
143 * @privilege %http://tizen.org/privilege/telephony
145 * @return An error code
147 * @param[out] simInfo The SIM card information
148 * @exception E_SUCCESS The method is successful.
149 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
150 * @exception E_DEVICE_UNAVAILABLE The operation has failed due to a missing SIM card.
152 result GetSimInfo(SimInfo& simInfo) const;
156 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
158 // @param[in] rhs An instance of %SimStateManager
160 SimStateManager(const SimStateManager& rhs);
163 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
165 // @param[in] rhs An instance of %SimStateManager
167 SimStateManager& operator =(const SimStateManager& rhs);
170 _SimStateManagerImpl* __pSimStateManagerImpl;
172 friend class _SimStateManagerImpl;
173 }; // SimStateManager
175 }} // Tizen::Telephony
177 #endif // _FTEL_SIM_STATE_MANAGER_H_