smf/inc/smfplugins/smfcontacts/smfpostproviderplugin.h
changeset 5 edb9dc8273d9
parent 3 0446eb7b28aa
equal deleted inserted replaced
4:969092730d34 5:edb9dc8273d9
    10  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
    10  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
    11  *
    11  *
    12  * Contributors:
    12  * Contributors:
    13  * Manasij Roy, Nalina Hariharan
    13  * Manasij Roy, Nalina Hariharan
    14  * 
    14  * 
    15  * @section DESCRIPTION
    15  * Description:
    16  *
       
    17  * Interface specification for getting/posting updates to a social site
    16  * Interface specification for getting/posting updates to a social site
    18  *
    17  *
    19  */
    18  */
    20 
    19 
    21 
    20 
    26 #include <smfcontact.h>
    25 #include <smfcontact.h>
    27 #include <smfpost.h>
    26 #include <smfpost.h>
    28 #include <smfplace.h>
    27 #include <smfplace.h>
    29 
    28 
    30 // Forward declaration
    29 // Forward declaration
    31 class SmfPluginManagerUtil;
    30 class SmfPluginUtil;
    32 
    31 
    33 /**
    32 /**
    34  * SmfPresenceInfo.
    33  * SmfPresenceInfo.
    35  * Indicates the presence information of user like Online, Offline, Busy, 
    34  * Indicates the presence information of user like Online, Offline, Busy, 
    36  * Do no disturb, Appear Offline etc.
    35  * Do no disturb, Appear Offline etc.
    56  * All of the functionality described here should be implemented by a service
    55  * All of the functionality described here should be implemented by a service
    57  * specific plug-in.
    56  * specific plug-in.
    58  */
    57  */
    59 class SmfPostProviderPlugin : public SmfPluginBase
    58 class SmfPostProviderPlugin : public SmfPluginBase
    60 	{
    59 	{
    61 	Q_OBJECT
       
    62 public:
    60 public:
    63 	/**
    61 	/**
    64 	 * Constructor with default argument
    62 	 * Constructor with default argument
    65 	 * @param aUtil The SmfPluginManagerUtil instance. The plugins can 
    63 	 * @param aUtil The SmfPluginUtil instance. The plugins can 
    66 	 * call the method getAuthKeys() of this class, with its pluginID to 
    64 	 * call the method getAuthKeys() of this class, with its pluginID to 
    67 	 * get the OAuth keys, keys are returned only if this plugin is 
    65 	 * get the OAuth keys, keys are returned only if this plugin is 
    68 	 * authorised by Smf franework
    66 	 * authorised by Smf franework
    69 	 */
    67 	 */
    70 	SmfPostProviderPlugin( SmfPluginManagerUtil* aUtil );
    68 	SmfPostProviderPlugin( SmfPluginUtil* aUtil );
    71 	
    69 	
    72 	/**
    70 	/**
    73 	 * Destructor
    71 	 * Destructor
    74 	 */
    72 	 */
    75 	~SmfPostProviderPlugin( );
    73 	~SmfPostProviderPlugin( );
   111 	 * @param aPageNum The page to be extracted
   109 	 * @param aPageNum The page to be extracted
   112 	 * @param aItemsPerPage Number of items per page
   110 	 * @param aItemsPerPage Number of items per page
   113 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   111 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   114 	 */
   112 	 */
   115 	virtual SmfPluginError retrieve( SmfPluginRequestData &aRequest,
   113 	virtual SmfPluginError retrieve( SmfPluginRequestData &aRequest,
   116 			const SmfContact &aUser = 0,
   114 			const SmfContact *aUser=0,
   117 			const int aPageNum = SMF_FIRST_PAGE, 
   115 			const int aPageNum = SMF_FIRST_PAGE, 
   118 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   116 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
   119 
   117 
   120 	
   118 	
   121 	/**
   119 	/**
   147 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   145 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
   148 	 */
   146 	 */
   149 	virtual SmfPluginError postDirected( SmfPluginRequestData &aRequest,
   147 	virtual SmfPluginError postDirected( SmfPluginRequestData &aRequest,
   150 			const SmfPost &aPostData, 
   148 			const SmfPost &aPostData, 
   151 			const SmfContact &aContact, 
   149 			const SmfContact &aContact, 
   152 			const SmfPlace &aLocation = NULL ) = 0;
   150 			const SmfPlace *aLocation = NULL ) = 0;
   153 	
   151 	
   154 	
   152 	
   155 	/**
   153 	/**
   156 	 * Method to post a comment on a post.
   154 	 * Method to post a comment on a post.
   157 	 * @param aRequest [out] The request data to be sent to network
   155 	 * @param aRequest [out] The request data to be sent to network
   160 	 * @param aLocation location data
   158 	 * @param aLocation location data
   161 	 */
   159 	 */
   162 	virtual SmfPluginError commentOnAPost(SmfPluginRequestData &aRequest,
   160 	virtual SmfPluginError commentOnAPost(SmfPluginRequestData &aRequest,
   163 			const SmfPost& aTarget,
   161 			const SmfPost& aTarget,
   164 			const SmfPost& aComment, 
   162 			const SmfPost& aComment, 
   165 			const SmfPlace &aLocation = NULL);
   163 			const SmfPlace *aLocation = NULL);
   166 	
   164 	
   167 	/**
   165 	/**
   168 	 * Method to update the presence information of the user
   166 	 * Method to update the presence information of the user
   169 	 * @param aRequest [out] The request data to be sent to network
   167 	 * @param aRequest [out] The request data to be sent to network
   170 	 * @param aAppearence The appearence information
   168 	 * @param aAppearence The appearence information