Class MqttEnhancedAuthenticationEventArgs

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttEnhancedAuthenticationEventArgs : EventArgs

Inheritance

object

EventArgs

MqttEnhancedAuthenticationEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MqttEnhancedAuthenticationEventArgs(byte[], string, MqttAuthenticateReasonCode, string, List<MqttUserProperty>)

public MqttEnhancedAuthenticationEventArgs(byte[] authenticationData, string authenticationMethod, MqttAuthenticateReasonCode reasonCode, string reasonString, List<MqttUserProperty> userProperties)

Parameters

authenticationData byte[]

authenticationMethod string

reasonCode MqttAuthenticateReasonCode

reasonString string

userProperties List<MqttUserProperty>

Properties

AuthenticationData

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

public byte[] AuthenticationData { get; set; }

Property Value

byte[]

AuthenticationMethod

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

public string AuthenticationMethod { get; set; }

Property Value

string

ReasonCode

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

public MqttAuthenticateReasonCode ReasonCode { get; set; }

Property Value

MqttAuthenticateReasonCode

ReasonString

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

public string ReasonString { get; set; }

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; set; }

Property Value

List<MqttUserProperty>