Akonadi

tagcreatejob.h
1/*
2 SPDX-FileCopyrightText: 2014 Christian Mollekopf <mollekopf@kolabsys.com>
3
4 SPDX-License-Identifier: LGPL-2.0-or-later
5*/
6
7#pragma once
8
9#include "akonadicore_export.h"
10#include "job.h"
11
12namespace Akonadi
13{
14class Tag;
15class TagCreateJobPrivate;
16
17/**
18 * @short Job that creates a new tag in the Akonadi storage.
19 * @since 4.13
20 */
21class AKONADICORE_EXPORT TagCreateJob : public Job
22{
23 Q_OBJECT
24
25public:
26 /**
27 * Creates a new tag create job.
28 *
29 * @param tag The tag to create.
30 * @param parent The parent object.
31 */
32 explicit TagCreateJob(const Tag &tag, QObject *parent = nullptr);
33
34 /**
35 * Returns the created tag with the new unique id, or an invalid tag if the job failed.
36 */
37 [[nodiscard]] Tag tag() const;
38
39 /**
40 * Merges the tag by GID if it is already existing, and returns the merged version.
41 * This is false by default.
42 *
43 * Note that the returned tag does not contain attributes.
44 */
45 void setMergeIfExisting(bool merge);
46
47protected:
48 void doStart() override;
49 bool doHandleResponse(qint64 tag, const Protocol::CommandPtr &response) override;
50
51private:
52 Q_DECLARE_PRIVATE(TagCreateJob)
53};
54
55}
Base class for all actions in the Akonadi storage.
Definition job.h:81
Job that creates a new tag in the Akonadi storage.
An Akonadi Tag.
Definition tag.h:26
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:58:37 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.