Mqtt5UnsubAck (hivemq-mqtt-client 1.3.14 API)

All Superinterfaces:: Mqtt5Message

@DoNotImplement public interface Mqtt5UnsubAck extends Mqtt5Message

MQTT 5 UnsubAck message. This message is translated from and to an MQTT 5 UNSUBACK packet.

Since:: 1.0

Method Summary

Modifier and Type

Method

Description

@Immutable @NotNull List<@NotNull Mqtt5UnsubAckReasonCode>

getReasonCodes()

@NotNull Optional<MqttUtf8String>

getReasonString()

default @NotNull Mqtt5MessageType

getType()

@NotNull Mqtt5UserProperties

getUserProperties()

Method Details
- getReasonCodes
  
  @NotNull @Immutable @NotNull List<@NotNull Mqtt5UnsubAckReasonCode> getReasonCodes()
  
  Returns:
  
  the Reason Codes of this UnsubAck message, each belonging to a Topic Filter in the corresponding Unsubscribe message in the same order.
- getReasonString
  
  @NotNull @NotNull Optional<MqttUtf8String> getReasonString()
  
  Returns:
  
  the optional reason string of this UnsubAck message.
- getUserProperties
  
  @NotNull @NotNull Mqtt5UserProperties getUserProperties()
  
  Returns:
  
  the optional user properties of this UnsubAck message.
- getType
  
  @NotNull default @NotNull Mqtt5MessageType getType()
  
  Specified by:
  
  getType in interface Mqtt5Message
  
  Returns:
  
  the type of this MQTT message.