7 * at the URL "http://www.eclipse.org/legal/epl-v10.html" |
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html" |
8 * |
8 * |
9 * Initial Contributors: |
9 * Initial Contributors: |
10 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - |
10 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - |
11 * |
11 * |
|
12 * Contributors: |
|
13 * Manasij Roy, Nalina Hariharan |
|
14 * |
12 * Description: |
15 * Description: |
13 * Interface specification for plugins that implements social activity related services |
16 * Interface specification for plugins that implements social activity related services |
14 * |
17 * |
15 */ |
18 */ |
16 #ifndef SMFACTIVITYFETCHERPLUGIN_H_ |
19 #ifndef SMFACTIVITYFETCHERPLUGIN_H_ |
17 #define SMFACTIVITYFETCHERPLUGIN_H_ |
20 #define SMFACTIVITYFETCHERPLUGIN_H_ |
18 |
21 |
19 #include <smfpluginbase.h> |
22 #include <smfpluginbase.h> |
20 #include <smfactivity.h> |
23 #include <smfactions.h> |
21 |
24 |
22 // Forward declaration |
25 // Forward declaration |
23 class SmfPluginManagerUtil; |
26 class SmfContact; |
24 |
27 |
25 /** |
28 /** |
26 * @ingroup smf_plugin_group |
29 * @ingroup smf_plugin_group |
27 * Interface specification for fetching social activity list for a user. |
30 * Interface specification for fetching social activity list for a user. |
28 * This class provides basic functionality to allow applications to obtain list of |
31 * This class provides basic functionality to allow applications to obtain list of |
34 */ |
37 */ |
35 class SmfActivityFetcherPlugin : public SmfPluginBase |
38 class SmfActivityFetcherPlugin : public SmfPluginBase |
36 { |
39 { |
37 public: |
40 public: |
38 /** |
41 /** |
39 * Constructor |
|
40 * @param aUtil The SmfPluginManagerUtil instance. The plugins can |
|
41 * call the method getAuthKeys() of this class, with its pluginID to |
|
42 * get the OAuth keys, keys are returned only if this plugin is |
|
43 * authorised by Smf franework |
|
44 * |
|
45 */ |
|
46 SmfActivityFetcherPlugin( SmfPluginManagerUtil* aUtil); |
|
47 |
|
48 /** |
|
49 * Destructor |
42 * Destructor |
50 */ |
43 */ |
51 ~SmfActivityFetcherPlugin(); |
44 virtual ~SmfActivityFetcherPlugin( ) {} |
52 |
45 |
53 /** |
46 /** |
54 * 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 |
55 * @param aRequest [out] The request data plugin generated (to be sent to network) |
48 * @param aRequest [out] The request data that plugin generates (to be sent to network) |
56 * @param aPageNum[in] The page to be extracted |
49 * @param aPageNum[in] The page to be extracted |
57 * @param aItemsPerPage[in] Number of items per page |
50 * @param aItemsPerPage[in] Number of items per page |
58 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
51 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
59 */ |
52 */ |
60 virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest, |
53 virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest, |
85 virtual SmfPluginError filtered( SmfPluginRequestData &aRequest, |
78 virtual SmfPluginError filtered( SmfPluginRequestData &aRequest, |
86 QList<SmfActivityObjectType> &aFilters, |
79 QList<SmfActivityObjectType> &aFilters, |
87 const int aPageNum = SMF_FIRST_PAGE, |
80 const int aPageNum = SMF_FIRST_PAGE, |
88 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
81 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
89 |
82 |
|
83 /** |
|
84 * Customised method for SmfActivityFetcherPlugin interface |
|
85 * @param aRequest [out] The request data to be sent to network |
|
86 * @param aOperation The operation type (should be known between |
|
87 * the client interface and the plugin) |
|
88 * @param aData The data required to form the request (The type |
|
89 * of data should be known between client and the plugin) |
|
90 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
91 */ |
|
92 virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, |
|
93 const int &aOperation, QByteArray *aData ) = 0; |
|
94 |
90 }; |
95 }; |
91 |
96 |
92 Q_DECLARE_INTERFACE( SmfActivityFetcherPlugin, "org.symbian.smf.plugin.activity.fetcher/v0.2" ); |
97 Q_DECLARE_INTERFACE( SmfActivityFetcherPlugin, "org.symbian.smf.plugin.activity.fetcher/v0.2" ); |
93 |
98 |
94 #endif /* SMFACTIVITYFETCHERPLUGIN_H_ */ |
99 #endif /* SMFACTIVITYFETCHERPLUGIN_H_ */ |