OptionCompress Property
Preference to compress outgoing data.
Syntax
as2profilemgr.getOptionCompress([callback]) as2profilemgr.setOptionCompress( optionCompress, [callback])
Default Value
FALSE
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 getOptionCompress([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 setOptionCompress([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
OptionCompress is used to store your preference of compressing the data sent to your trading partner.
After invoking LoadProfile, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.
Data Type
Boolean