phoneclientserver/phoneclient/Inc/ExtCall/RPhCltExtCall.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:15:03 +0100
branchRCL_3
changeset 20 987c9837762f
parent 19 7d48bed6ce0c
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* Copyright (c) 2002 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:  It is the client side remote class of call subsession object.
*
*/


#ifndef RPHCLTEXTCALL_H
#define RPHCLTEXTCALL_H

//  INCLUDES
#include <e32std.h>
#include "PhCltTypes.h"
#include "RPhCltServer.h"

// FORWARD DECLARATIONS
class TPhCltExtPhoneDialData;

// CLASS DECLARATION

/**
*  It is the client side remote class of call subsession object.
*
*  @lib phoneclient.lib
*  @since 1.0
*/
class RPhCltExtCall : public RSubSessionBase
    {
    public:  // Constructors and destructor

        /**
         * C++ default constructor.
         */
        RPhCltExtCall();
   
        
    public:  // New functions

        /**
         * Opens the subsession.
         *
         * @param aServer It is the session of which subsession this is.
         * @return Returns error code.
         */       
        TInt Open( RPhCltServer& aServer );

        /**
         * Closes the subsession.
         */       
        void Close();

        /**
        * Makes a call (asynchronous).
        *
        * @param aStatus It is used to notify the completion of the request. 
        *                Then it indicates the success/failure of the 
        *                operation.
        * @param aNumber It is the number to be dialled.
        * @param aName The name to show in UI.
        * @param aWindowGroupId It is the id of the window group to be brought
        *                       foreground after the call has been ended.
        * @param aRedial Redial settings
        * @param aContactId Contact Id to be asked from the phonebook.
        * @param aAllowNumberShowing Is it allowed to show the number?
        */       
        void Dial( 
            TRequestStatus& aStatus, 
            const TPhCltTelephoneNumber& aNumber,
            const TPhCltNameBuffer& aName,
            const TInt aWindowGroupId,
            const TInt aRedial,
            const TPhCltContactId aContactId,
            const TBool aAllowNumberShowing );

        /**
        * Makes a call (asynchronous).
        *
        * @param aStatus It is used to notify the completion of the request. 
        *                Then it indicates the success/failure of the operation.
        * @param aData The object containing the dial parameters
        */       
        void Dial( 
            TRequestStatus& aStatus, 
            const TPhCltExtPhoneDialData& aData);

        /**
        * Cancels the dialling request.
        */       
        void CancelDial() const;

    private:
                
        // By default, prohibit copy constructor
        RPhCltExtCall( const RPhCltExtCall& );
        // Prohibit assigment operator
        RPhCltExtCall& operator= ( const RPhCltExtCall& );

    private: // Data

        // Call arguments.
        TPckgBuf< TPhCltCallArgs > iArgs;
    };
        
#endif      // RPHCLTEXTCALL_H   
            
// End of File