1 /** |
|
2 * @file smfmusiceventsplugin.h |
|
3 * @author Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution |
|
4 * @version 1.0 |
|
5 * |
|
6 * @section LICENSE |
|
7 * |
|
8 * Copyright (c) 2010 Sasken Communication Technologies Ltd. |
|
9 * All rights reserved. |
|
10 * This component and the accompanying materials are made available |
|
11 * under the terms of the "Eclipse Public License v1.0" |
|
12 * which accompanies this distribution, and is available |
|
13 * at the URL "http://www.eclipse.org/legal/epl-v10.html" |
|
14 * |
|
15 * @section DESCRIPTION |
|
16 * |
|
17 * Interface specification for music events |
|
18 * |
|
19 * Note: This class has dependencies on QtMobility project |
|
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 using namespace QtMobility; |
|
31 |
|
32 /** |
|
33 * @ingroup smf_plugin_group |
|
34 * Interface specification for music events |
|
35 * |
|
36 * All of the functionality described here should be implemented by a service |
|
37 * specific plug-in. |
|
38 * |
|
39 * Note: This class has dependencies on QtMobility project |
|
40 */ |
|
41 class SmfMusicEventsPlugin : public SmfPluginBase |
|
42 { |
|
43 Q_OBJECT |
|
44 public: |
|
45 /** |
|
46 * Constructor with default argument |
|
47 * @param aParent The parent object |
|
48 */ |
|
49 SmfMusicEventsPlugin( QObject* aParent = 0 ); |
|
50 |
|
51 /** |
|
52 * Destructor |
|
53 */ |
|
54 ~SmfMusicEventsPlugin( ); |
|
55 |
|
56 /** |
|
57 * Method to get the events based on location |
|
58 * @param aRequest [out] The request data to be sent to network |
|
59 * @param aLocation Location of the event |
|
60 * @param aPageNum The page to be extracted |
|
61 * @param aItemsPerPage Number of items per page |
|
62 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
63 */ |
|
64 virtual SmfPluginError events( SmfPluginRequestData *aRequest, |
|
65 const QtMobility::QContactGeolocation aLocation, |
|
66 const int aPageNum = SMF_FIRST_PAGE, |
|
67 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
68 |
|
69 /** |
|
70 * Method to get the venues based on location |
|
71 * @param aRequest [out] The request data to be sent to network |
|
72 * @param aLocation Location of the venue |
|
73 * @param aPageNum The page to be extracted |
|
74 * @param aItemsPerPage Number of items per page |
|
75 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
76 */ |
|
77 virtual SmfPluginError venues( SmfPluginRequestData *aRequest, |
|
78 const QtMobility::QContactGeolocation aLocation, |
|
79 const int aPageNum = SMF_FIRST_PAGE, |
|
80 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
81 |
|
82 /** |
|
83 * Method to get the events based on venues |
|
84 * @param aRequest [out] The request data to be sent to network |
|
85 * @param aVenue Venue of the event |
|
86 * @param aPageNum The page to be extracted |
|
87 * @param aItemsPerPage Number of items per page |
|
88 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
89 */ |
|
90 virtual SmfPluginError events( SmfPluginRequestData *aRequest, |
|
91 const SmfPlace aVenue, |
|
92 const int aPageNum = SMF_FIRST_PAGE, |
|
93 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
94 |
|
95 /** |
|
96 * Method to post events |
|
97 * @param aRequest [out] The request data to be sent to network |
|
98 * @param aEventList The list of events to be posted |
|
99 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
100 */ |
|
101 virtual SmfPluginError postEvents( SmfPluginRequestData *aRequest, |
|
102 const QList<SmfEvent> aEventList ) = 0; |
|
103 |
|
104 }; |
|
105 |
|
106 Q_DECLARE_INTERFACE( SmfMusicEventsPlugin, "org.symbian.smf.plugin.music.events/v1.0" ); |
|
107 |
|
108 #endif /* SMFMUSICEVENTSPLUGIN_H_ */ |
|