KLDAPCore::LdapClient
#include <ldapclient.h>
Signals | |
void | done () |
void | error (const QString &message) |
void | result (const KLDAPCore::LdapClient &client, const KLDAPCore::LdapObject &) |
Detailed Description
An object that represents a configured LDAP server.
This class represents a client that to an LDAP server that can be used for LDAP lookups. Every client is identified by a unique numeric id.
- Since
- 4.5
Definition at line 28 of file ldapclient.h.
Constructor & Destructor Documentation
◆ LdapClient()
Creates a new ldap client.
- Parameters
-
clientNumber The unique number of this client. parent The parent object.
Definition at line 62 of file ldapclient.cpp.
◆ ~LdapClient()
|
overridedefault |
Destroys the ldap client.
Member Function Documentation
◆ attributes()
QStringList LdapClient::attributes | ( | ) | const |
Returns the LDAP attributes that should be returned in the query result.
Definition at line 93 of file ldapclient.cpp.
◆ cancelQuery()
void LdapClient::cancelQuery | ( | ) |
Cancels a running query.
Definition at line 135 of file ldapclient.cpp.
◆ clientNumber()
int LdapClient::clientNumber | ( | ) | const |
Returns the number of this client.
Definition at line 262 of file ldapclient.cpp.
◆ completionWeight()
int LdapClient::completionWeight | ( | ) | const |
Returns the completion weight of this client.
Definition at line 267 of file ldapclient.cpp.
◆ done
|
signal |
This signal is emitted when the query has finished.
◆ error
This signal is emitted in case of an error.
- Parameters
-
message A message that describes the error.
◆ isActive()
bool LdapClient::isActive | ( | ) | const |
Returns whether this client is currently running a search query.
Definition at line 72 of file ldapclient.cpp.
◆ result
|
signal |
This signal is emitted once for each object that is returned from the query.
◆ server()
const KLDAPCore::LdapServer LdapClient::server | ( | ) | const |
Returns the ldap server information that are used by this client.
Definition at line 82 of file ldapclient.cpp.
◆ setAttributes()
void LdapClient::setAttributes | ( | const QStringList & | attributes | ) |
Sets the LDAP attributes
that should be returned in the query result.
Pass an empty list to include all available attributes.
Definition at line 87 of file ldapclient.cpp.
◆ setCompletionWeight()
void LdapClient::setCompletionWeight | ( | int | weight | ) |
Sets the completion weight
of this client.
This value will be used to sort the results of this client when used for auto completion.
Definition at line 272 of file ldapclient.cpp.
◆ setScope()
Sets the scope
of the LDAP query.
Valid values are 'one' or 'sub'.
Definition at line 98 of file ldapclient.cpp.
◆ setServer()
void LdapClient::setServer | ( | const KLDAPCore::LdapServer & | server | ) |
Sets the LDAP server
information that shall be used by this client.
Definition at line 77 of file ldapclient.cpp.
◆ startQuery()
Starts the query with the given filter
.
Definition at line 103 of file ldapclient.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:55:32 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.