ObjectPrefix Property

A prefix for the object(s).

Syntax

 amazons3.getObjectPrefix([callback])
 amazons3.setObjectPrefix( objectPrefix, [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 getObjectPrefix([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 setObjectPrefix([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 to filter the object list. This can be set to a prefix for the objects to be returned within the specified Bucket.

This is provided by Amazon to group objects by name together similar to the use of subfolders on a file system.

Data Type

String