QXmppRegisterIq Class

The QXmppRegisterIq class represents a registration IQ as defined by XEP-0077: In-Band Registration. More...

Header: #include <QXmppRegisterIq.h>
Inherits: QXmppIq

Public Functions

QXmppRegisterIq(const QXmppRegisterIq &other)
QXmppRegisterIq(QXmppRegisterIq &&)
(since QXmpp 1.2) QXmppBitsOfBinaryDataList &bitsOfBinaryData()
(since QXmpp 1.2) QXmppBitsOfBinaryDataList bitsOfBinaryData() const
QString email() const
QXmppDataForm form() const
QString instructions() const
(since QXmpp 1.2) bool isRegistered() const
(since QXmpp 1.2) bool isRemove() const
(since QXmpp 1.5) QString outOfBandUrl() const
QString password() const
(since QXmpp 1.2) void setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsOfBinaryData)
void setEmail(const QString &email)
void setForm(const QXmppDataForm &form)
void setInstructions(const QString &instructions)
(since QXmpp 1.2) void setIsRegistered(bool isRegistered)
(since QXmpp 1.2) void setIsRemove(bool isRemove)
(since QXmpp 1.5) void setOutOfBandUrl(const QString &outOfBandUrl)
void setPassword(const QString &password)
void setUsername(const QString &username)
QString username() const
QXmppRegisterIq &operator=(QXmppRegisterIq &&)
QXmppRegisterIq &operator=(const QXmppRegisterIq &other)

Static Public Members

(since QXmpp 1.2) QXmppRegisterIq createChangePasswordRequest(const QString &username, const QString &newPassword, const QString &to = {})
(since QXmpp 1.2) QXmppRegisterIq createUnregistrationRequest(const QString &to = {})

Detailed Description

It is used to create an account on the server.

Member Function Documentation

QXmppRegisterIq::QXmppRegisterIq(const QXmppRegisterIq &other)

Default copy-constructor

QXmppRegisterIq::QXmppRegisterIq(QXmppRegisterIq &&)

Default move-constructor

[since QXmpp 1.2] QXmppBitsOfBinaryDataList &QXmppRegisterIq::bitsOfBinaryData()

Returns a list of data attached using XEP-0231: Bits of Binary.

This could be used to resolve a cid: URL of an CAPTCHA field of the form.

This function was introduced in QXmpp 1.2.

See also setBitsOfBinaryData().

[since QXmpp 1.2] QXmppBitsOfBinaryDataList QXmppRegisterIq::bitsOfBinaryData() const

Returns a list of data packages attached using XEP-0231: Bits of Binary.

This could be used to resolve a cid: URL of an CAPTCHA field of the form.

This function was introduced in QXmpp 1.2.

[static, since QXmpp 1.2] QXmppRegisterIq QXmppRegisterIq::createChangePasswordRequest(const QString &username, const QString &newPassword, const QString &to = {})

Constructs a regular change password request.

username is the username of the account of which the password should be changed. newPassword is the new password that should be set. to is the optional JID of the registration service. If this is omitted, the IQ is automatically addressed to the local server.

This function was introduced in QXmpp 1.2.

[static, since QXmpp 1.2] QXmppRegisterIq QXmppRegisterIq::createUnregistrationRequest(const QString &to = {})

Constructs a regular unregistration request.

to is the optional JID of the registration service. If this is omitted, the IQ is automatically addressed to the local server.

This function was introduced in QXmpp 1.2.

QString QXmppRegisterIq::email() const

Returns the email for this registration IQ.

See also setEmail().

QXmppDataForm QXmppRegisterIq::form() const

Returns the QXmppDataForm for this registration IQ.

See also setForm().

QString QXmppRegisterIq::instructions() const

Returns the instructions for this registration IQ.

See also setInstructions().

[since QXmpp 1.2] bool QXmppRegisterIq::isRegistered() const

Returns whether the account is registered.

By default this is set to false.

This function was introduced in QXmpp 1.2.

See also setIsRegistered().

[since QXmpp 1.2] bool QXmppRegisterIq::isRemove() const

Returns whether to remove (unregister) the account.

By default this is set to false.

This function was introduced in QXmpp 1.2.

See also setIsRemove().

[since QXmpp 1.5] QString QXmppRegisterIq::outOfBandUrl() const

Returns a XEP-0066: Out of Band Data URL used for out-of-band registration.

This function was introduced in QXmpp 1.5.

See also setOutOfBandUrl().

QString QXmppRegisterIq::password() const

Returns the password for this registration IQ.

See also setPassword().

[since QXmpp 1.2] void QXmppRegisterIq::setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsOfBinaryData)

Sets a list of XEP-0231: Bits of Binary attachments to be included.

bitsOfBinaryData.

This function was introduced in QXmpp 1.2.

See also bitsOfBinaryData().

void QXmppRegisterIq::setEmail(const QString &email)

Sets the email for this registration IQ.

See also email().

void QXmppRegisterIq::setForm(const QXmppDataForm &form)

Sets the QXmppDataForm for this registration IQ.

form.

See also form().

void QXmppRegisterIq::setInstructions(const QString &instructions)

Sets the instructions for this registration IQ.

See also instructions().

[since QXmpp 1.2] void QXmppRegisterIq::setIsRegistered(bool isRegistered)

Sets whether the account is registered.

By default this is set to false.

isRegistered.

This function was introduced in QXmpp 1.2.

See also isRegistered().

[since QXmpp 1.2] void QXmppRegisterIq::setIsRemove(bool isRemove)

Sets whether to remove (unregister) the account.

By default this is set to false.

isRemove.

This function was introduced in QXmpp 1.2.

See also isRemove().

[since QXmpp 1.5] void QXmppRegisterIq::setOutOfBandUrl(const QString &outOfBandUrl)

Sets a XEP-0066: Out of Band Data URL used for out-of-band registration.

outOfBandUrl.

This function was introduced in QXmpp 1.5.

See also outOfBandUrl().

void QXmppRegisterIq::setPassword(const QString &password)

Sets the password for this registration IQ.

See also password().

void QXmppRegisterIq::setUsername(const QString &username)

Sets the username for this registration IQ.

See also username().

QString QXmppRegisterIq::username() const

Returns the username for this registration IQ.

See also setUsername().

QXmppRegisterIq &QXmppRegisterIq::operator=(QXmppRegisterIq &&)

Default move-assignment operator

QXmppRegisterIq &QXmppRegisterIq::operator=(const QXmppRegisterIq &other)

Default assignment operator