inc/FTelCallManager.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  FTelCallManager.h
  19  * @brief This is the header file for the %CallManager class.
  20  *
  21  * This header file contains the declarations of the %CallManager class.
  22  */
  23 #ifndef _FTEL_CALL_MANAGER_H_
  24 #define _FTEL_CALL_MANAGER_H_
  25
  26
  27 #include <FBase.h>
  28 #include <FTelTypes.h>
  29 #include <FTelCallInfo.h>
  30 #include <FTelITelephonyCallEventListener.h>
  31 #include <FTelITelephonyCallForwardListener.h>
  32
  33
  34 namespace Tizen { namespace Telephony
  35 {
  36 class _CallManagerImpl;
  37
  38 /**
  39  * @class       CallManager
  40  * @brief       This class provides methods to obtain information about the current call.
  41  *
  42  * @since       2.0
  43  *
  44  * The %CallManager class provides methods to obtain information about the current call type and its status.
  45  *
  46  * The following example demonstrates how to use the %CallManager class to obtain information about a call.
  47  *
  48  * @code
  49  *
  50  *      result
  51  *      MyClass::GetCallInfo(void)
  52  *      {
  53  *              CallType callType = TYPE_UNDEFINED_CALL;
  54  *              CallStatus callStatus = CALL_STATUS_UNDEFINED;
  55  *
  56  *              CallManager* pCallManager = new CallManager();
  57  *
  58  *              result r = pCallManager->Construct(*this);
  59  *              if (IsFailed(r))
  60  *              {
  61  *                      delete pCallManager;
  62  *                      return r;
  63  *              }
  64  *
  65  *              callStatus = pCallManager->GetCurrentCallStatus();
  66  *
  67  *              if (callStatus == CALL_STATUS_COMMUNICATING)
  68  *              {
  69  *                      callType = pCallManager->GetCurrentCallType();
  70  *              }
  71  *
  72  *              delete pCallManager;
  73  *              return E_SUCCESS;
  74  *      }
  75  *
  76  *      void
  77  *      MyClass::OnTelephonyCallStatusChangedN(CallStatus  callStatus,CallInfo *  pCallInfo)
  78  *      {
  79  *              CallType        callType;
  80  *              String          number;
  81  *
  82  *              if (callStatus == CALL_STATUS_RINGING)
  83  *              {
  84  *                      callType  = pCallInfo->GetCallType();
  85  *                      number = pCallInfo->GetNumber();
  86  *              }
  87  *
  88  *              delete pCallInfo;
  89  *      }
  90  *
  91  *
  92  * @endcode
  93  */
  94 class _OSP_EXPORT_ CallManager
  95         : public Tizen::Base::Object
  96 {
  97 public:
  98         /**
  99      *   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.
 100      *
 101      * @since   2.0
 102      */
 103         CallManager(void);
 104
 105         /**
 106      * This destructor overrides Tizen::Base::Object::~Object().
 107      *
 108      * @since   2.0
 109      */
 110         virtual ~CallManager(void);
 111
 112         /**
 113      * Initializes a new instance of this class. @n
 114      * This is the two phase construction.
 115      *
 116      * @since   2.0
 117          *
 118      * @return  An error code
 119      * @exception   E_SUCCESS           The method is successful.
 120      * @exception   E_SYSTEM            A system error has occurred.
 121      */
 122         result Construct(void);
 123
 124         /**
 125      * Initializes a new instance of this class. @n
 126      * This is the two phase construction.
 127      *
 128      * @since   2.0
 129          *
 130      * @return  An error code
 131      * @param[in]   listener  The listener for change in status of a call
 132      * @exception   E_SUCCESS The method is successful.
 133      * @exception   E_SYSTEM  A system error has occurred.
 134      * @see ITelephonyCallEventListener
 135      */
 136         result Construct(ITelephonyCallEventListener& listener);
 137
 138         /**
 139      * @if VISPARTNER-OPERATOR
 140      * Sets the listener that listens to the call forwarding request.
 141      *
 142      * @since   2.0
 143          *
 144      * @visibility  partner-operator
 145      * @privilege   %http://tizen.org/privilege/callforward
 146      *
 147      * @return  An error code
 148      * @param[in]   pListener           An ITelephonyCallForwardListener instance @n
 149      *                                  The parameter can be set to @c null to remove listener.
 150      * @exception   E_SUCCESS           The method is successful.
 151      * @exception   E_PRIVILEGE_DENIED  The application does not have the privilege to call this method.
 152      * @exception   E_SYSTEM            A system error has occurred.
 153      *
 154      * @endif
 155      */
 156         result SetCallForwardListener(ITelephonyCallForwardListener* pListener);
 157
 158         /**
 159      * @if VISPARTNER-OPERATOR
 160      * Requests call forwarding with the specified number. @n
 161      * This method sends the request to the network, and receives the response asynchronously.
 162      *
 163      * @since   2.0
 164          *
 165      * @visibility  partner-operator
 166      * @privilege   %http://tizen.org/privilege/callforward
 167      *
 168      * @return  An error code
 169      * @param[in]   phoneNumber The phone number for call forwarding
 170      * @exception   E_SUCCESS               The method is successful.
 171      * @exception   E_INVALID_STATE         This instance is in an invalid state.
 172      * @exception   E_INVALID_FORMAT        The specified phone number is in an invalid format.
 173      * @exception   E_IN_PROGRESS           The previous request is in progress.
 174      * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
 175      * @exception   E_NETWORK_UNAVAILABLE   The operation has failed because the device is in the offline mode.
 176      * @exception   E_SERVICE_UNAVAILABLE   The operation has failed because the device is out of the coverage area or in the emergency mode.
 177      * @exception   E_SYSTEM                A system error has occurred.
 178      * @remarks The call will be forwarded unconditionally. Voice call only. @n
 179      *          The phone number can start with plus(+) and the remaining part must be number.
 180      * @see ITelephonyCallForwardListener::OnTelephonyCallForwardResponseReceived()
 181      *
 182      * @endif
 183      */
 184         result RequestCallForward(const Tizen::Base::String& phoneNumber);
 185
 186     /**
 187      * @if VISPARTNER-OPERATOR
 188      * Stops call forwarding.
 189      *
 190      * @since   2.0
 191          *
 192      * @visibility  partner-operator
 193      * @privilege   %http://tizen.org/privilege/callforward
 194      *
 195      * @return  An error code
 196      * @exception   E_SUCCESS               The method is successful.
 197       @exception    E_INVALID_STATE         This instance is in an invalid state.
 198      * @exception   E_IN_PROGRESS           The previous request is in progress.
 199      * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
 200      * @exception   E_NETWORK_UNAVAILABLE   The operation has failed because the device is in the offline mode.
 201      * @exception   E_SERVICE_UNAVAILABLE   The operation has failed because the device is out of the coverage area or in the emergency mode.
 202      * @exception   E_SYSTEM                A system error has occurred.
 203      * @see ITelephonyCallForwardListener::OnTelephonyCallForwardStopped()
 204      *
 205      * @endif
 206      */
 207         result StopCallForward(void);
 208
 209         /**
 210      * @if VISPARTNER-OPERATOR
 211      * Gets the phone number to which the call must be forwarded.
 212      *
 213      * @since   2.0
 214          *
 215      * @visibility  partner-operator
 216      * @privilege   %http://tizen.org/privilege/callforward
 217      *
 218      * @return  An error code
 219      * @exception   E_SUCCESS               The method is successful.
 220      * @exception   E_IN_PROGRESS           The previous request is in progress.
 221      * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
 222      * @exception   E_NETWORK_UNAVAILABLE   The operation has failed because the device is in the offline mode.
 223      * @exception   E_SERVICE_UNAVAILABLE   The operation has failed because the device is out of the coverage area or in the emergency mode.
 224      * @exception   E_SYSTEM                A system error has occurred.
 225      * @see ITelephonyCallForwardListener::OnTelephonyCallForwardNumberReceived
 226      *
 227      * @endif
 228      */
 229         result GetCallForwardNumber(void) const;
 230
 231         /**
 232      * Gets the call type of the current call.
 233      *
 234      * @since                   2.0
 235          *
 236      * @return      The current call type, @n
 237      *              else Telephony::TYPE_UNDEFINED_CALL if the method fails
 238      */
 239         CallType GetCurrentCallType(void) const;
 240
 241         /**
 242      * Gets the call status of the current call.
 243      *
 244      * @since                   2.0
 245          *
 246      * @return      The current call status, @n
 247      *              else Telephony::CALL_STATUS_UNDEFINED if the method fails
 248      */
 249         CallStatus GetCurrentCallStatus(void) const;
 250
 251 private:
 252         /**
 253      * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 254      *
 255      * @param[in]       rhs     An instance of %CallManager
 256      */
 257         CallManager(const CallManager& rhs);
 258
 259         /**
 260      * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 261      *
 262      * @param[in]       rhs     An instance of %CallManager
 263      */
 264         CallManager& operator =(const CallManager& rhs);
 265
 266 private:
 267         _CallManagerImpl* __pCallManagerImpl;
 268
 269         friend class _CallManagerImpl;
 270 }; // CallManager
 271
 272 } } // Tizen::Telephony
 273 #endif // _FTEL_CALL_MANAGER_H_