1 | /* |
2 | Copyright (c) 2007 Volker Krause <vkrause@kde.org> |
3 | |
4 | This library is free software; you can redistribute it and/or modify it |
5 | under the terms of the GNU Library General Public License as published by |
6 | the Free Software Foundation; either version 2 of the License, or (at your |
7 | option) any later version. |
8 | |
9 | This library is distributed in the hope that it will be useful, but WITHOUT |
10 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
11 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public |
12 | License for more details. |
13 | |
14 | You should have received a copy of the GNU Library General Public License |
15 | along with this library; see the file COPYING.LIB. If not, write to the |
16 | Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
17 | 02110-1301, USA. |
18 | */ |
19 | |
20 | #ifndef AKONADI_SUBSCRIPTIONJOB_P_H |
21 | #define AKONADI_SUBSCRIPTIONJOB_P_H |
22 | |
23 | #include <akonadi/collection.h> |
24 | #include <akonadi/job.h> |
25 | |
26 | namespace Akonadi { |
27 | |
28 | class SubscriptionJobPrivate; |
29 | |
30 | /** |
31 | * @internal |
32 | * |
33 | * @short Job to manipulate the local subscription state of a set of collections. |
34 | */ |
35 | class AKONADI_EXPORT SubscriptionJob : public Job |
36 | { |
37 | Q_OBJECT |
38 | public: |
39 | /** |
40 | * Creates a new subscription job. |
41 | * |
42 | * @param parent The parent object. |
43 | */ |
44 | explicit SubscriptionJob(QObject *parent = 0); |
45 | |
46 | /** |
47 | * Destroys the subscription job. |
48 | */ |
49 | ~SubscriptionJob(); |
50 | |
51 | /** |
52 | * Subscribes to the given list of collections. |
53 | * |
54 | * @param collections List of collections to subscribe to. |
55 | */ |
56 | void subscribe(const Collection::List &collections); |
57 | |
58 | /** |
59 | * Unsubscribes from the given list of collections. |
60 | * |
61 | * @param collections List of collections to unsubscribe from. |
62 | */ |
63 | void unsubscribe(const Collection::List &collections); |
64 | |
65 | protected: |
66 | void doStart(); |
67 | void doHandleResponse(const QByteArray &tag, const QByteArray &data); |
68 | |
69 | private: |
70 | Q_DECLARE_PRIVATE(SubscriptionJob) |
71 | }; |
72 | |
73 | } |
74 | |
75 | #endif |
76 | |