TransferredDataLimit Property

The maximum of bytes of data to be transferred.

Syntax

 rest.getTransferredDataLimit([callback])
 rest.setTransferredDataLimit( transferredDataLimit, [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 getTransferredDataLimit([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 setTransferredDataLimit([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 defines the maximum of bytes of data to be transferred. The default value is 0, which means there is no limit to the amount of data the class will accumulate and parse. If this value is set to a number n which is greater than 0, the class will only receive the first n bytes of data from the server.

Data Type

Long64