PySide6.QtMqtt.QMqttAuthenticationProperties¶

class QMqttAuthenticationProperties¶

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

Synopsis¶

Methods¶

def __init__()
def authenticationData()
def authenticationMethod()
def reason()
def setAuthenticationData()
def setAuthenticationMethod()
def setReason()
def setUserProperties()
def userProperties()

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.

__init__()¶

__init__(arg__1)

Parameters:: arg__1 – QMqttAuthenticationProperties

authenticationData()¶

Return type:: QByteArray

Returns the authentication data

See also

setAuthenticationData()

authenticationMethod()¶

Return type:: str

Returns the authentication method.

See also

setAuthenticationMethod()

reason()¶

Return type:: str

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

See also

setReason()

setAuthenticationData(adata)¶

Parameters:: adata – QByteArray

Sets the authentication data to adata.

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

See also

authenticationData() authenticationMethod()

setAuthenticationMethod(method)¶

Parameters:: method – str

Sets the authentication method to method.

See also

authenticationMethod()

setReason(r)¶

Parameters:: r – str

Sets the reason string to r.

See also

reason()

setUserProperties(user)¶

Parameters:: user – QMqttUserProperties

Sets the user properties to user.

See also

userProperties()

userProperties()¶

Return type:: QMqttUserProperties

Returns the user properties.

See also

setUserProperties()