ContentDisposition Property

Content disposition for the object.

Syntax

 amazons3.getContentDisposition([callback])
 amazons3.setContentDisposition( contentDisposition, [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 getContentDisposition([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 setContentDisposition([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 is used by the CreateObject method. Use it to set the HTTP "Content-Disposition" header that can be used to describe presentation of the object.

This property is not available at design time.

Data Type

String