inc/FTelSimStateManager.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16 //
  17 /**
  18  * @file        FTelSimStateManager.h
  19  * @brief       This is the header file for the %SimStateManager class.
  20  *
  21  * This header file contains the declarations of the %SimStateManager class.
  22  */
  23 #ifndef _FTEL_SIM_STATE_MANAGER_H_
  24 #define _FTEL_SIM_STATE_MANAGER_H_
  25
  26
  27 #include <FBase.h>
  28 #include <FTelTypes.h>
  29 #include <FTelSimInfo.h>
  30 #include <FTelITelephonySimEventListener.h>
  31 #include <FTelISimStateManagerGetPinLockSettingResultListener.h>
  32
  33
  34 namespace Tizen { namespace Telephony
  35 {
  36 class _SimStateManagerImpl;
  37
  38 /**
  39  * @class       SimStateManager
  40  * @brief       This class provides methods to obtain information and events about the SIM card.
  41  * @since       2.1
  42  *
  43  * The %SimStateManager class provides methods to obtain information and events about the SIM card.
  44  *
  45  */
  46 class _OSP_EXPORT_ SimStateManager
  47         : public Tizen::Base::Object
  48 {
  49 public:
  50         /**
  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.
  52          *
  53          * @since       2.1
  54          */
  55         SimStateManager(void);
  56
  57         /**
  58          * This destructor overrides Tizen::Base::Object::~Object().
  59          *
  60          * @since       2.1
  61          */
  62         virtual ~SimStateManager(void);
  63
  64         /**
  65          * Initializes a new instance of this class.
  66          *
  67          * @since       2.1
  68          *
  69          * @return      An error code
  70          *
  71          * @exception   E_SUCCESS                               The method is successful.
  72          * @exception   E_SYSTEM                                The method cannot proceed due to a severe system error.
  73          */
  74         result Construct(void);
  75
  76         /**
  77          * Sets the listener for receiving SIM related events.
  78          *
  79          * @since   2.1
  80          *
  81          * @privlevel   public
  82          * @privilege   http://tizen.org/privilege/telephony
  83          *
  84          * @return  An error code
  85          *
  86          * @param[in]   pListener                               An ITelephonySimEventListener instance @n
  87          *                                                                              The parameter can be set to @c null to remove listener.
  88          *
  89          * @exception   E_SUCCESS                               The method is successful.
  90          * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
  91          * @exception   E_INVALID_OPERATION             The current state of the instance prohibits the execution of the specified operation, @n
  92          *                                                                              because the caller thread is a worker thread.
  93          */
  94         result SetSimEventListener(ITelephonySimEventListener* pListener);
  95
  96         /**
  97          * Requests the PIN lock setting information. @n
  98          * This method is asynchronous.
  99          *
 100          * @since   2.1
 101          *
 102          * @privlevel   public
 103          * @privilege   http://tizen.org/privilege/telephony
 104          *
 105          * @return  An error code
 106          *
 107          * @param[in]   pListener                               An ISimStateManagerGetPinLockSettingResultListener instance
 108          *
 109          * @exception   E_SUCCESS                               The method is successful.
 110          * @exception   E_INVALID_ARG                   The specified @c pListener must not be @c null.
 111          * @exception   E_IN_PROGRESS                   The previous request is in progress.
 112          * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
 113          * @exception   E_DEVICE_UNAVAILABLE    The operation has failed due to a missing SIM card.
 114          * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
 115          * @see ISimStateManagerGetPinLockSettingResultListener::OnSimStateManagerGetPinLockSettingResultReceived()
 116          */
 117         result GetPinLockSetting(ISimStateManagerGetPinLockSettingResultListener* pListener);
 118
 119         /**
 120          * Gets the current state of SIM card.
 121          *
 122          * @since   2.1
 123          *
 124          * @privlevel   public
 125          * @privilege   http://tizen.org/privilege/telephony
 126          *
 127          * @return      The state of SIM card, @n
 128          *                              else SIM_STATE_UNKNOWN if the method fails
 129          *
 130          * @exception   E_SUCCESS                               The method is successful.
 131          * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
 132          */
 133         SimState GetSimState(void) const;
 134
 135         /**
 136          * Gets the SIM card information.
 137          *
 138          * @since   2.1
 139          *
 140          * @privlevel   public
 141          * @privilege   http://tizen.org/privilege/telephony
 142          *
 143          * @return  An error code
 144          *
 145          * @param[out]  simInfo                                 The SIM card information
 146          *
 147          * @exception   E_SUCCESS                               The method is successful.
 148          * @exception   E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
 149          * @exception   E_DEVICE_UNAVAILABLE    The operation has failed due to a missing SIM card.
 150          */
 151         result GetSimInfo(SimInfo& simInfo) const;
 152
 153 private:
 154         //
 155         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 156         //
 157         // @param[in]   rhs   An instance of %SimStateManager
 158         //
 159         SimStateManager(const SimStateManager& rhs);
 160
 161         //
 162         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 163         //
 164         // @param[in]   rhs An instance of %SimStateManager
 165         //
 166         SimStateManager& operator =(const SimStateManager& rhs);
 167
 168 private:
 169         _SimStateManagerImpl* __pSimStateManagerImpl;
 170
 171         friend class _SimStateManagerImpl;
 172 }; // SimStateManager
 173
 174 }} // Tizen::Telephony
 175
 176 #endif // _FTEL_SIM_STATE_MANAGER_H_