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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
This file is part of libqopensync.
Copyright (c) 2005 Tobias Koenig <tokoe@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 QSYNC_MEMBER_H
#define QSYNC_MEMBER_H
#include <libqopensync/plugin.h>
#include <libqopensync/result.h>
#include <libqopensync/plugin.h>
class OSyncMember;
namespace QSync {
class Member
{
friend class Group;
friend class SyncChange;
friend class SyncMemberUpdate;
public:
Member();
~Member();
/**
Returns whether the member object is valid.
*/
bool isValid() const;
/**
Returns the configuration directory.
*/
QString configurationDirectory() const;
/**
Returns the name of the plugin, the member belongs to.
*/
QString pluginName() const;
/**
Returns the plugin, the member belongs to.
*/
Plugin plugin() const;
/**
Returns the id of the plugin.
*/
int id() const;
/**
Sets the name of this member.
*/
void setName( const QString &name );
/**
Returns the name of this member.
*/
QString name() const;
/**
Sets the configuration data as byte array. The developer has to decide the
type of the data ( e.g. xml, plain text, binary ).
*/
void setConfiguration( const QByteArray &configurationData );
/**
Gets the configuration data as byte array. The developer has to decide the
type of the data ( e.g. xml, plain text, binary ).
@param useDefault If set to true, return default config, if no config
exists. If set to false, return error when no config
exists.
@returns The result of this operation.
*/
Result configuration( QByteArray &configurationData,
bool useDefault = true );
/**
Saves the changes to the configuration to hard disc.
*/
Result save();
/**
Make this member an instance of the given plugin.
*/
Result instance( const Plugin & );
bool operator==( const Member& ) const;
/**
This method can be used to query the plugin for scanning devices.
The @param query is a plugin specific xml document as well as
the return value.
*/
QString scanDevices( const QString &query );
/**
This method can be used to test whether the plugin can connect
to the device with the given configuration.
*/
bool testConnection( const QString &configuration );
private:
OSyncMember *mMember;
};
}
#endif
|
