1 /** |
|
2 * Copyright (c) 2010 Sasken Communication Technologies Ltd. |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html" |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution |
|
11 * |
|
12 * Contributors: |
|
13 * Manasij Roy, Nalina Hariharan |
|
14 * |
|
15 * Description: |
|
16 * Interface specification for music services |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef SMFMUSICSERVICEPLUGIN_H_ |
|
22 #define SMFMUSICSERVICEPLUGIN_H_ |
|
23 |
|
24 #include <smfpluginbase.h> |
|
25 #include <smfmusicprofile.h> |
|
26 #include <smflocation.h> |
|
27 |
|
28 /** |
|
29 * @ingroup smf_plugin_group |
|
30 * Interface specification for music services. This class provides basic |
|
31 * functionality to allow application to search for a user or check for |
|
32 * user information etc. |
|
33 * |
|
34 * All of the functionality described here should be implemented by a service |
|
35 * specific plug-in. |
|
36 */ |
|
37 class SmfMusicServicePlugin : public SmfPluginBase |
|
38 { |
|
39 public: |
|
40 |
|
41 /** |
|
42 * Destructor |
|
43 */ |
|
44 virtual ~SmfMusicServicePlugin( ) {} |
|
45 |
|
46 /** |
|
47 * Method to get self profile information |
|
48 * @param aRequest [out] The request data to be sent to network |
|
49 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
50 */ |
|
51 virtual SmfPluginError userInfo( SmfPluginRequestData &aRequest ) = 0; |
|
52 |
|
53 /** |
|
54 * Method to search information about other service users for a |
|
55 * particular place |
|
56 * @param aRequest [out] The request data to be sent to network |
|
57 * @param aPlace The place which is the search criteria |
|
58 * @param aPageNum The page to be extracted |
|
59 * @param aItemsPerPage Number of items per page |
|
60 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
61 */ |
|
62 virtual SmfPluginError searchUser( SmfPluginRequestData &aRequest, |
|
63 const SmfLocation &aPlace, |
|
64 const int aPageNum = SMF_FIRST_PAGE, |
|
65 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
66 |
|
67 /** |
|
68 * Customised method for SmfMusicServicePlugin interface |
|
69 * @param aRequest [out] The request data to be sent to network |
|
70 * @param aOperation The operation type (should be known between |
|
71 * the client interface and the plugin) |
|
72 * @param aData The data required to form the request (The type |
|
73 * of data should be known between client and the plugin) |
|
74 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
75 */ |
|
76 virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, |
|
77 const int &aOperation, QByteArray *aData ) = 0; |
|
78 |
|
79 }; |
|
80 |
|
81 Q_DECLARE_INTERFACE( SmfMusicServicePlugin, "org.symbian.smf.plugin.music.service/v1.0" ); |
|
82 |
|
83 #endif /* SMFMUSICSERVICEPLUGIN_H_ */ |
|