IPWorks S3 2020 Node.js Edition

Questions / Feedback?

UseSSL Property

Whether to use SSL/TLS when connecting.

Syntax

 s3client.getUseSSL([callback])
 s3client.setUseSSL( useSSL, [callback])

Default Value

TRUE

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 getUseSSL([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 setUseSSL([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 whether the class should use SSL/TLS when connecting.

Note: This property is automatically reset to true anytime ServiceProvider changes. The class will ignore any attempts to change this property while one of the following providers is selected, since they require SSL/TLS to be used:

  • spDigitalOcean (1)
  • spBackblazeB2 (4)
  • spOracle (8)

This property is not available at design time.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]