src/FTel_CallManagerEventArg.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        FTel_CallManagerEventArg.h
  19  * @brief       This is the header file for _CallManagerEventArg class.
  20  *
  21  * This header file contains the declarations of _CallManagerEventArg class.
  22  */
  23
  24
  25 #ifndef _FTEL_INTERNAL_CALL_MANAGER_EVENT_ARG_H_
  26 #define _FTEL_INTERNAL_CALL_MANAGER_EVENT_ARG_H_
  27
  28 // Includes
  29 #include <unique_ptr.h>
  30 #include <FBaseObject.h>
  31 #include <FBaseDataType.h>
  32 #include <FBaseRtIEventArg.h>
  33 #include <FTelNetworkStatus.h>
  34
  35 namespace Tizen { namespace Telephony
  36 {
  37
  38
  39 /**
  40  * @class   _CallManagerEventArg
  41  * @brief   This class is used as an argument of methods of the ITelephonyCallEventListener class.
  42  *
  43  * This class is used as an argument of ITelephonyCallEventListener methods.
  44  * When a CallManager event occurs, the _CallManagerEvent object finds a ITelephonyCallEventListener object
  45  * which is registered for the CallManager object and calls an appropriate method of the listener.
  46  */
  47
  48 class _CallManagerEventArg
  49     : public Tizen::Base::Object
  50     , public Tizen::Base::Runtime::IEventArg
  51 {
  52 public:
  53     /**
  54     * This is the constructor.
  55     *
  56     */
  57     _CallManagerEventArg(void);
  58
  59     /**
  60     * This constructor initializes the instance of this class with the specified values.
  61     *
  62     * @param[in]    callStatus An instance of %CallStatus
  63     * @param[in]    pCallInfo  A pointer to a CallInfo instance
  64     */
  65     _CallManagerEventArg(CallStatus callStatus, CallInfo* pCallInfo);
  66
  67     /**
  68     * This is class destructor.
  69     */
  70     virtual ~_CallManagerEventArg(void){}
  71
  72     /**
  73      * Gets the call status
  74      * @return  The instance of CallStatus
  75      */
  76     CallStatus GetCallStatus(void) const;
  77
  78     /**
  79      * Gets the call information
  80      * @return  A pointer to a CallInfo instance
  81      */
  82     CallInfo* GetCallInfoN(void) const;
  83
  84
  85 private:
  86     _CallManagerEventArg(const _CallManagerEventArg& rhs);
  87     _CallManagerEventArg& operator =(const _CallManagerEventArg& rhs);
  88
  89 private:
  90     CallStatus __callStatus;
  91     std::unique_ptr<CallInfo> __pCallInfo;
  92
  93 }; // _CallManagerEventArg
  94 } }
  95
  96 #endif // _FTEL_INTERNAL_CALL_MANAGER_EVENT_ARG_H_