InputMessage Property
The message to process.
Syntax
hash.getInputMessage([callback]) hash.setInputMessage( inputMessage_Buffer, [callback])
Default Value
""
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 getInputMessage([callback]) method is defined as:
function(err, buffer){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'buffer' is the value returned by the method.
The callback for the setInputMessage([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
This property specifies the message to be processed.
Input Notes
The class will determine the source of the input based on which properties are set.
The order in which the input properties are checked are as follows:
- InputFile
- InputMessage
Data Type
Buffer