idlefw/plugins/devicestatus/inc/aidevicestatuspublisher.h
branchRCL_3
changeset 8 d0529222e3f0
parent 0 79c6a41cd166
child 19 edd621764147
equal deleted inserted replaced
4:1a2a00e78665 8:d0529222e3f0
    17 
    17 
    18 
    18 
    19 #ifndef M_AIDEVICESTATUSPUBLISHER_H
    19 #ifndef M_AIDEVICESTATUSPUBLISHER_H
    20 #define M_AIDEVICESTATUSPUBLISHER_H
    20 #define M_AIDEVICESTATUSPUBLISHER_H
    21 
    21 
       
    22 // System includes
    22 #include <e32std.h>
    23 #include <e32std.h>
    23 #include "aicontentobserver.h"
       
    24 
    24 
       
    25 // User includes
       
    26 
       
    27 // Forward declarations
       
    28 class CHsContentPublisher;
       
    29 class MAiContentObserver;
    25 class MAiPublishPrioritizer;
    30 class MAiPublishPrioritizer;
    26 class MAiPublisherBroadcaster;
    31 class MAiPublisherBroadcaster;
    27 
    32 
    28 /**
    33 /**
    29  *  @ingroup group_devicestatusplugin
    34  *  @ingroup group_devicestatusplugin
    50      * @param aExtension is reference to property extension.
    55      * @param aExtension is reference to property extension.
    51      * @param aPrioritizer is reference to publish prioritizer.
    56      * @param aPrioritizer is reference to publish prioritizer.
    52      * @param aBroadcaster is reference for publisher broadcaster.
    57      * @param aBroadcaster is reference for publisher broadcaster.
    53      */
    58      */
    54     virtual void Subscribe( MAiContentObserver& aObserver, 
    59     virtual void Subscribe( MAiContentObserver& aObserver, 
    55                             MAiPropertyExtension& aExtension,
    60                             CHsContentPublisher& aExtension,
    56                             MAiPublishPrioritizer& aPrioritizer,
    61                             MAiPublishPrioritizer& aPrioritizer,
    57                             MAiPublisherBroadcaster& aBroadcaster ) = 0;
    62                             MAiPublisherBroadcaster& aBroadcaster ) = 0;
    58 
    63 
    59     /**
    64     /**
    60      * Resume publisher.
    65      * Resume publisher.
    82      * @return true if content was republished.
    87      * @return true if content was republished.
    83      */
    88      */
    84     virtual TBool RefreshL( TInt /*aContentId*/, TBool /*aClean*/ ) { return EFalse; }
    89     virtual TBool RefreshL( TInt /*aContentId*/, TBool /*aClean*/ ) { return EFalse; }
    85 
    90 
    86     /**
    91     /**
       
    92      * Suspends specific content.
       
    93      *     
       
    94      * Publisher suspends content publishing specified by aContentId.
       
    95      * @param aContentId Id of the content item that is requested to suspend.
       
    96      * @param aClean ETrue if current content needs to be cleaned.
       
    97      * @return true if content was suspended.
       
    98      */    
       
    99     virtual TBool SuspendL( TInt /*aContentId*/, TBool /*aClean*/ ) { return EFalse; }
       
   100     
       
   101     /**
    87      * Refresh specific content with specific priority.
   102      * Refresh specific content with specific priority.
    88      *
   103      *
    89      * This has the same effect as the publisher would get content update from system.
   104      * This has the same effect as the publisher would get content update from system.
    90      * Publisher publishes content if it is available and has correct priority.
   105      * Publisher publishes content if it is available and has correct priority.
    91      * @param aContentId Id of the content item that is requested to republish.
   106      * @param aContentId Id of the content item that is requested to republish.
    93      * @return true if content was republished.
   108      * @return true if content was republished.
    94      */
   109      */
    95     virtual TBool RefreshContentWithPriorityL( TInt /*aContentId*/, TInt /*aPriority*/ ) { return EFalse; }
   110     virtual TBool RefreshContentWithPriorityL( TInt /*aContentId*/, TInt /*aPriority*/ ) { return EFalse; }
    96     };
   111     };
    97 
   112 
       
   113 #endif // M_AIDEVICESTATUSPUBLISHER_H
    98 
   114 
    99 #endif // M_AIDEVICESTATUSPUBLISHER_H
   115 // End of file