Class MqttExtendedAuthenticationExchangeContext

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttExtendedAuthenticationExchangeContext

Inheritance

object

MqttExtendedAuthenticationExchangeContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MqttExtendedAuthenticationExchangeContext(MqttAuthenticateReasonCode)

public MqttExtendedAuthenticationExchangeContext(MqttAuthenticateReasonCode reasonCode)

Parameters

reasonCode MqttAuthenticateReasonCode

Properties

AuthenticationData

Gets the authentication data. Hint: MQTT 5 feature only.

public byte[]? AuthenticationData { get; init; }

Property Value

byte[]

AuthenticationMethod

Gets the authentication method. Hint: MQTT 5 feature only.

public string? AuthenticationMethod { get; init; }

Property Value

string

ReasonCode

Gets the reason code. Hint: MQTT 5 feature only.

public MqttAuthenticateReasonCode ReasonCode { get; init; }

Property Value

MqttAuthenticateReasonCode

ReasonString

Gets the reason string. Hint: MQTT 5 feature only.

public string? ReasonString { get; init; }

Property Value

string

UserProperties

Gets the user properties. In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet. As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber. The feature is very similar to the HTTP header concept. Hint: MQTT 5 feature only.

public List<MqttUserProperty> UserProperties { get; init; }

Property Value

List<MqttUserProperty>