telephonyserverplugins/common_tsy/commontsy/inc/mmfax/CMmFaxExtInterface.h
changeset 0 3553901f7fa8
child 24 6638e7f4bd8f
equal deleted inserted replaced
-1:000000000000 0:3553901f7fa8
       
     1 /*
       
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CMMFAXEXTINTERFACE_H
       
    21 #define CMMFAXEXTINTERFACE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <etelmm.h>
       
    25 #include "cmmcalltsy.h"
       
    26 
       
    27 // CLASS DECLARATION
       
    28  
       
    29 /**
       
    30 *  CMmFaxExt contains extended fax call functionality.
       
    31 */ 
       
    32 
       
    33 class CMmFaxExtInterface : public CBase
       
    34     {
       
    35 
       
    36     public:
       
    37 		
       
    38 		/**
       
    39          * Two-phased constructor.
       
    40          */
       
    41         static CMmFaxExtInterface* NewL( CMmCallTsy* aMmCall );
       
    42 
       
    43         /**
       
    44          * Start waiting for a call. Called from CmmCallTSY object 
       
    45          * AnswerIcomingCall method.
       
    46          *          
       
    47          *
       
    48          * @param aTsyReqHandle, reqhandle
       
    49          * @return error value
       
    50          */
       
    51         virtual TInt AnswerIncomingCall( const TTsyReqHandle& aTsyReqHandle ) = 0;
       
    52 
       
    53         /**
       
    54          * Start Fax call dialing. Call from CMmCallTsy object Dial method.
       
    55          *          
       
    56          *
       
    57          * @param aTsyReqHandle, reqhandle
       
    58          * @param aTelNumber, pointer to telnumber 
       
    59          * @return error value
       
    60          */
       
    61         virtual TInt Dial( const TTsyReqHandle& aTsyReqHandle, 
       
    62             TDesC* aTelNumber ) = 0;
       
    63 
       
    64         /**
       
    65          * Set terminate flag true on CMmTsyFax object.
       
    66          *          
       
    67          *
       
    68          */
       
    69         virtual void DialCancel() = 0;
       
    70 
       
    71         /**  
       
    72          * CMmFaxTsy object creation.
       
    73          *          
       
    74          *
       
    75          * @param aName, object name
       
    76          * @return CTelObject*, pointer to Etel object
       
    77          */
       
    78         virtual CTelObject* OpenNewObjectByNameL( const TDesC& aName ) = 0;
       
    79 
       
    80         /**
       
    81          * Close fax session.
       
    82          *          
       
    83          *
       
    84          */
       
    85         virtual void HangUp() = 0;
       
    86         
       
    87         /**
       
    88          * Transfers fax settings to local variables.
       
    89          *          
       
    90          *
       
    91          * @param aSettings, fax settings
       
    92          * @return error value
       
    93          */
       
    94         virtual TInt SetFaxSettings( const RCall::TFaxSessionSettings* aSettings ) = 0;
       
    95 
       
    96         /**
       
    97          * Transfers fax settings from variables.
       
    98          *          
       
    99          *
       
   100          * @param aSettings, fax settings
       
   101          * @return error value
       
   102          */
       
   103         virtual TInt GetFaxSettings( RCall::TFaxSessionSettings* aSettings ) = 0;
       
   104 
       
   105     };
       
   106 
       
   107 #endif // CMMFAXEXTINTERFACE_H 
       
   108 // End of File