Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

AllowHTTPCompression Property

Enables HTTP compression for receiving data.

Syntax

 oauth.getAllowHTTPCompression([callback])
 oauth.setAllowHTTPCompression( allowHTTPCompression, [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 getAllowHTTPCompression([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 setAllowHTTPCompression([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 enables HTTP compression for receiving data. When set to true, the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

TransferredData will contain the decompressed data received by the server, but the Transfer event will report exactly what is received by the server (compressed data).

Data Type

Boolean

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0