/*

* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

#ifndef CMMCALLTSY_H

#define CMMCALLTSY_H

//INCLUDES

#include <et_phone.h>

#include <etelmm.h>

#include "MmTsy_timeoutdefs.h"

#include <ctsy/tflogger.h>

// FORWARD DECLARATIONS

class CMmPhoneTsy;

class CMmLineTsy;

class CMmCallExtInterface;

class CAcquireOwnerList;

class CHeartbeatRunner;

class CMmTsyReqHandleStore;

class CMmMessageManagerBase;

class CMmDataPackage;

class MTelephonyAudioControl;

// CLASS DECLARATION

/**

 *  CMmCallTsy contains extended call functionality that is not mode-dependent

 */

NONSHARABLE_CLASS( CMmCallTsy ) : public CCallBase

    {

    public: // Enumerations

        /**Enumeration for TSY request handle types*/

        enum TCallRequestTypes

            {

            EMultimodeCallReqHandleUnknown, //0

            EMultimodeCallNotifyStatusChange, 

            EMultimodeCallNotifyDurationChange,

            EMultimodeCallCapsChangeNotification,

            EMultimodeCallDial, 

            EMultimodeCallAnswer, //5

            EMultimodeCallHangUp,

            EMultimodeMobileCallHold,

            EMultimodeMobileCallResume,

            EMultimodeMobileCallSwap,

            EMultimodeCallNotifyMobileCallStatusChange, //10

            EMultimodeCallNotifyCallEvent,

            EMultimodeCallNotifyRemotePartyInfoChange,

            EMultimodeMobileCallDialEmergencyCall,

            EMultimodeMobileCallDeflectCall,

            EMultimodeCallNotifyMobileCallCapsChange, //15

            EMultimodeCallTransfer, 

            EMultimodeCallGoOneToOne,

            EMultimodeCallNotifyDataCallCapsChange,

            EMultimodeCallSetDynamicHscsdParams,  

            EMultimodeCallNotifyHscsdInfoChange, //20

            EMultimodeCallNotifyPrivacyConfirmation, //21

            EMultimodeCallDialISV,

            EMultimodeCallAnswerISV,

            EMultimodeCallActiveUUS,

            EMultimodeCallReceiveUUI,//25

            EMultimodeCallDialNoFdnCheck, //26

            // NOTE!: Declare constant for those requests that need

            // own request handle record in iTsyReqHandleStore above the

            // following!

            EMultimodeCallMaxNumOfRequests       

            };

        /**Enumeration for Dial Cancel*/

        enum TDialCancelStatus

            {

            EDialCancelNotCalled,

            EDialCancelCallCalled,

            EDialCancelCustomCalled

            };

    public:  // Constructors and destructor

        /**

         * Destructor.

         */

        virtual ~CMmCallTsy();

    public: // New functions

        /**

         * Returns pointer to the Phone object

         *          

         *

         * @return Pointer to the Phone object

         */

        CMmPhoneTsy* Phone();

        /**

         * Returns Line object from which this call was opened.

         *          

         *

         * @return Pointer to the Line object

         */

        CMmLineTsy* Line();

        /**

         * Returns currently active call extension

         *          

         *

         * @return CMmCallExtInterface* Pointer to the call extension

         */

        CMmCallExtInterface* ActiveCallExtension();

        /**

         * Complete dial request

         *          

         *

         * @param aResult Result of the request

         */

        virtual void CompleteDial( TInt aResult );

        /**

         * Complete hang up

         *          

         *

         * @param aResult Result of the request

         */

        virtual void CompleteHangUp( TInt aResult );

        /**

         * Complete answering to the incoming call

         *          

         *

         * @param aResult Result of the request

         */

        virtual void CompleteAnswerIncomingCall( TInt aResult );

        /**

         * Complete status change notification

         *          

         *

         * @param aResult Result of the request

         * @param aDataPackage: new call status value

         */

        virtual void CompleteNotifyStatusChange( TInt aResult, 

            CMmDataPackage* aDataPackage ) = 0;

        /**

         * Complete mobile call information change notification

         *          

         *

         * @param aDataPackage: new call information

         */

        void CompleteNotifyMobileCallInfoChange( 

            CMmDataPackage* aDataPackage );

        /**

         * This method completes NotifyRemotePartyInfoChange notification

         *          

         *

         */

        void CompleteNotifyRemotePartyInfoChange();

        /**

         * This method completes call event initiated by remote party

         *          

         *

         * @param aDataPackage: remote event

         */

        void CompleteNotifyRemoteCallEvent( 

            const CMmDataPackage* aPackage );

        /**

         * Complete a NotifyMobileCallCapsChange method

         *          

         *

         * @param aErrorCode Error code

         */

        void CompleteNotifyMobileCallCapsChange( TInt aErrorCode );

        /**

         * Complete call duration change notification

         *          

         *

         */

        void CompleteNotifyCallDurationChange();

        /**

         * This method completes privacy confirmation notification

         *          

         *

         * @param aStatus privacy value

         */

        void CompleteNotifyPrivacyConfirmation( 

            RMobilePhone::TMobilePhonePrivacy aStatus );

        /**

         * Completes call transfering

         *          

         *

         * @param aErrorCode Error code

         */

        void CompleteTransfer( TInt aErrorCode );

        /**

         * Fills current parameters of mobile call info 

         *          

         *

         * @param aInfo Pointer to mobile call information

         * @return TInt Return value to ETel server

         */

        virtual TInt FillMobileCallInfo( TDes8* aInfo );

        /**

         * Fills current parameters of mobile call info 

         *          

         *

         * @param aInfo Pointer to mobile call information

         * @return TInt Return value to ETel server

         */

        TInt FillMobileCallInfoDefaults( RMobileCall::TMobileCallInfoV1* aInfo );

        /**

         * Get call name

         *          

         *

         * return Call name

         */

        const TDesC& CallName() const;

        /**

         * Get call ID

         *          

         *

         * @return Call Id 

         */

        TInt CallId() const;

        /**

         * Set call ID

         *          

         *

         * @param aCallId Call ID

         * @return Success/failure value.

         */

        TInt SetCallId( TInt aCallId );

        /**

         * Set call Status

         *          

         *

         * @param aCallStatus: Core call status

         * @param aMobileCallStatus: Call status

         */

        void SetCallStatus(

            RCall::TStatus aCallStatus,

            RMobileCall::TMobileCallStatus aMobileCallStatus );

        /**

         * Returns call ID of the previous active call

         *          

         *

         * @return Call Id of the previous active call

         */

        TInt PreviousCallId() const;

        /**

         * Resets call ID of the previous active call

         *          

         *

         */

        void ResetPreviousCallId();

        /**

         * Get call mode

         *          

         *

         * return  Call mode

         */

        RMobilePhone::TMobileService CallMode() const;

        /**

         * Returns call status. For use inside the TSY

         *          

         *

         * return Call core status

         */        

        RCall::TStatus Status() const;

        /**

         * Returns mobile call status. For use inside the TSY

         *          

         *

         * @return Current mobile call status

         */

        RMobileCall::TMobileCallStatus MobileCallStatus() const;

        /** 

         * Returns call direction 

         *          

         *

         * return Call direction (MO/MT call)

         */ 

        RMobileCall::TMobileCallDirection CallDirection() const; 

        /**

         * Sets call direction

         *          

         *

         * @param aCallDirection Call direction (MO/MT call)

         * @return Success/failure value

         */

        TInt SetCallDirection( 

            RMobileCall::TMobileCallDirection aCallDirection );

        /**

         * Returns call capabilities

         *          

         *

         * @return Call capabilities

         */

        TUint32 CallCaps() const;

        /**

         * Sets call capabilities

         *          

         *

         * @param Call capabilities

         */

        void SetCallCaps( TUint32 aCallCaps );

        /**

         * Returns value or internal attribute iGhostCall

         *          

         *

         * @return Value of iGhostCall

         */

        TBool GetGhostCall() const;

        /**

         * Returns ETrue if this service is pending on this call object

         *

         *          

         * @param aReqType Type of request

         * @return requested or not from this call object.

         */

        TBool ServiceRequested( CMmCallTsy::TCallRequestTypes aReqType );

        /**

         * Sets a flag that indicates if this call is not created through ETel

         *          

         *

         * @param aValue Ghost call or not

         */

        void SetGhostCall( TBool aValue );

        /**

         * Handles call status change indications of ghost calls

         *          

         *

         * @param aResult Result value of the status change

         * @param aDataPackage Package containing new call status

         */

        void HandleGhostCallStatusChange (

            TInt aResult,

            CMmDataPackage* aDataPackage );

        /**

         * Sets the value of the attribute iDiagnosticOctet

         *          

         *

         * @param aDiagnosticOctect SS diagnostic octet value

         */

        void SetDiagnostics ( TUint8 aDiagnosticOctet );

        /**

         * Returns value or internal attribute iDiagnosticOctect

         *          

         *         

         * @return Value of iDiagnosticOctect

         */

        TUint8 GetDiagnostics () const;

        /**

         * Return ETrue if this type of request is requested by any of TSY's 

         * client

         *          

         *

         * @param aReqType Type of request

         * @return Locally requested or not.

         */

        TBool IsServiceLocallyRequested( CMmCallTsy::TCallRequestTypes aReqType );

        /**

         * Set flag that indicates if client has opened existing call object 

         * for incoming call or ghost call that is created using AT-commands.

         *          

         *

         * @param aIsUnownedGhostCall Is this unowned ghost call object

         */

        void SetUnownedCallObjectFlag( TBool aIsUnownedCallObject );

        /**

         * Returns iUnownedCallObject boolean that indicates if client has  

         * opened existing call object for incoming call or ghost call that 

         * is created using AT-commands.

         *          

         *

         * @return Value of iUnownedGhostCall boolean

         */

        TBool IsUnownedCallObject() const;

        /**

         * Returns ETrue if this call was originated through ETel API

         *          

         *

         * @return Value of iEtelOriginated boolean

         */

        TBool ETelOriginated() const;

        /** 

         * Returns ETrue if this call is part of a MO conference

         * (does not apply to an externally controlled conference call)

         *          

         *

         * @return Value of iIsPartOfConference boolean

         */

        TBool IsPartOfConference() const;

        /** 

         * Sets the flag indicating that this call is part of a MO conference

         * (does not apply to an externally controlled conference call)

         *          

         *

         * @param Is call part of conference

         */

        void SetPartOfConference( TBool aPartOfConference );

        /**

         * Completes DialNoFdnCheck request

         *          

         *

         * @param aResult Result of the request

         */

        virtual void CompleteDialNoFdn( TInt aResult );

        /** 

         * Sets Dialflag value indicating if call is in dialling state

         *          

         *

         * @param TBool is dial ongoing

         */

		virtual void SetDialFlag( TBool aDialFlag );

		/** 

         * Returns Dialflag value indicating if call is in dialling state

         *          

         *

         * @return is dial ongoing

         */

        virtual	TBool GetDialFlag();

#ifdef REQHANDLE_TIMER

        /**

         * Calls the appropriate complete method due timer expiration

         *          

         *

         * @param aReqHandleType TSY request handle type.

         * @param aError Error value for completion

         */

        virtual void Complete( TInt aReqHandleType, TInt aError );

#endif

        /**

         * UUI message received from the remote user, complete req

         *          

         * @param aDataPackage Includes received UUI information

         * @param aResult Result code

         */

        void CompleteReceiveUUI( CMmDataPackage* aDataPackage, TInt aResult );    

    public: // Functions from base classes

        /**

         * Opens a call object using given name

         *          

         * @param aName Object name that should be opened

         * @return Opened object 

         */

        virtual CTelObject* OpenNewObjectByNameL( const TDesC& /*aName*/ );

        /**

         * Opens a call object and gives it a name 

         *          

         *

         * @param aName On return contains the name of opened object

         * @return Opened object 

         */

        CTelObject* OpenNewObjectL( TDes& /*aNewName*/ );

        /**

         * TRAP's all CMmCallTsy related MM API requests in case that

         * they fail. This method functions only as a centralized TRAP for the

         * DoExtFuncL method that does the actual mapping of IPC number to

         * TSY method call.

         *          

         *

         * @param aTsyReqHandle TSY request handle from ETel server

         * @param aIpc IPC number of the request

         * @param aPackage Reference to the input parameters.

         * @return KErrNone/KErrNotSupported

         */

        TInt ExtFunc( const TTsyReqHandle aTsyReqHandle, 

            const TInt aIpc, const TDataPackage& aPackage );