1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
Copyright (c) 2009 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_RESOURCESELECTJOB_P_H
#define AKONADI_RESOURCESELECTJOB_P_H
#include "akonadiprivate_export.h"
#include <akonadi/job.h>
namespace Akonadi {
class ResourceSelectJobPrivate;
/**
* @internal
*
* @short Job that selects a resource context for remote identifier based operations.
*
* This job selects a resource context that is used whenever remote identifier
* based operations ( e.g. fetch items or collections by remote identifier ) are
* executed.
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* // Find out the akonadi id of the item with the remote id 'd1627013c6d5a2e7bb58c12560c27047'
* // that is stored in the resource with identifier 'my_mail_resource'
*
* Session *m_resourceSession = new Session( "resourceSession" );
*
* ResourceSelectJob *job = new ResourceSelectJob( "my_mail_resource", resourceSession );
*
* connect( job, SIGNAL( result( KJob* ) ), SLOT( resourceSelected( KJob* ) ) );
* ...
*
* void resourceSelected( KJob *job )
* {
* if ( job->error() )
* return;
*
* Item item;
* item.setRemoteIdentifier( "d1627013c6d5a2e7bb58c12560c27047" );
*
* ItemFetchJob *fetchJob = new ItemFetchJob( item, m_resourceSession );
* connect( fetchJob, SIGNAL( result( KJob* ) ), SLOT( itemFetched( KJob* ) ) );
* }
*
* void itemFetched( KJob *job )
* {
* if ( job->error() )
* return;
*
* const Item item = job->items().first();
*
* qDebug() << "Remote id" << item.remoteId() << "has akonadi id" << item.id();
* }
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_TESTS_EXPORT ResourceSelectJob : public Job
{
Q_OBJECT
public:
/**
* Selects the specified resource for all following remote identifier
* based operations in the same session.
*
* @param identifier The resource identifier, or any empty string to reset
* the selection.
* @param parent The parent object.
*/
explicit ResourceSelectJob( const QString &identifier, QObject *parent = 0 );
protected:
void doStart();
private:
//@cond PRIVATE
Q_DECLARE_PRIVATE( ResourceSelectJob )
//@endcond PRIVATE
};
}
#endif
|