smf/smfservermodule/smfserver/smfplugins/smfactivityfetcherplugin.h
changeset 25 a180113055cb
parent 14 a469c0e6e7fb
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    44 	virtual ~SmfActivityFetcherPlugin( ) {}
    44 	virtual ~SmfActivityFetcherPlugin( ) {}
    45 
    45 
    46 	/**
    46 	/**
    47 	 * Method to get the list of self activities, e.g. shown in own wall
    47 	 * Method to get the list of self activities, e.g. shown in own wall
    48 	 * @param aRequest [out] The request data that plugin generates (to be sent to network)
    48 	 * @param aRequest [out] The request data that plugin generates (to be sent to network)
    49 	 * @param aPageNum[in] The page to be extracted
    49 	 * @param aPageNum [in] The page to be extracted
    50 	 * @param aItemsPerPage[in] Number of items per page
    50 	 * @param aItemsPerPage [in] Number of items per page
    51 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    51 	 * @return Appropriate value of the enum SmfPluginError.
       
    52 	 * Plugin error if any, else SmfPluginErrNone for success
    52 	 */
    53 	 */
    53 	virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest,
    54 	virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest,
    54 			const int aPageNum = SMF_FIRST_PAGE, 
    55 			const int aPageNum = SMF_FIRST_PAGE, 
    55 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    56 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    56 
    57 
    57 	/**
    58 	/**
    58 	 * Method to get the list of activities for other, e.g. shown in a friends wall
    59 	 * Method to get the list of activities for other, e.g. shown in a friends wall
    59 	 * @param aRequest [out] The request data plugin generated (to be sent to network)
    60 	 * @param aRequest [out] The request data plugin generated (to be sent to network)
    60 	 * @param aContact [in] The contact containing the URI, name or id of the user 
    61 	 * @param aContact [in] The contact containing the URI, name or id of the user 
    61 	 * @param aPageNum[in] The page to be extracted
    62 	 * @param aPageNum [in] The page to be extracted
    62 	 * @param aItemsPerPage[in] Number of items per page
    63 	 * @param aItemsPerPage [in] Number of items per page
    63 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    64 	 * @return Appropriate value of the enum SmfPluginError.
       
    65 	 * Plugin error if any, else SmfPluginErrNone for success
    64 	 */
    66 	 */
    65 	virtual SmfPluginError friendsActivities( SmfPluginRequestData &aRequest,
    67 	virtual SmfPluginError friendsActivities( SmfPluginRequestData &aRequest,
    66 			const SmfContact &aContact,			
    68 			const SmfContact &aContact,			
    67 			const int aPageNum = SMF_FIRST_PAGE, 
    69 			const int aPageNum = SMF_FIRST_PAGE, 
    68 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    70 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    69 
    71 
    70 	/**
    72 	/**
    71 	 * Method to get list of self activities filtered by activity type, e.g. only photo updates in own wall
    73 	 * Method to get list of self activities filtered by activity type, e.g. only photo updates in own wall
    72 	 * @param aRequest [out] The request data plugin generated (to be sent to network)
    74 	 * @param aRequest [out] The request data plugin generated (to be sent to network)
    73 	 * @param aFilters [in] The list of activity types to be included in result
    75 	 * @param aFilters [in] The list of activity types to be included in result
    74 	 * @param aPageNum[in] The page to be extracted
    76 	 * @param aPageNum [in] The page to be extracted
    75 	 * @param aItemsPerPage[in] Number of items per page
    77 	 * @param aItemsPerPage[in] Number of items per page
    76 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    78 	 * @return Appropriate value of the enum SmfPluginError.
       
    79 	 * Plugin error if any, else SmfPluginErrNone for success
    77 	 */
    80 	 */
    78 	virtual SmfPluginError filtered( SmfPluginRequestData &aRequest,
    81 	virtual SmfPluginError filtered( SmfPluginRequestData &aRequest,
    79 			QList<SmfActivityObjectType> &aFilters,
    82 			QList<SmfActivityObjectType> &aFilters,
    80 			const int aPageNum = SMF_FIRST_PAGE, 
    83 			const int aPageNum = SMF_FIRST_PAGE, 
    81 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    84 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    82 	
    85 	
    83 	/**
    86 	/**
    84 	 * Customised method for SmfActivityFetcherPlugin interface
    87 	 * Customised method for SmfActivityFetcherPlugin interface
    85 	 * @param aRequest [out] The request data to be sent to network
    88 	 * @param aRequest [out] The request data to be sent to network
    86 	 * @param aOperation The operation type (should be known between 
    89 	 * @param aOperation [in] The operation type (should be known between 
    87 	 * the client interface and the plugin)
    90 	 * the client interface and the plugin)
    88 	 * @param aData The data required to form the request (The type 
    91 	 * @param aData [in] The data required to form the request (The type 
    89 	 * of data should be known between client and the plugin)
    92 	 * of data should be known between client and the plugin)
    90 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    93 	 * @return Appropriate value of the enum SmfPluginError.
       
    94 	 * Plugin error if any, else SmfPluginErrNone for success
    91 	 */
    95 	 */
    92 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
    96 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
    93 			const int &aOperation, QByteArray *aData ) = 0;
    97 			const int &aOperation, QByteArray *aData ) = 0;
    94 	
    98 	
    95 	};
    99 	};