inc/FTelITelephonyCallForwardListener.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    FTelITelephonyCallForwardListener.h
  19  * @brief   This is the header file for the %ITelephonyCallForwardListener interface.
  20  *
  21  * This header file contains the declarations of the %ITelephonyCallForwardListener interface.
  22  */
  23 #ifndef _FTEL_ITELEPHONY_CALL_FORWARD_LISTENER_H_
  24 #define _FTEL_ITELEPHONY_CALL_FORWARD_LISTENER_H_
  25
  26
  27 #include <FBase.h>
  28
  29
  30 namespace Tizen { namespace Telephony
  31 {
  32 /**
  33  * @if VISPARTNER-OPERATOR
  34  *
  35  * @interface   ITelephonyCallForwardListener
  36  * @brief       This interface provides methods to listen to the results of the call forwarding request.
  37  *
  38  * @since       2.0
  39  *
  40  * @visibility  partner-operator
  41  *
  42  * The %ITelephonyCallForwardListener interface provides methods to listen to the results of the call forwarding request.
  43  *
  44  * @endif
  45  */
  46 class _OSP_EXPORT_ ITelephonyCallForwardListener
  47         : virtual public Tizen::Base::Runtime::IEventListener
  48 {
  49 public:
  50         /**
  51      * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  52      *
  53      * @since   2.0
  54      */
  55         virtual ~ITelephonyCallForwardListener(void) {}
  56
  57         /**
  58      * Called when a response of the call forwarding request is received.
  59      *
  60      * @since   2.0
  61      *
  62      * @param[in]    phoneNumber         The phone number
  63      * @param[in]    r                   The result of the call forwarding request
  64      * @exception    E_SUCCESS           The method is successful.
  65      * @exception    E_NOT_RESPONDING    The server on the telephony network is not responding.
  66      * @exception    E_SYSTEM            A system error has occurred.
  67      */
  68         virtual void OnTelephonyCallForwardResponseReceived(const Tizen::Base::String& phoneNumber, result r) = 0;
  69
  70         /**
  71      * Called when a response of the call forwarding stop request is received.
  72      *
  73      * @since   2.0
  74          *
  75      * @param[in]    phoneNumber         The phone number
  76      * @param[in]    r                   The result of the call forwarding request
  77      * @exception    E_SUCCESS           The method is successful.
  78      * @exception    E_NOT_RESPONDING    The server on the telephony network is not responding.
  79      * @exception    E_SYSTEM            A system error has occurred.
  80          */
  81         virtual void OnTelephonyCallForwardStopped(const Tizen::Base::String& phoneNumber, result r) = 0;
  82
  83         /**
  84      * Called when a query for the call forwarding number is completed.
  85      *
  86      * @since   2.0
  87          *
  88      * @param[in]    phoneNumber             The phone number
  89      * @param[in]    r                       The result of the query request
  90      * @exception    E_SUCCESS               The method is successful.
  91      * @exception    E_NOT_RESPONDING        The server on the telephony network is not responding.
  92      * @exception    E_SERVICE_DEACTIVATED   The call forwarding service is not enabled.
  93      * @exception    E_SYSTEM                A system error has occurred.
  94      */
  95         virtual void OnTelephonyCallForwardNumberReceived(const Tizen::Base::String& phoneNumber, result r) = 0;
  96
  97 protected:
  98         //
  99         // This method is for internal use only. Using this method can cause behavioral, security-related,
 100         // and consistency-related issues in the application.
 101         //
 102         // This method is reserved and may change its name at any time without prior notice.
 103         //
 104         // @since    2.0
 105         //
 106         virtual void ITelephonyCallForwardListener_Reserved1(void) {}
 107
 108         //
 109         // This method is for internal use only. Using this method can cause behavioral, security-related,
 110         // and consistency-related issues in the application.
 111         //
 112         // This method is reserved and may change its name at any time without prior notice.
 113         //
 114         // @since    2.0
 115         //
 116         virtual void ITelephonyCallForwardListener_Reserved2(void) {}
 117
 118         //
 119         // This method is for internal use only. Using this method can cause behavioral, security-related,
 120         // and consistency-related issues in the application.
 121         //
 122         // This method is reserved and may change its name at any time without prior notice.
 123         //
 124         // @since    2.0
 125         //
 126         virtual void ITelephonyCallForwardListener_Reserved3(void) {}
 127 }; // ITelephonyCallForwardListener
 128
 129 }} // Tizen::Telephony
 130 #endif // _FTEL_ITELEPHONY_CALL_FORWARD_LISTENER_H_