|
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 events |
|
17 * Note: This class has dependencies on QtMobility project |
|
18 * |
|
19 */ |
|
20 |
|
21 |
|
22 #ifndef SMFMUSICEVENTSPLUGIN_H_ |
|
23 #define SMFMUSICEVENTSPLUGIN_H_ |
|
24 |
|
25 #include <smfpluginbase.h> |
|
26 #include <qtcontacts.h> |
|
27 #include <smfevent.h> |
|
28 #include <smfplace.h> |
|
29 |
|
30 // Forward declaration |
|
31 class SmfPluginManagerUtil; |
|
32 |
|
33 using namespace QtMobility; |
|
34 |
|
35 /** |
|
36 * @ingroup smf_plugin_group |
|
37 * Interface specification for music events |
|
38 * |
|
39 * All of the functionality described here should be implemented by a service |
|
40 * specific plug-in. |
|
41 * |
|
42 * Note: This class has dependencies on QtMobility project |
|
43 */ |
|
44 class SmfMusicEventsPlugin : public SmfPluginBase |
|
45 { |
|
46 Q_OBJECT |
|
47 public: |
|
48 /** |
|
49 * Constructor with default argument |
|
50 * @param aUtil The SmfPluginManagerUtil instance. The plugins can |
|
51 * call the method getAuthKeys() of this class, with its pluginID to |
|
52 * get the OAuth keys, keys are returned only if this plugin is |
|
53 * authorised by Smf framework |
|
54 */ |
|
55 SmfMusicEventsPlugin( SmfPluginManagerUtil* aUtil ); |
|
56 |
|
57 /** |
|
58 * Destructor |
|
59 */ |
|
60 ~SmfMusicEventsPlugin( ); |
|
61 |
|
62 /** |
|
63 * Method to get the events based on location |
|
64 * @param aRequest [out] The request data to be sent to network |
|
65 * @param aLocation Location of the event |
|
66 * @param aPageNum The page to be extracted |
|
67 * @param aItemsPerPage Number of items per page |
|
68 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
69 */ |
|
70 virtual SmfPluginError events( SmfPluginRequestData &aRequest, |
|
71 const QtMobility::QContactGeolocation &aLocation, |
|
72 const int aPageNum = SMF_FIRST_PAGE, |
|
73 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
74 |
|
75 /** |
|
76 * Method to get the venues based on location |
|
77 * @param aRequest [out] The request data to be sent to network |
|
78 * @param aLocation Location of the venue |
|
79 * @param aPageNum The page to be extracted |
|
80 * @param aItemsPerPage Number of items per page |
|
81 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
82 */ |
|
83 virtual SmfPluginError venues( SmfPluginRequestData &aRequest, |
|
84 const QtMobility::QContactGeolocation &aLocation, |
|
85 const int aPageNum = SMF_FIRST_PAGE, |
|
86 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
87 |
|
88 /** |
|
89 * Method to get the events based on venues |
|
90 * @param aRequest [out] The request data to be sent to network |
|
91 * @param aVenue Venue of the event |
|
92 * @param aPageNum The page to be extracted |
|
93 * @param aItemsPerPage Number of items per page |
|
94 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
95 */ |
|
96 virtual SmfPluginError events( SmfPluginRequestData &aRequest, |
|
97 const SmfPlace &aVenue, |
|
98 const int aPageNum = SMF_FIRST_PAGE, |
|
99 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
100 |
|
101 /** |
|
102 * Method to post events |
|
103 * @param aRequest [out] The request data to be sent to network |
|
104 * @param aEventList The list of events to be posted |
|
105 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
106 */ |
|
107 virtual SmfPluginError postEvents( SmfPluginRequestData &aRequest, |
|
108 const QList<SmfEvent> &aEventList ) = 0; |
|
109 |
|
110 }; |
|
111 |
|
112 Q_DECLARE_INTERFACE( SmfMusicEventsPlugin, "org.symbian.smf.plugin.music.events/v1.0" ); |
|
113 |
|
114 #endif /* SMFMUSICEVENTSPLUGIN_H_ */ |