Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MqttMessage

Hierarchy

  • MqttMessage

Index

Constructors

constructor

  • new MqttMessage(topic: string, payload: Buffer): MqttMessage
  • Parameters

    • topic: string
    • payload: Buffer

    Returns MqttMessage

Properties

from

from: string

The ID of the application that sent the message.

job

job: string

The name of the job that the message was about.

message

message: string

The description sent with a status message. May be absent.

payload

payload: string

The stirng received in the message payload.

sentTime

sentTime: Date

The sent time, if supported.

statistics

statistics: Map<string, any>

An optional collection of statistics.

status

status: string

The reported status fo the job. Will only be set if {@link MqttMessage#type} is {@link MessageType#Status}.

timeStamp

timeStamp: Date

The received time in UTC.

topic

topic: string

The full MQTT topic.

type

The type of message received.

validation

validation: IJobValidation

Validation details.