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