Class MqttClientUnsubscribeOptions

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttClientUnsubscribeOptions

Inheritance

object

MqttClientUnsubscribeOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MqttClientUnsubscribeOptions()

public MqttClientUnsubscribeOptions()

MqttClientUnsubscribeOptions(MqttTopicFilter)

public MqttClientUnsubscribeOptions(MqttTopicFilter mqttTopicFilter)

Parameters

mqttTopicFilter MqttTopicFilter

MqttClientUnsubscribeOptions(string)

public MqttClientUnsubscribeOptions(string topic)

Parameters

topic string

Properties

TopicFilters

Gets or sets a list of topic filters the client wants to unsubscribe from. Topic filters can include regular topics or wild cards.

public List<string> TopicFilters { get; set; }

Property Value

List<string>

UserProperties

Gets or sets 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. MQTT 5.0.0+ feature.

public List<MqttUserProperty>? UserProperties { get; set; }

Property Value

List<MqttUserProperty>

Methods

AddUserProperty(string, string)

public void AddUserProperty(string key, string value)

Parameters

key string

value string