ipappsrv_plat/comms_event_api/inc/mcereferobserver.h
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     1 /*
       
     2 * Copyright (c) 2005 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 
       
    21 #ifndef MMCEREFEROBSERVER_H
       
    22 #define MMCEREFEROBSERVER_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32base.h>
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class CMceRefer;
       
    29 class TMceTransactionDataContainer;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34 *  An interface to be implemented by users of MCE if they wish to use
       
    35 *  refers.
       
    36 *
       
    37 *  This observer is set using CMceManager::SetReferObserver function.
       
    38 *
       
    39 *  @lib mceclient.lib
       
    40 */
       
    41 class MMceReferObserver
       
    42     {
       
    43     public: // New functions
       
    44         
       
    45 		/**
       
    46         * The state of the refer has changed.
       
    47         * @param aRefer, the refer that has changed.
       
    48 	    * @param aContainer, if present, holds details of
       
    49 	    *        transaction causing state change.
       
    50         */
       
    51         virtual void ReferStateChanged(
       
    52         			CMceRefer& aRefer,
       
    53     				TMceTransactionDataContainer* aContainer ) = 0;
       
    54 			
       
    55 	    /**
       
    56 	    * The state of the connection used by the refer has changed.
       
    57 	    * @param aRefer, the refer that has changed.
       
    58 	    * @param aActive, ETrue if connection active, EFalse if connection inactive.
       
    59 	    */
       
    60 	    virtual void ReferConnectionStateChanged(
       
    61 	                CMceRefer& aRefer,
       
    62 	                TBool aActive ) = 0;
       
    63                 
       
    64 		/**
       
    65 		* An error has occurred concerning a specific SIP refer.
       
    66 		* Note, that each error causes the event state to be ETerminated.
       
    67 		* @param aRefer, The refer raising the error.
       
    68 		* @param aError, Error code
       
    69 		*/
       
    70 		virtual void Failed(CMceRefer& aRefer, TInt aError ) = 0;
       
    71     };
       
    72 
       
    73 #endif