emailservices/emailstore/message_store/client/api/MsgStoreObserver.h
changeset 0 8466d47a6819
child 8 e1b6206813b4
equal deleted inserted replaced
-1:000000000000 0:8466d47a6819
       
     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:  Message store observer.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MSG_STORE_OBSERVER_H__
       
    21 #define __MSG_STORE_OBSERVER_H__
       
    22 
       
    23 //<cmail>
       
    24 #include "MsgStoreTypes.h"
       
    25 #include "MsgStoreAccount.h"
       
    26 //</cmail>
       
    27 
       
    28 /** This class defines the message store observation API.
       
    29 
       
    30 	This class defines the abstract interface for the message store observer.  
       
    31 */
       
    32 class MMsgStoreObserver 
       
    33 	{
       
    34 	public:
       
    35 	
       
    36 		/** Notifies the observer of system events. */
       
    37 		virtual void SystemEventNotify( TMsgStoreSystemEvent aEvent ) = 0;
       
    38 				
       
    39 		/** Notifies the observer of account events. 
       
    40 		  
       
    41 			Note that the observer will not be notified of modifications that are performed
       
    42 		    from the observer's own message store session.
       
    43 			
       
    44 		    /param aEvent - the type of event
       
    45 		    /param aOwnerId - the owner ID of the account
       
    46 		    /param aName - the name of the account
       
    47 		    /param aNewName - the new account name if aEvent is EMsgStoreAccountRenamed
       
    48 		                    - KNullDesC otherwise
       
    49             /param aMailboxId - the ID of the mailbox 
       
    50 		 */
       
    51 		virtual void AccountEventNotify( TMsgStoreAccountEvent aEvent, 
       
    52 				                         TInt32 aOwnerId,
       
    53 				                         const TDesC& aName,
       
    54 				                         const TDesC& aNewName,
       
    55                                          TMsgStoreId  aMailboxId ) = 0;
       
    56 				
       
    57 	}; // end class MMsgStoreObserver
       
    58 
       
    59 #endif
       
    60