Interface UnsubscribePacket

Data model of an MQTT5 UNSUBSCRIBE packet.

Hierarchy

Properties

topicFilters type? userProperties?

Properties

topicFilters

topicFilters: string[]

List of topic filters that the client wishes to unsubscribe from.

See MQTT5 Unsubscribe Payload

Optional type

type?: PacketType

Always set on packets coming from the client to the user. Ignored if set on packets that come from the user to the client.

The primary use is to allow users to distinguish between packets in polymorphic situations (for example, the result of a publish attempt which might be a Puback (QoS 1) or Pubcomp (QoS 2, when we support it).

Optional userProperties

userProperties?: UserProperty[]

Set of MQTT5 user properties included with the packet.

See MQTT5 User Property

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc