ObjectDelimiter Property

A delimiter can be used to organize multiple objects.

Syntax

 amazons3.getObjectDelimiter([callback])
 amazons3.setObjectDelimiter( objectDelimiter, [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 getObjectDelimiter([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 setObjectDelimiter([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

Used by the ListObjects method. The object names that contain the same string between the ObjectPrefix and the first occurrence of the ObjectDelimiter will be rolled up into a single result element fired as PrefixList. These rolled-up object names are not returned by the ObjectList.

Data Type

String