serviceproviders/sapi_messaging/messagingservice/inc/accessfolder.h
changeset 22 fc9cf246af83
parent 19 989d2f495d90
equal deleted inserted replaced
19:989d2f495d90 22:fc9cf246af83
    23 /**
    23 /**
    24  * This class provides function to get a list of measage header 
    24  * This class provides function to get a list of measage header 
    25  * in a sorted order present in a folder . Message Headers are 
    25  * in a sorted order present in a folder . Message Headers are 
    26  * retrieved as per searching options provided by user. 
    26  * retrieved as per searching options provided by user. 
    27 */
    27 */
    28 class CMessagingAccessFolder : public CBase
    28 class CMessagingAccessFolder : public CActive
    29 	{
    29 	{
    30 
    30 
    31 	public:
    31 	public:
    32 
    32 
    33 	    /**
    33 	    /**
    54 	     */
    54 	     */
    55 		CMessagingAccessFolder( CMsvSession& aServerSession );
    55 		CMessagingAccessFolder( CMsvSession& aServerSession );
    56 
    56 
    57 
    57 
    58 	public:
    58 	public:
       
    59 	    
       
    60 	    /**
       
    61          * Sets message input parameters 
       
    62          * Ownership is transferred to this class
       
    63          * @param aNotifyCallback Bydefault it is NULL to make function
       
    64          *        call synchronous , if provided then function call is asynchronous                  
       
    65          * @param aAsyncRequestObserver Asynchronous request observer
       
    66         */
       
    67         void SetInputParamsL(   CMsgCallbackBase* aNotifyCallback = NULL,
       
    68                                 MAsyncRequestObserver* aAsyncRequestObserver = NULL);
    59 
    69 
    60 		/**
    70 		/**
    61 		 * Gives Message id list of messages 
    71 		 * Gives Message id list of messages 
    62 		 * @param aFolderId  	 Folder to be used (Inbox/outbox/send/...)
    72 		 * @param aFolderId  	 Folder to be used (Inbox/outbox/send/...)
    63 		 * @param aFilterParams  Filter parameters
    73 		 * @param aFilterParams  Filter parameters
   134 		 * Checks whether filter on date is set
   144 		 * Checks whether filter on date is set
   135 		 * @param  aEntry The message entry to which user want to apply filter
   145 		 * @param  aEntry The message entry to which user want to apply filter
   136 		 * @return TBool ETrue if filter on date is set and entry matches with filter
   146 		 * @return TBool ETrue if filter on date is set and entry matches with filter
   137 		*/ 
   147 		*/ 
   138 		TBool FilterDate( const TMsvEntry& aEntry ) const;
   148 		TBool FilterDate( const TMsvEntry& aEntry ) const;
       
   149 		
       
   150 		/**
       
   151          * Inherited from CActive class 
       
   152         */ 
       
   153         virtual void DoCancel();
       
   154 
       
   155         /**
       
   156          * Inherited from CActive class 
       
   157         */ 
       
   158         virtual void RunL();
       
   159         
       
   160         /**
       
   161          * Activates the request and call SetActive() function
       
   162         */ 
       
   163         void ActivateRequest(TInt aReason);
       
   164 
       
   165         /**
       
   166          * Gives the result for notification request.
       
   167         */ 
       
   168         void NotifyRequestResult(TInt aReason, CMsvEntrySelection* aEntrySelection, CFilterParamInfo* aFilter );
   139 
   169 
   140 
   170 
   141 	private:
   171 	private:
   142 
   172 
   143 		/**
   173 		/**
   163 
   193 
   164 		/**
   194 		/**
   165 		 * Filter variable
   195 		 * Filter variable
   166 		*/ 
   196 		*/ 
   167         CFilterParamInfo*       iFilter;    
   197         CFilterParamInfo*       iFilter;    
       
   198         
       
   199         /**
       
   200          * A callback notification for asynchronous function
       
   201         */ 
       
   202         CMsgCallbackBase*       iNotifyCallback;
       
   203         
       
   204         /**
       
   205          * Asynchronous request observer, Used to get infromed of completion or request
       
   206         */ 
       
   207         MAsyncRequestObserver*  iAsyncRequestObserver;
       
   208         
       
   209         /**
       
   210          * Flag which specifies to cancel the request 
       
   211          * but not to call the NotifyResultL
       
   212          * If false doesnot call the NotifyResultL
       
   213         **/
       
   214         TBool iCallNotifyForCancelFlag;
   168 
   215 
   169 	};
   216 	};
   170 
   217 
   171 #endif __ACCESSFOLDER_H
   218 #endif __ACCESSFOLDER_H