QMqttAuthenticationProperties#

The QMqttAuthenticationProperties class represents configuration options during the authentication process. More

Synopsis#

Functions#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Note

Authentication properties are part of the MQTT 5.0 specification and cannot be used when connecting with a lower protocol level. See ProtocolVersion for more information.

class PySide6.QtMqtt.QMqttAuthenticationProperties#

PySide6.QtMqtt.QMqttAuthenticationProperties(arg__1)

Parameters:

arg__1PySide6.QtMqtt.QMqttAuthenticationProperties

PySide6.QtMqtt.QMqttAuthenticationProperties.authenticationData()#
Return type:

PySide6.QtCore.QByteArray

Returns the authentication data

PySide6.QtMqtt.QMqttAuthenticationProperties.authenticationMethod()#
Return type:

str

Returns the authentication method.

PySide6.QtMqtt.QMqttAuthenticationProperties.reason()#
Return type:

str

Returns the reason string. The reason string specifies the reason for a disconnect.

See also

setReason()

PySide6.QtMqtt.QMqttAuthenticationProperties.setAuthenticationData(adata)#
Parameters:

adataPySide6.QtCore.QByteArray

Sets the authentication data to adata.

Authentication data can only be used if an authentication method has been specified.

PySide6.QtMqtt.QMqttAuthenticationProperties.setAuthenticationMethod(method)#
Parameters:

method – str

Sets the authentication method to method.

PySide6.QtMqtt.QMqttAuthenticationProperties.setReason(r)#
Parameters:

r – str

Sets the reason string to r.

See also

reason()

PySide6.QtMqtt.QMqttAuthenticationProperties.setUserProperties(user)#
Parameters:

userQMqttUserProperties

Sets the user properties to user.

See also

userProperties()

PySide6.QtMqtt.QMqttAuthenticationProperties.userProperties()#
Return type:

QMqttUserProperties

Returns the user properties.