VersioningEnabled Property

Controls whether versioning is enabled for the currently selected bucket.

Syntax

 s3client.getVersioningEnabled([callback])
 s3client.setVersioningEnabled( versioningEnabled, [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 getVersioningEnabled([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 setVersioningEnabled([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 can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this property will always return false when queried, and any attempts to set it will fail. This behavior also occurs if the currently-selected service provider does not support versioning at all.

Refer to Amazon's Versioning documentation for more information about versioning.

Note: When ServiceProvider is spBackblazeB2 (4), this property will always return true (assuming Bucket is non-empty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.

This property is not available at design time.

Data Type

Boolean