1 | /* |
2 | Copyright (c) 2014 Christian Mollekopf <mollekopf@kolabsys.com> |
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_TAGCREATEJOB_H |
21 | #define AKONADI_TAGCREATEJOB_H |
22 | |
23 | #include <akonadi/job.h> |
24 | |
25 | namespace Akonadi { |
26 | |
27 | class Tag; |
28 | class TagCreateJobPrivate; |
29 | |
30 | /** |
31 | * @short Job that creates a new tag in the Akonadi storage. |
32 | * @since 4.13 |
33 | */ |
34 | class AKONADI_EXPORT TagCreateJob : public Job |
35 | { |
36 | Q_OBJECT |
37 | |
38 | public: |
39 | /** |
40 | * Creates a new tag create job. |
41 | * |
42 | * @param tag The tag to create. |
43 | * @param parent The parent object. |
44 | */ |
45 | explicit TagCreateJob(const Tag &tag, QObject *parent = 0); |
46 | |
47 | /** |
48 | * Returns the created tag with the new unique id, or an invalid tag if the job failed. |
49 | */ |
50 | Tag tag() const; |
51 | |
52 | /** |
53 | * Merges the tag by GID if it is already existing, and returns the merged version. |
54 | * This is false by default. |
55 | * |
56 | * Note that the returned tag does not contain attributes. |
57 | */ |
58 | void setMergeIfExisting(bool merge); |
59 | |
60 | protected: |
61 | virtual void doStart(); |
62 | virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data); |
63 | |
64 | private: |
65 | Q_DECLARE_PRIVATE(TagCreateJob) |
66 | }; |
67 | |
68 | } |
69 | |
70 | #endif |
71 | |