Merge from 2.2
[platform/framework/native/telephony.git] / inc / FTelITelephonyCallEventListener.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    FTelITelephonyCallEventListener.h
19  * @brief   This is the header file for the %ITelephonyCallEventListener interface.
20  *
21  * This header file contains the declarations of the %ITelephonyCallEventListener interface.
22  *
23  */
24 #ifndef _FTEL_ITELEPHONY_CALL_EVENT_LISTENER_H_
25 #define _FTEL_ITELEPHONY_CALL_EVENT_LISTENER_H_
26
27
28 #include <FBase.h>
29 #include <FTelTypes.h>
30 #include <FTelCallInfo.h>
31
32
33 namespace Tizen { namespace Telephony
34 {
35 /**
36  * @interface   ITelephonyCallEventListener
37  * @brief       This interface provides methods to listen to a change in the call status.
38  *
39  * @since       2.0
40  *
41  * The %ITelephonyCallEventListener interface checks for a change in the call status.
42  *
43  */
44 class _OSP_EXPORT_ ITelephonyCallEventListener
45         : virtual public Tizen::Base::Runtime::IEventListener
46 {
47 public:
48     /**
49      * This polymorphic destructor should be overridden if required. @n
50          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
51      *
52      * @since   2.0
53      */
54         virtual ~ITelephonyCallEventListener(void) {}
55
56         /**
57     * Called when the call status is changed.
58     *
59     * @since    2.0
60         *
61     * @param[in]    callStatus The changed call status
62     * @param[in]    pCallInfo  The detailed information of the call
63     */
64         virtual void OnTelephonyCallStatusChangedN(CallStatus callStatus, CallInfo* pCallInfo) = 0;
65
66 protected:
67         //
68         // This method is for internal use only. Using this method can cause behavioral, security-related,
69         // and consistency-related issues in the application.
70         //
71         // This method is reserved and may change its name at any time without prior notice.
72         //
73         // @since    2.0
74         //
75         virtual void ITelephonyCallEventListener_Reserved1(void) {}
76
77         //
78         // This method is for internal use only. Using this method can cause behavioral, security-related,
79         // and consistency-related issues in the application.
80         //
81         // This method is reserved and may change its name at any time without prior notice.
82         //
83         // @since    2.0
84         //
85         virtual void ITelephonyCallEventListener_Reserved2(void) {}
86
87         //
88         // This method is for internal use only. Using this method can cause behavioral, security-related,
89         // and consistency-related issues in the application.
90         //
91         // This method is reserved and may change its name at any time without prior notice.
92         //
93         // @since    2.0
94         //
95         virtual void ITelephonyCallEventListener_Reserved3(void) {}
96 }; // ITelephonyCallEventListener
97
98 }} // Tizen::Telephony
99 #endif // _FTEL_ITELEPHONY_CALL_EVENT_LISTENER_H_