ObjectMarker Property

A marker for the object(s).

Syntax

 amazons3.getObjectMarker([callback])
 amazons3.setObjectMarker( objectMarker, [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 getObjectMarker([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 setObjectMarker([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 marker allows you to iterate through the objects, only the objects that are lexically after the marker are listed. This property can be used in conjunction with MaxObjects for pagination.

The class will automatically reset the marker on each call to ListObjects and point it to the next marker or to an empty string if the list is complete.

Data Type

String