messagingapp/msgappfw/plugin/inc/mcsmsgobserver.h
changeset 37 518b245aa84c
parent 25 84d9eb65b26f
child 38 4e4b6adb1024
equal deleted inserted replaced
25:84d9eb65b26f 37:518b245aa84c
     1 /*
       
     2 * Copyright (c) 2007 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:  The observer interface which handles the completion of 
       
    15  *                reading message entries. 
       
    16  *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __M_CS_MSG_OBSERVER__ 
       
    21 #define __M_CS_MSG_OBSERVER__
       
    22 
       
    23 // INCLUDE FILES
       
    24 #include  "ccsdefs.h"
       
    25 
       
    26 // FORWARD DECLARATION
       
    27 class CCsConversationEntry;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 /**
       
    31  *  MCsMsgObserver
       
    32  *  Mixin class.
       
    33  *  Observer which handles message read completion.
       
    34  */
       
    35 class MCsMsgObserver
       
    36     {
       
    37 public:
       
    38     /**
       
    39      * HandleConverastions.
       
    40      * Handle Conversation event from Plugins
       
    41      * 
       
    42      * @param aConversationEntryLists    List of conversation entries.
       
    43      */
       
    44     virtual void HandleReadCompleteL(const RPointerArray<CCsConversationEntry> *aConversationEntryLists) = 0;
       
    45 
       
    46     /**
       
    47      *  HandleUpdateCompleteL
       
    48      *  Sends the CCsConversationEntry array to Conversation Server
       
    49      *  @param aConversationEntryLists The object to be used to handle updates 
       
    50      *  from the plugin
       
    51      */
       
    52     virtual void HandleUpdateCompleteL( const RPointerArray<CCsConversationEntry> *aConversationEntryLists) = 0;
       
    53 
       
    54     /**
       
    55      *  HandleDeleteCompleteL
       
    56      *  Sends the CCsConversationEntry array to Conversation Server
       
    57      *  @param aConversationEntryLists The object to be used to handle updates 
       
    58      *  from the plugin
       
    59      */
       
    60     virtual void HandleDeleteCompleteL( const RPointerArray<CCsConversationEntry> *aConversationEntryLists) = 0;
       
    61 
       
    62     /**
       
    63      * HandleRefreshCompleteL
       
    64      * Notify conversation server to refresh the conversations from this plugin.
       
    65      */
       
    66     virtual void HandleRefreshCompleteL() = 0;
       
    67     
       
    68     /**
       
    69      *  HandleCachingCompleted
       
    70      *  Sends the cache completed status to server
       
    71      */
       
    72     virtual void HandleCachingCompleted() = 0;
       
    73 
       
    74     /**
       
    75      *  HandleCachingError
       
    76      *  Sends the error occured during the caching to server
       
    77      */
       
    78     virtual void HandleCachingError(const TInt aError) = 0;
       
    79 
       
    80     };
       
    81 
       
    82 #endif // __M_CS_MSG_OBSERVER__
       
    83 
       
    84 // End of File