IncomingMessagePayloadFormatIndicator Property
Indicates whether the payload is unspecified bytes or UTF-8 Encoded character data.
Syntax
mqtt.getIncomingMessagePayloadFormatIndicator(index, [callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getIncomingMessagePayloadFormatIndicator([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setIncomingMessagePayloadFormatIndicator([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Indicates whether the payload is unspecified bytes or UTF-8 Encoded character data. Possible values are:
Value | Description |
0 | Payload is unspecified bytes |
1 | Payload is UTF-8 Encoded Character Data |
Valid only for MQTT 5.
The index parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer