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 MMCEEVENTOBSERVER_H

    22 #define MMCEEVENTOBSERVER_H

    23 

    24 // INCLUDES

    25 #include <e32base.h>

    26 

    27 // FORWARD DECLARATIONS

    28 class CMceEvent;

    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 *  events.

    36 *

    37 *  This observer is set using CMceManager::SetEventObserver function.

    38 *

    39 *  @lib mceclient.lib

    40 */

    41 class MMceEventObserver

    42     {

    43     public: // New functions

    44         

    45         /**

    46         * The state of the event has changed.

    47         * @param aEvent, the event that has changed.

    48 	    * @param aContainer, if present, holds details of

    49 	    *        transaction causing state change.

    50         */

    51         virtual void EventStateChanged(

    52         			CMceEvent& aEvent,

    53     				TMceTransactionDataContainer* aContainer ) = 0;

    54 

    55 		/**

    56 		* The state of the event has changed.

    57 		* @param aEvent, event received notification.

    58 	    * @param aContainer, if present, holds details of

    59 	    *        transaction causing state change.

    60 		*/

    61 		virtual void NotifyReceived(

    62 					CMceEvent& aEvent,

    63     				TMceTransactionDataContainer* aContainer ) = 0;

    64 					

    65 					

    66 	    /**

    67 	    * The state of the event used by the refer has changed.

    68 	    * @param aEvent, the event that has changed.

    69 	    * @param aActive, ETrue if connection active, EFalse if connection inactive.

    70 	    */

    71 	    virtual void EventConnectionStateChanged(

    72 	                CMceEvent& aEvent,

    73 	                TBool aActive ) = 0;

    74         

    75 		/**

    76 		* An error has occurred concerning a specific SIP event.

    77 		* Note, that each error causes the event state to be ETerminated.

    78 		* @param aEvent, The event raising the error.

    79 		* @param aError, Error code

    80 		*/

    81 		virtual void Failed(CMceEvent& aEvent, TInt aError ) = 0;

    82 

    83     };

    84 

    85 #endif