messagingappbase/ncnlist/inc/MNcnNotificationObserver.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2002 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 *       Interface for handling received and unpacked IPC notifications.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __MNCNNOTIFICATIONOBSERVER_H__
       
    22 #define __MNCNNOTIFICATIONOBSERVER_H__
       
    23 
       
    24 //  INCLUDES
       
    25 #include <NcnNotificationDefs.h>
       
    26 #include <MNcnNotification.h>
       
    27 #include <msvstd.h>
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class MDesCArray;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35  * Interface for handling received and unpacked IPC notifications.
       
    36  *
       
    37  */
       
    38 class MNcnNotificationObserver
       
    39     {
       
    40     public: // Interface
       
    41 
       
    42 		/**
       
    43          * Callback method for handling NewInternalMessages request.
       
    44          * @param aType    The message type for new message(s)
       
    45          * @return         KErrNone or some system wide error code
       
    46          */
       
    47         virtual void HandleNewInternalMessagesL(
       
    48                         const TNcnNotifMessageType aType ) = 0;
       
    49                                                 
       
    50 		/**
       
    51          * Callback method for handling NewInternalMessages request.
       
    52          * @param aType    The message type for new message(s)
       
    53          * @param aMailBox The id for mail message type identifying mailbox or
       
    54          *                 individual mail folder that contains new message(s)
       
    55          * @param aInfo    Optional extra info about message (subject, sender etc.)
       
    56          * @return         KErrNone or some system wide error code         
       
    57          */
       
    58         virtual void HandleNewInternalMessagesL(
       
    59                         const TNcnNotifMessageType aType,
       
    60                         const TMsvId& aMailBox,
       
    61                         const MDesCArray& aInfo ) = 0;                            
       
    62 
       
    63 		/**
       
    64          * Callback method for handling InternalMarkUnread request.
       
    65 		 * @param aRequest The request maker type (method caller), identifies
       
    66 		 *                 what type of messages should be marked as unread and
       
    67 		 *                 whether there has to be made checks for messages.
       
    68 		 * @param sStatus  Request status.
       
    69          * @return         KErrNone or some system wide error code         		 
       
    70          */
       
    71         virtual void HandleInternalMarkUnreadL(
       
    72                         const TNcnUnreadRequestType aRequest ) = 0;
       
    73 
       
    74 		/**
       
    75          * Callback method for handling InternalMarkUnread request.
       
    76 		 * @param aRequest The request maker type (method caller), identifies
       
    77 		 *                 what type of messages should be marked as unread and
       
    78 		 *                 whether there has to be made checks for messages.
       
    79 		 * @param aMailBox The id for mail message type identifying mailbox or
       
    80          *                 mail folder containing message(s) to be marked as unread.
       
    81          * @return         KErrNone or some system wide error code                  
       
    82          */
       
    83         virtual void HandleInternalMarkUnreadL(
       
    84                         const TNcnUnreadRequestType aRequest,
       
    85                         const TMsvId& aMailbox ) = 0;
       
    86 
       
    87 		/**
       
    88 		 * Callback method for handling NewMessages request.
       
    89          * @param aMailBox The id for mail message type identifying mailbox or
       
    90          *                 individual mail folder that contains new message(s)
       
    91          * @param aIndicationType Indication type for new messages.
       
    92          * @param aInfo    Optional extra info about message (subject, sender etc.)
       
    93          * @return         KErrNone or some system wide error code                  
       
    94          */
       
    95         virtual void HandleNewMessagesL(
       
    96                         const TMsvId& aMailBox,
       
    97                         const MNcnNotification::TIndicationType aIndicationType,
       
    98                         const MDesCArray& aInfo ) = 0;
       
    99 
       
   100         /**
       
   101          * Callback method for handling MarkUnread request.
       
   102          * @param aMailBox The id for mail message type identifying mailbox or
       
   103          *                 mail folder containing message(s) to be marked as unread.
       
   104          */
       
   105         virtual void HandleMarkUnreadL(
       
   106                         const TMsvId& aMailBox ) = 0;
       
   107     };
       
   108 
       
   109 
       
   110 #endif // __MNCNNOTIFICATIONOBSERVER_H__
       
   111 
       
   112 // End of File