SearchSettleFlag Property
Indicates whether you wish to retrieve settled transactions or unsettled transactions.
Syntax
globaltransactionsearch.getSearchSettleFlag([callback]) globaltransactionsearch.setSearchSettleFlag( searchSettleFlag, [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 getSearchSettleFlag([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 setSearchSettleFlag([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 you wish to retrieve settled transactions or unsettled transactions. If set to true, only transactions that have been settled will be returned. If set to false (default), only transactions that have not been settled will be returned.
Data Type
Boolean