phonesrv_plat/converged_call_engine_api/inc/mcceforwardinterface.h
changeset 0 ff3b6d0fd310
child 19 7d48bed6ce0c
equal deleted inserted replaced
-1:000000000000 0:ff3b6d0fd310
       
     1 /*
       
     2 * Copyright (c) 2006 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:  CCE call forward interface
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCCEFORWARDINTERFACE_H
       
    20 #define MCCEFORWARDINTERFACE_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <badesca.h> // CDesC8Array
       
    25 
       
    26 /**
       
    27 * Call forward methods.
       
    28 * MCCECallObserver is used for errors, statuses, notifications etc
       
    29 *
       
    30 *  @since S60 3.2
       
    31 */
       
    32 class MCCEForwardInterface
       
    33 	{
       
    34  protected: // Constructors and destructor
       
    35 
       
    36     /** 
       
    37     * Protected destructor. Object cannot be deleted from client.
       
    38     * @since S60 3.2
       
    39     */
       
    40     virtual ~MCCEForwardInterface() {};
       
    41 	
       
    42  public:
       
    43 	/**
       
    44 	* Returns reference to array containing addresses of forward address choices.
       
    45 	* Index starts from zero.
       
    46 	* @since Series 60 3.2
       
    47 	* @param none
       
    48 	* @return array containing forward address choices
       
    49     * @leave KErrNotReady Call is not in forwarding state
       
    50     * @leave KErrNotSupported If call is not mobile originated
       
    51     * @leave system error code 
       
    52     * @pre Call state is MCCECallObserver::ECCEStateForwarding and call type is MO
       
    53     * @pre Call MCCECallObserver::EVoIPEventMultipleChoices event is received
       
    54 	*/
       
    55 	virtual const CDesC8Array& GetForwardAddressChoicesL() = 0;
       
    56 
       
    57 	/**
       
    58 	* Forward call to selected address at given index in array received from GetForwardAddressChoicesL
       
    59 	* @since Series 60 3.2
       
    60 	* @param aIndex index in the address where the call is to be forwarded. 
       
    61 	* Index starts from zero.
       
    62 	* @return none 
       
    63 	* @leave KErrArgument Index is not in array
       
    64     * @leave KErrNotReady Call is not in forwarding state
       
    65     * @leave KErrNotSupported If call is not mobile originated
       
    66     * @pre Call state is MCCECallObserver::ECCEStateForwarding and call type is MO
       
    67 	*/
       
    68 	virtual void ForwardToAddressL( const TInt aIndex ) = 0;
       
    69 	};
       
    70 
       
    71 
       
    72 #endif // MCCEFORWARDINTERFACE_H