smf/smfservermodule/smfserver/smfplugins/smfactivityfetcherplugin.h
author cgandhi
Thu, 23 Sep 2010 17:43:31 +0530
changeset 25 a180113055cb
parent 14 a469c0e6e7fb
permissions -rw-r--r--
Music Events are now normal Fetcher APIs added All APIs now return SmfError Canceling Request now supported Music Search now based on category Providerinfo added in DSM Added secondary ID, count, location to SMFAlbum Tags for Artist added Get tracks for album and artist added Added URL to subtitle DSM Bug fixes Detailed debugging logs filtered in server, pluginmgr, transportmgr playlistsOf() method changed in smfclient and plugin interfaces. RVCT B686 compilation issues resolved.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     1
/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     2
 * Copyright (c) 2010 Sasken Communication Technologies Ltd. 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     3
 * All rights reserved.
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     4
 * This component and the accompanying materials are made available 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     5
 * under the terms of the "Eclipse Public License v1.0"
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     6
 * which accompanies  this distribution, and is available 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html"
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     8
 * 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     9
 * Initial Contributors:
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    10
 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    11
 *
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    12
 * Contributors:
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    13
 * Manasij Roy, Nalina Hariharan
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    14
 * 
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    15
 * Description:
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    16
 * Interface specification for plugins that implements social activity related services
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    17
 *
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    18
 */
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    19
#ifndef SMFACTIVITYFETCHERPLUGIN_H_
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    20
#define SMFACTIVITYFETCHERPLUGIN_H_
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    21
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    22
#include <smfpluginbase.h>
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    23
#include <smfactions.h>
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    24
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    25
// Forward declaration
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    26
class SmfContact;
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    27
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    28
/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    29
 * @ingroup smf_plugin_group
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    30
 * Interface specification for fetching social activity list for a user. 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    31
 * This class provides basic functionality to allow applications to obtain list of
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    32
 * activities like "marked as favourite", "commented on a picture" etc in a 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    33
 * social networking service.
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    34
 *
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    35
 * All of the functionality described here should be implemented by a service
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    36
 * specific plug-in.
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    37
 */
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    38
class SmfActivityFetcherPlugin : public SmfPluginBase
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    39
	{
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    40
public:
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    41
	/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    42
	 * Destructor
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    43
	 */
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    44
	virtual ~SmfActivityFetcherPlugin( ) {}
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    45
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    46
	/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    47
	 * Method to get the list of self activities, e.g. shown in own wall
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    48
	 * @param aRequest [out] The request data that plugin generates (to be sent to network)
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    49
	 * @param aPageNum [in] The page to be extracted
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    50
	 * @param aItemsPerPage [in] Number of items per page
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    51
	 * @return Appropriate value of the enum SmfPluginError.
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    52
	 * Plugin error if any, else SmfPluginErrNone for success
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    53
	 */
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    54
	virtual SmfPluginError selfActivities( SmfPluginRequestData &aRequest,
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    55
			const int aPageNum = SMF_FIRST_PAGE, 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    56
			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    57
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    58
	/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    59
	 * Method to get the list of activities for other, e.g. shown in a friends wall
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    60
	 * @param aRequest [out] The request data plugin generated (to be sent to network)
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    61
	 * @param aContact [in] The contact containing the URI, name or id of the user 
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    62
	 * @param aPageNum [in] The page to be extracted
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    63
	 * @param aItemsPerPage [in] Number of items per page
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    64
	 * @return Appropriate value of the enum SmfPluginError.
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    65
	 * Plugin error if any, else SmfPluginErrNone for success
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    66
	 */
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    67
	virtual SmfPluginError friendsActivities( SmfPluginRequestData &aRequest,
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    68
			const SmfContact &aContact,			
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    69
			const int aPageNum = SMF_FIRST_PAGE, 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    70
			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    71
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    72
	/**
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    73
	 * Method to get list of self activities filtered by activity type, e.g. only photo updates in own wall
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    74
	 * @param aRequest [out] The request data plugin generated (to be sent to network)
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    75
	 * @param aFilters [in] The list of activity types to be included in result
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    76
	 * @param aPageNum [in] The page to be extracted
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    77
	 * @param aItemsPerPage[in] Number of items per page
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    78
	 * @return Appropriate value of the enum SmfPluginError.
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    79
	 * Plugin error if any, else SmfPluginErrNone for success
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    80
	 */
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    81
	virtual SmfPluginError filtered( SmfPluginRequestData &aRequest,
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    82
			QList<SmfActivityObjectType> &aFilters,
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    83
			const int aPageNum = SMF_FIRST_PAGE, 
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    84
			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    85
	
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    86
	/**
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    87
	 * Customised method for SmfActivityFetcherPlugin interface
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    88
	 * @param aRequest [out] The request data to be sent to network
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    89
	 * @param aOperation [in] The operation type (should be known between 
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    90
	 * the client interface and the plugin)
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    91
	 * @param aData [in] The data required to form the request (The type 
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    92
	 * of data should be known between client and the plugin)
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    93
	 * @return Appropriate value of the enum SmfPluginError.
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 14
diff changeset
    94
	 * Plugin error if any, else SmfPluginErrNone for success
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    95
	 */
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    96
	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    97
			const int &aOperation, QByteArray *aData ) = 0;
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents: 8
diff changeset
    98
	
8
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    99
	};
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
   100
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
   101
Q_DECLARE_INTERFACE( SmfActivityFetcherPlugin, "org.symbian.smf.plugin.activity.fetcher/v0.2" );
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
   102
4102c67b6e56 Restoring the missing activity related and music headers
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
   103
#endif /* SMFACTIVITYFETCHERPLUGIN_H_ */