diff -r 969092730d34 -r edb9dc8273d9 smf/inc/smfplugins/smfactivity/smfactivityfetcherplugin.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/smf/inc/smfplugins/smfactivity/smfactivityfetcherplugin.h Thu Apr 22 15:18:37 2010 +0530 @@ -0,0 +1,94 @@ +/** + * Copyright (c) 2010 Sasken Communication Technologies Ltd. + * All rights reserved. + * This component and the accompanying materials are made available + * under the terms of the "Eclipse Public License v1.0" + * which accompanies this distribution, and is available + * at the URL "http://www.eclipse.org/legal/epl-v10.html" + * + * Initial Contributors: + * Chandradeep Gandhi, Sasken Communication Technologies Ltd - + * + * Description: + * Interface specification for plugins that implements social activity related services + * + */ +#ifndef SMFACTIVITYFETCHERPLUGIN_H_ +#define SMFACTIVITYFETCHERPLUGIN_H_ + +#include +#include + +// Forward declaration +class SmfPluginManagerUtil; + +/** + * @ingroup smf_plugin_group + * Interface specification for fetching social activity list for a user. + * This class provides basic functionality to allow applications to obtain list of + * activities like "marked as favourite", "commented on a picture" etc in a + * social networking service. + * + * All of the functionality described here should be implemented by a service + * specific plug-in. + */ +class SmfActivityFetcherPlugin : public SmfPluginBase + { +public: + /** + * Constructor + * @param aUtil The SmfPluginManagerUtil instance. The plugins can + * call the method getAuthKeys() of this class, with its pluginID to + * get the OAuth keys, keys are returned only if this plugin is + * authorised by Smf franework + * + */ + SmfActivityFetcherPlugin( SmfPluginManagerUtil* aUtil); + + /** + * Destructor + */ + ~SmfActivityFetcherPlugin(); + + /** + * Method to get the list of self activities, e.g. shown in own wall + * @param aRequest [out] The request data plugin generated (to be sent to network) + * @param aPageNum[in] The page to be extracted + * @param aItemsPerPage[in] Number of items per page + * @return SmfPluginError Plugin error if any, else SmfPluginErrNone + */ + virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; + + /** + * Method to get the list of activities for other, e.g. shown in a friends wall + * @param aRequest [out] The request data plugin generated (to be sent to network) + * @param aContact [in] The contact containing the URI, name or id of the user + * @param aPageNum[in] The page to be extracted + * @param aItemsPerPage[in] Number of items per page + * @return SmfPluginError Plugin error if any, else SmfPluginErrNone + */ + virtual SmfPluginError friendsActivities( SmfPluginRequestData &aRequest, + const SmfContact &aContact, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; + + /** + * Method to get list of self activities filtered by activity type, e.g. only photo updates in own wall + * @param aRequest [out] The request data plugin generated (to be sent to network) + * @param aFilters [in] The list of activity types to be included in result + * @param aPageNum[in] The page to be extracted + * @param aItemsPerPage[in] Number of items per page + * @return SmfPluginError Plugin error if any, else SmfPluginErrNone + */ + virtual SmfPluginError filtered( SmfPluginRequestData &aRequest, + QList &aFilters, + const int aPageNum = SMF_FIRST_PAGE, + const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; + + }; + +Q_DECLARE_INTERFACE( SmfActivityFetcherPlugin, "org.symbian.smf.plugin.activity.fetcher/v0.2" ); + +#endif /* SMFACTIVITYFETCHERPLUGIN_H_ */