ObjectComplianceConditionalHold Property

Specifies whether an object is under conditional hold.

Syntax

 wasabi.getObjectComplianceConditionalHold([callback])
 wasabi.setObjectComplianceConditionalHold( objectComplianceConditionalHold, [callback])

Default Value

""

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 getObjectComplianceConditionalHold([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 setObjectComplianceConditionalHold([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

Specifies whether an object is under conditional hold.

An object under conditional hold cannot be deleted, but can be removed from conditional hold by setting this to "false" and calling UpdateCompliance for that object. Once an object is released from conditional hold, its retention period begins, and it cannot be deleted until its retention time has passed. An object cannot be restored to conditional hold.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String