Class MqttClientSubscribeResult

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttClientSubscribeResult

Inheritance

object

MqttClientSubscribeResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MqttClientSubscribeResult(ushort, IReadOnlyCollection<MqttClientSubscribeResultItem>, string, IReadOnlyCollection<MqttUserProperty>)

public MqttClientSubscribeResult(ushort packetIdentifier, IReadOnlyCollection<MqttClientSubscribeResultItem> items, string reasonString, IReadOnlyCollection<MqttUserProperty> userProperties)

Parameters

packetIdentifier ushort

items IReadOnlyCollection<MqttClientSubscribeResultItem>

reasonString string

userProperties IReadOnlyCollection<MqttUserProperty>

Properties

Items

Gets the result for every topic filter item.

public IReadOnlyCollection<MqttClientSubscribeResultItem> Items { get; }

Property Value

IReadOnlyCollection<MqttClientSubscribeResultItem>

PacketIdentifier

Gets the packet identifier which was used.

public ushort PacketIdentifier { get; }

Property Value

ushort

ReasonString

Gets the reason string. MQTT 5.0.0+ feature.

public string ReasonString { get; }

Property Value

string

UserProperties

Gets the user properties which were part of the SUBACK packet. MQTT 5.0.0+ feature.

public IReadOnlyCollection<MqttUserProperty> UserProperties { get; }

Property Value

IReadOnlyCollection<MqttUserProperty>

Methods

IsSubAckSuccessful(MqttQualityOfServiceLevel)

public bool IsSubAckSuccessful(MqttQualityOfServiceLevel requestedQos)

Parameters

requestedQos MqttQualityOfServiceLevel

Returns

bool

ThrowIfNotSuccessSubAck(MqttQualityOfServiceLevel, string?)

public void ThrowIfNotSuccessSubAck(MqttQualityOfServiceLevel requestedQos, string? commandName = null)

Parameters

requestedQos MqttQualityOfServiceLevel

commandName string