Class MqttClientSubscribeOptionsBuilder

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public sealed class MqttClientSubscribeOptionsBuilder

Inheritance

object

MqttClientSubscribeOptionsBuilder

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttClientSubscribeOptionsBuilder()

public MqttClientSubscribeOptionsBuilder()

Methods

Build()

public MqttClientSubscribeOptions Build()

Returns

MqttClientSubscribeOptions

WithSubscriptionIdentifier(uint)

public MqttClientSubscribeOptionsBuilder WithSubscriptionIdentifier(uint subscriptionIdentifier)

Parameters

subscriptionIdentifier uint

Returns

MqttClientSubscribeOptionsBuilder

WithTopicFilter(MqttTopicFilterBuilder)

public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilterBuilder topicFilterBuilder)

Parameters

topicFilterBuilder MqttTopicFilterBuilder

Returns

MqttClientSubscribeOptionsBuilder

WithTopicFilter(MqttTopicFilter)

public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilter topicFilter)

Parameters

topicFilter MqttTopicFilter

Returns

MqttClientSubscribeOptionsBuilder

WithTopicFilter(Action<MqttTopicFilterBuilder>)

public MqttClientSubscribeOptionsBuilder WithTopicFilter(Action<MqttTopicFilterBuilder> topicFilterBuilder)

Parameters

topicFilterBuilder Action<MqttTopicFilterBuilder>

Returns

MqttClientSubscribeOptionsBuilder

WithTopicFilter(string, MqttQualityOfServiceLevel, bool, bool, MqttRetainHandling)

public MqttClientSubscribeOptionsBuilder WithTopicFilter(string topic, MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, bool noLocal = false, bool retainAsPublished = false, MqttRetainHandling retainHandling = MqttRetainHandling.SendAtSubscribe)

Parameters

topic string

qualityOfServiceLevel MqttQualityOfServiceLevel

noLocal bool

retainAsPublished bool

retainHandling MqttRetainHandling

Returns

MqttClientSubscribeOptionsBuilder

WithUserProperty(string, string)

Adds the user property to the subscribe options. MQTT 5.0.0+ feature.

public MqttClientSubscribeOptionsBuilder WithUserProperty(string name, string value)

Parameters

name string

value string

Returns

MqttClientSubscribeOptionsBuilder