Share via

MqttConnectEventResponseProperties.UserProperties Property

  • Reference

Definition

Namespace:
Microsoft.Azure.WebPubSub.Common
Assembly:
Microsoft.Azure.WebPubSub.Common.dll
Package:
Microsoft.Azure.WebPubSub.Common v1.4.0
Source:
MqttConnectEventResponseProperties.cs

It's additional diagnostic or other information provided by upstream server. They'll be converted to the user properties field in the CONNACK packet, and sent to clients whose protocols support user properties. Now only MQTT 5.0 supports user properties. Upstream webhook can use the property to communicate additional diagnostic or other information with clients.

[System.Runtime.Serialization.DataMember(Name="userProperties")]
[System.Text.Json.Serialization.JsonPropertyName("userProperties")]
public System.Collections.Generic.IReadOnlyList<Microsoft.Azure.WebPubSub.Common.MqttUserProperty>? UserProperties { get; set; }
[<System.Runtime.Serialization.DataMember(Name="userProperties")>]
[<System.Text.Json.Serialization.JsonPropertyName("userProperties")>]
member this.UserProperties : System.Collections.Generic.IReadOnlyList<Microsoft.Azure.WebPubSub.Common.MqttUserProperty> with get, set
Public Property UserProperties As IReadOnlyList(Of MqttUserProperty)

Property Value

IReadOnlyList<MqttUserProperty>
Attributes
DataMemberAttribute JsonPropertyNameAttribute

Applies to