QXmpp Version: 1.10.4
 
Loading...
Searching...
No Matches
QXmppConfiguration.h
1// SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
2//
3// SPDX-License-Identifier: LGPL-2.1-or-later
4
5#ifndef QXMPPCONFIGURATION_H
6#define QXMPPCONFIGURATION_H
7
8#include "QXmppGlobal.h"
9
10#include <optional>
11
12#include <QSharedDataPointer>
13#include <QString>
14
15class QNetworkProxy;
16class QSslCertificate;
17class QXmppConfigurationPrivate;
19class QXmppSasl2UserAgent;
20
21namespace QXmpp::Private {
22struct Credentials;
23}
24
36class QXMPP_EXPORT QXmppConfiguration
37{
38public:
51
59
64
65 QString host() const;
66 void setHost(const QString &);
67
68 QString domain() const;
69 void setDomain(const QString &);
70
71 int port() const;
72 quint16 port16() const;
73 void setPort(int);
74
75 QString user() const;
76 void setUser(const QString &);
77
78 QString password() const;
79 void setPassword(const QString &);
80
81 QString resource() const;
82 void setResource(const QString &);
83
84 QString resourcePrefix() const;
85 void setResourcePrefix(const QString &);
86
87 QString jid() const;
88 void setJid(const QString &jid);
89
90 QString jidBare() const;
91
93 void setCredentials(const QXmppCredentials &);
94
95 QString facebookAccessToken() const;
96 void setFacebookAccessToken(const QString &);
97
98 QString facebookAppId() const;
99 void setFacebookAppId(const QString &);
100
101 QString googleAccessToken() const;
102 void setGoogleAccessToken(const QString &accessToken);
103
104 QString windowsLiveAccessToken() const;
105 void setWindowsLiveAccessToken(const QString &accessToken);
106
107 bool autoAcceptSubscriptions() const;
109
110 bool autoReconnectionEnabled() const;
112
113 bool useSasl2Authentication() const;
114 void setUseSasl2Authentication(bool);
115
116 bool useFastTokenAuthentication() const;
118
119 bool useSASLAuthentication() const;
120 void setUseSASLAuthentication(bool);
121
122 bool useNonSASLAuthentication() const;
124
125 bool ignoreSslErrors() const;
126 void setIgnoreSslErrors(bool);
127
130
133
134 QString saslAuthMechanism() const;
135 void setSaslAuthMechanism(const QString &mechanism);
136
137 QList<QString> disabledSaslMechanisms() const;
138 void addDisabledSaslMechanism(const QString &);
139 void setDisabledSaslMechanisms(const QList<QString> &);
140
141 std::optional<QXmppSasl2UserAgent> sasl2UserAgent() const;
142 void setSasl2UserAgent(const std::optional<QXmppSasl2UserAgent> &);
143
144 QNetworkProxy networkProxy() const;
145 void setNetworkProxy(const QNetworkProxy &proxy);
146
147 int keepAliveInterval() const;
148 void setKeepAliveInterval(int secs);
149
150 int keepAliveTimeout() const;
151 void setKeepAliveTimeout(int secs);
152
153 QList<QSslCertificate> caCertificates() const;
154 void setCaCertificates(const QList<QSslCertificate> &);
155
157 const QXmpp::Private::Credentials &credentialData() const;
158 QXmpp::Private::Credentials &credentialData();
160
161private:
162 QSharedDataPointer<QXmppConfigurationPrivate> d;
163};
164
165#endif // QXMPPCONFIGURATION_H
The QXmppConfiguration class holds configuration options.
Definition QXmppConfiguration.h:37
QString host() const
Returns the custom hostname to connect to.
Definition QXmppConfiguration.cpp:249
bool autoAcceptSubscriptions() const
Definition QXmppConfiguration.cpp:416
void setDisabledSaslMechanisms(const QList< QString > &)
Definition QXmppConfiguration.cpp:615
void setResource(const QString &)
Definition QXmppConfiguration.cpp:208
QString domain() const
Returns the domain part of the JID.
Definition QXmppConfiguration.cpp:255
bool useSASLAuthentication() const
Returns whether to make use of SASL authentication.
Definition QXmppConfiguration.cpp:514
QString saslAuthMechanism() const
Returns the preferred SASL authentication mechanism.
Definition QXmppConfiguration.cpp:566
QNetworkProxy networkProxy() const
Definition QXmppConfiguration.cpp:661
void setJid(const QString &jid)
Definition QXmppConfiguration.cpp:238
void setWindowsLiveAccessToken(const QString &accessToken)
Definition QXmppConfiguration.cpp:405
void setStreamSecurityMode(QXmppConfiguration::StreamSecurityMode mode)
Definition QXmppConfiguration.cpp:546
QXmppConfiguration::StreamSecurityMode streamSecurityMode() const
Definition QXmppConfiguration.cpp:539
QString resourcePrefix() const
Definition QXmppConfiguration.cpp:218
quint16 port16() const
Definition QXmppConfiguration.cpp:271
bool autoReconnectionEnabled() const
Definition QXmppConfiguration.cpp:438
QXmppConfiguration::NonSASLAuthMechanism nonSASLAuthMechanism() const
Returns the Non-SASL authentication mechanism configuration.
Definition QXmppConfiguration.cpp:553
void setSaslAuthMechanism(const QString &mechanism)
Definition QXmppConfiguration.cpp:577
bool useSasl2Authentication() const
Definition QXmppConfiguration.cpp:458
QString windowsLiveAccessToken() const
Returns the access token used for X-MESSENGER-OAUTH2 authentication.
Definition QXmppConfiguration.cpp:394
void setUseSASLAuthentication(bool)
Sets whether to make use of SASL authentication.
Definition QXmppConfiguration.cpp:520
int keepAliveTimeout() const
Definition QXmppConfiguration.cpp:708
void setNetworkProxy(const QNetworkProxy &proxy)
Definition QXmppConfiguration.cpp:650
void setSasl2UserAgent(const std::optional< QXmppSasl2UserAgent > &)
Definition QXmppConfiguration.cpp:639
QList< QSslCertificate > caCertificates() const
Returns the a list of trusted CA certificates.
Definition QXmppConfiguration.cpp:720
QString user() const
Returns the localpart of the JID.
Definition QXmppConfiguration.cpp:280
void addDisabledSaslMechanism(const QString &)
Definition QXmppConfiguration.cpp:601
void setKeepAliveInterval(int secs)
Definition QXmppConfiguration.cpp:674
void setDomain(const QString &)
Definition QXmppConfiguration.cpp:158
StreamSecurityMode
Definition QXmppConfiguration.h:42
@ TLSDisabled
No encryption even if the server offers it.
Definition QXmppConfiguration.h:44
@ TLSRequired
Definition QXmppConfiguration.h:45
@ TLSEnabled
Encryption is used if available (default).
Definition QXmppConfiguration.h:43
@ LegacySSL
Definition QXmppConfiguration.h:49
int keepAliveInterval() const
Definition QXmppConfiguration.cpp:684
QXmppConfiguration & operator=(const QXmppConfiguration &other)
Assigns other to this QXmppConfiguration.
QString facebookAccessToken() const
Returns the access token used for X-FACEBOOK-PLATFORM authentication.
Definition QXmppConfiguration.cpp:348
void setUseFastTokenAuthentication(bool)
Definition QXmppConfiguration.cpp:494
void setFacebookAppId(const QString &)
Sets the application ID used for X-FACEBOOK-PLATFORM authentication.
Definition QXmppConfiguration.cpp:371
QString facebookAppId() const
Returns the application ID used for X-FACEBOOK-PLATFORM authentication.
Definition QXmppConfiguration.cpp:365
void setUser(const QString &)
Definition QXmppConfiguration.cpp:181
QString jidBare() const
Definition QXmppConfiguration.cpp:318
void setResourcePrefix(const QString &)
Definition QXmppConfiguration.cpp:228
void setHost(const QString &)
Definition QXmppConfiguration.cpp:146
bool useFastTokenAuthentication() const
Definition QXmppConfiguration.cpp:481
void setCredentials(const QXmppCredentials &)
Definition QXmppConfiguration.cpp:342
void setNonSASLAuthMechanism(QXmppConfiguration::NonSASLAuthMechanism)
Hints the library the Non-SASL authentication mechanism to be used for authentication.
Definition QXmppConfiguration.cpp:559
bool useNonSASLAuthentication() const
Returns whether to make use of non-SASL authentication.
Definition QXmppConfiguration.cpp:526
void setUseNonSASLAuthentication(bool)
Sets whether to make use of non-SASL authentication.
Definition QXmppConfiguration.cpp:532
void setPassword(const QString &)
Definition QXmppConfiguration.cpp:191
void setAutoAcceptSubscriptions(bool)
Definition QXmppConfiguration.cpp:427
int port() const
Returns the port number.
Definition QXmppConfiguration.cpp:261
QList< QString > disabledSaslMechanisms() const
Definition QXmppConfiguration.cpp:589
void setCaCertificates(const QList< QSslCertificate > &)
Specifies a list of trusted CA certificates.
Definition QXmppConfiguration.cpp:714
QString resource() const
Returns the resource identifier.
Definition QXmppConfiguration.cpp:292
std::optional< QXmppSasl2UserAgent > sasl2UserAgent() const
Definition QXmppConfiguration.cpp:627
QXmppConfiguration(const QXmppConfiguration &other)
Creates a copy of other.
void setKeepAliveTimeout(int secs)
Definition QXmppConfiguration.cpp:698
QXmppConfiguration()
Creates a QXmppConfiguration object.
Definition QXmppConfiguration.cpp:126
NonSASLAuthMechanism
Definition QXmppConfiguration.h:55
@ NonSASLPlain
Plain.
Definition QXmppConfiguration.h:56
@ NonSASLDigest
Digest (default)
Definition QXmppConfiguration.h:57
QString googleAccessToken() const
Returns the access token used for X-OAUTH2 authentication.
Definition QXmppConfiguration.cpp:377
void setUseSasl2Authentication(bool)
Definition QXmppConfiguration.cpp:468
QString password() const
Returns the password.
Definition QXmppConfiguration.cpp:286
QXmppCredentials credentials() const
Definition QXmppConfiguration.cpp:332
void setGoogleAccessToken(const QString &accessToken)
Definition QXmppConfiguration.cpp:388
void setAutoReconnectionEnabled(bool)
Definition QXmppConfiguration.cpp:449
void setFacebookAccessToken(const QString &)
Definition QXmppConfiguration.cpp:359
void setIgnoreSslErrors(bool)
Definition QXmppConfiguration.cpp:508
void setPort(int)
Definition QXmppConfiguration.cpp:169
QString jid() const
Definition QXmppConfiguration.cpp:303
bool ignoreSslErrors() const
Definition QXmppConfiguration.cpp:501
Stores different kinds of credentials used for authentication.
Definition QXmppCredentials.h:19