|
18
|
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 |
* Represents activity in terms similar to standard activity stream http://activitystrea.ms/
|
|
|
17 |
*
|
|
|
18 |
*/
|
|
|
19 |
|
|
|
20 |
#ifndef SMFACTIVITYFETCHER_H_
|
|
|
21 |
#define SMFACTIVITYFETCHER_H_
|
|
|
22 |
|
|
|
23 |
#include <QList>
|
|
|
24 |
#include <smfglobal.h>
|
|
|
25 |
#include <smfactions.h>
|
|
|
26 |
|
|
|
27 |
// Forward declaration
|
|
|
28 |
class SmfActivityFetcherPrivate;
|
|
|
29 |
class SmfProvider;
|
|
|
30 |
class SmfContact;
|
|
|
31 |
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* @ingroup smf_client_group
|
|
|
35 |
* Basic activity service ("org.symbian.smf.client.activity.fetcher")
|
|
|
36 |
*/
|
|
|
37 |
class SMFCLIENT_EXPORT SmfActivityFetcher : public QObject
|
|
|
38 |
{
|
|
|
39 |
Q_OBJECT
|
|
|
40 |
|
|
|
41 |
public:
|
|
|
42 |
/**
|
|
|
43 |
* Constructs SmfActivity.
|
|
|
44 |
* @param baseProvider The base provider info
|
|
|
45 |
*/
|
|
|
46 |
SmfActivityFetcher(SmfProvider* baseprovider = 0);
|
|
|
47 |
|
|
|
48 |
/**
|
|
|
49 |
* Destructor
|
|
|
50 |
*/
|
|
|
51 |
~SmfActivityFetcher();
|
|
|
52 |
|
|
|
53 |
public slots:
|
|
|
54 |
/**
|
|
|
55 |
* Emits signal resultsAvailable() when list of activities for the user is available
|
|
25
|
56 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
|
18
|
57 |
*/
|
|
25
|
58 |
SmfError selfActivities(int pageNum = SMF_FIRST_PAGE,int perPage = SMF_ITEMS_PER_PAGE);
|
|
18
|
59 |
|
|
|
60 |
/**
|
|
|
61 |
* Emits signal resultsAvailable() when list of activities for other contact is available
|
|
25
|
62 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
|
18
|
63 |
*/
|
|
25
|
64 |
SmfError friendsActivities(const SmfContact& aFriend, int pageNum = SMF_FIRST_PAGE,
|
|
18
|
65 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* returns only those activities (self) which are from @arg filters
|
|
25
|
69 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
|
18
|
70 |
*/
|
|
25
|
71 |
SmfError filtered(QList<SmfActivityObjectType> filters, int pageNum = SMF_FIRST_PAGE,
|
|
18
|
72 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
|
73 |
|
|
|
74 |
/**
|
|
|
75 |
* Request for a custom operation. The signal customDataAvailable() is emitted
|
|
|
76 |
* when the result is available.
|
|
|
77 |
* @param operationId OperationId
|
|
|
78 |
* @param customData Custom data to be sent
|
|
25
|
79 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
|
18
|
80 |
* Note:-Interpretation of operationId and customData is upto the concerned
|
|
|
81 |
* plugin and client application. service provider should provide some
|
|
|
82 |
* serializing-deserializing utilities for these custom data
|
|
|
83 |
*/
|
|
25
|
84 |
SmfError customRequest ( const int& operationId, QByteArray* customData );
|
|
|
85 |
|
|
|
86 |
/**
|
|
|
87 |
* Cancels a request generated due to the call to any API which results
|
|
|
88 |
* into http request. Might return error if no request is currently pending.
|
|
|
89 |
* Please note that there can be only one request pending at any point of time
|
|
|
90 |
* @return Appropriate SmfError value
|
|
|
91 |
*/
|
|
|
92 |
SmfError cancelRequest ();
|
|
18
|
93 |
|
|
|
94 |
signals:
|
|
|
95 |
/**
|
|
|
96 |
* Signals availability of the result of the previous query
|
|
|
97 |
*/
|
|
|
98 |
void resultsAvailable(SmfActivityEntryList* entries, SmfError error, SmfResultPage resultPage);
|
|
|
99 |
|
|
|
100 |
/**
|
|
|
101 |
* Signals availability of the result of the customRequest
|
|
|
102 |
*/
|
|
|
103 |
void customDataAvailable( const int& operationId, QByteArray* customData );
|
|
|
104 |
|
|
|
105 |
private:
|
|
|
106 |
/**
|
|
|
107 |
* Gets the base provider info
|
|
|
108 |
*/
|
|
|
109 |
SmfProvider* getProvider() const;
|
|
|
110 |
|
|
|
111 |
// Friend Class
|
|
|
112 |
friend class SmfActivityFetcherPrivate;
|
|
|
113 |
|
|
|
114 |
private:
|
|
|
115 |
SmfActivityFetcherPrivate* m_private;
|
|
|
116 |
SmfProvider* m_baseProvider;
|
|
|
117 |
|
|
|
118 |
};
|
|
|
119 |
|
|
|
120 |
SMF_SERVICE_NAME(SmfActivityFetcher, "org.symbian.smf.client.activity.fetcher\0.2")
|
|
|
121 |
|
|
|
122 |
#endif /* SMFACTIVITYFETCHER_H_ */
|