QXmpp Version: 1.15.0
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 QString locale() const;
154 void setLocale(const QString &);
155
156 QList<QSslCertificate> caCertificates() const;
157 void setCaCertificates(const QList<QSslCertificate> &);
158
160 const QXmpp::Private::Credentials &credentialData() const;
161 QXmpp::Private::Credentials &credentialData();
163
164private:
165 QSharedDataPointer<QXmppConfigurationPrivate> d;
166};
167
168#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:250
bool autoAcceptSubscriptions() const
Definition QXmppConfiguration.cpp:417
void setDisabledSaslMechanisms(const QList< QString > &)
Definition QXmppConfiguration.cpp:616
void setResource(const QString &)
Definition QXmppConfiguration.cpp:209
QString domain() const
Returns the domain part of the JID.
Definition QXmppConfiguration.cpp:256
bool useSASLAuthentication() const
Returns whether to make use of SASL authentication.
Definition QXmppConfiguration.cpp:515
QString saslAuthMechanism() const
Returns the preferred SASL authentication mechanism.
Definition QXmppConfiguration.cpp:567
QNetworkProxy networkProxy() const
Definition QXmppConfiguration.cpp:702
void setJid(const QString &jid)
Definition QXmppConfiguration.cpp:239
void setWindowsLiveAccessToken(const QString &accessToken)
Definition QXmppConfiguration.cpp:406
void setStreamSecurityMode(QXmppConfiguration::StreamSecurityMode mode)
Definition QXmppConfiguration.cpp:547
QXmppConfiguration::StreamSecurityMode streamSecurityMode() const
Definition QXmppConfiguration.cpp:540
QString resourcePrefix() const
Definition QXmppConfiguration.cpp:219
quint16 port16() const
Definition QXmppConfiguration.cpp:272
bool autoReconnectionEnabled() const
Definition QXmppConfiguration.cpp:439
QXmppConfiguration::NonSASLAuthMechanism nonSASLAuthMechanism() const
Returns the Non-SASL authentication mechanism configuration.
Definition QXmppConfiguration.cpp:554
void setSaslAuthMechanism(const QString &mechanism)
Definition QXmppConfiguration.cpp:578
bool useSasl2Authentication() const
Definition QXmppConfiguration.cpp:459
QString windowsLiveAccessToken() const
Returns the access token used for X-MESSENGER-OAUTH2 authentication.
Definition QXmppConfiguration.cpp:395
void setUseSASLAuthentication(bool)
Sets whether to make use of SASL authentication.
Definition QXmppConfiguration.cpp:521
int keepAliveTimeout() const
Definition QXmppConfiguration.cpp:749
void setNetworkProxy(const QNetworkProxy &proxy)
Definition QXmppConfiguration.cpp:691
void setSasl2UserAgent(const std::optional< QXmppSasl2UserAgent > &)
Definition QXmppConfiguration.cpp:640
QList< QSslCertificate > caCertificates() const
Returns the a list of trusted CA certificates.
Definition QXmppConfiguration.cpp:761
QString user() const
Returns the localpart of the JID.
Definition QXmppConfiguration.cpp:281
void addDisabledSaslMechanism(const QString &)
Definition QXmppConfiguration.cpp:602
void setKeepAliveInterval(int secs)
Definition QXmppConfiguration.cpp:715
void setDomain(const QString &)
Definition QXmppConfiguration.cpp:159
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:725
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:349
void setUseFastTokenAuthentication(bool)
Definition QXmppConfiguration.cpp:495
void setFacebookAppId(const QString &)
Sets the application ID used for X-FACEBOOK-PLATFORM authentication.
Definition QXmppConfiguration.cpp:372
QString facebookAppId() const
Returns the application ID used for X-FACEBOOK-PLATFORM authentication.
Definition QXmppConfiguration.cpp:366
void setUser(const QString &)
Definition QXmppConfiguration.cpp:182
QString jidBare() const
Definition QXmppConfiguration.cpp:319
void setResourcePrefix(const QString &)
Definition QXmppConfiguration.cpp:229
void setHost(const QString &)
Definition QXmppConfiguration.cpp:147
bool useFastTokenAuthentication() const
Definition QXmppConfiguration.cpp:482
void setCredentials(const QXmppCredentials &)
Definition QXmppConfiguration.cpp:343
void setNonSASLAuthMechanism(QXmppConfiguration::NonSASLAuthMechanism)
Hints the library the Non-SASL authentication mechanism to be used for authentication.
Definition QXmppConfiguration.cpp:560
bool useNonSASLAuthentication() const
Returns whether to make use of non-SASL authentication.
Definition QXmppConfiguration.cpp:527
void setUseNonSASLAuthentication(bool)
Sets whether to make use of non-SASL authentication.
Definition QXmppConfiguration.cpp:533
void setPassword(const QString &)
Definition QXmppConfiguration.cpp:192
void setAutoAcceptSubscriptions(bool)
Definition QXmppConfiguration.cpp:428
int port() const
Returns the port number.
Definition QXmppConfiguration.cpp:262
QList< QString > disabledSaslMechanisms() const
Definition QXmppConfiguration.cpp:590
void setCaCertificates(const QList< QSslCertificate > &)
Specifies a list of trusted CA certificates.
Definition QXmppConfiguration.cpp:755
QString resource() const
Returns the resource identifier.
Definition QXmppConfiguration.cpp:293
void setLocale(const QString &)
Definition QXmppConfiguration.cpp:680
std::optional< QXmppSasl2UserAgent > sasl2UserAgent() const
Definition QXmppConfiguration.cpp:628
QXmppConfiguration(const QXmppConfiguration &other)
Creates a copy of other.
void setKeepAliveTimeout(int secs)
Definition QXmppConfiguration.cpp:739
QXmppConfiguration()
Creates a QXmppConfiguration object.
Definition QXmppConfiguration.cpp:127
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:378
void setUseSasl2Authentication(bool)
Definition QXmppConfiguration.cpp:469
QString locale() const
Definition QXmppConfiguration.cpp:656
QString password() const
Returns the password.
Definition QXmppConfiguration.cpp:287
QXmppCredentials credentials() const
Definition QXmppConfiguration.cpp:333
void setGoogleAccessToken(const QString &accessToken)
Definition QXmppConfiguration.cpp:389
void setAutoReconnectionEnabled(bool)
Definition QXmppConfiguration.cpp:450
void setFacebookAccessToken(const QString &)
Definition QXmppConfiguration.cpp:360
void setIgnoreSslErrors(bool)
Definition QXmppConfiguration.cpp:509
void setPort(int)
Definition QXmppConfiguration.cpp:170
QString jid() const
Definition QXmppConfiguration.cpp:304
bool ignoreSslErrors() const
Definition QXmppConfiguration.cpp:502
Stores different kinds of credentials used for authentication.
Definition QXmppCredentials.h:19