emailservices/emailstore/message_store/client/api/MsgStoreObserver.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 22:37:30 +0200
branchRCL_3
changeset 8 e1b6206813b4
parent 0 8466d47a6819
child 24 d189ee25cf9d
permissions -rw-r--r--
Revision: 201003 Kit: 201007

/*
* Copyright (c) 2006 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:  Message store observer.
*
*/



#ifndef __MSG_STORE_OBSERVER_H__
#define __MSG_STORE_OBSERVER_H__

//<cmail>
#include "msgstoretypes.h"
#include "msgstoreaccount.h"
//</cmail>

/** This class defines the message store observation API.

	This class defines the abstract interface for the message store observer.  
*/
class MMsgStoreObserver 
	{
	public:
	
		/** Notifies the observer of system events. */
		virtual void SystemEventNotify( TMsgStoreSystemEvent aEvent ) = 0;
				
		/** Notifies the observer of account events. 
		  
			Note that the observer will not be notified of modifications that are performed
		    from the observer's own message store session.
			
		    /param aEvent - the type of event
		    /param aOwnerId - the owner ID of the account
		    /param aName - the name of the account
		    /param aNewName - the new account name if aEvent is EMsgStoreAccountRenamed
		                    - KNullDesC otherwise
            /param aMailboxId - the ID of the mailbox 
		 */
		virtual void AccountEventNotify( TMsgStoreAccountEvent aEvent, 
				                         TInt32 aOwnerId,
				                         const TDesC& aName,
				                         const TDesC& aNewName,
                                         TMsgStoreId  aMailboxId ) = 0;
				
	}; // end class MMsgStoreObserver

#endif