ItemMarker Property

The marker of the last item from the previous listing.

Syntax

 splist.getItemMarker([callback])
 splist.setItemMarker( itemMarker, [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 getItemMarker([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 setItemMarker([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 will be populated when ListItems is called and the results are paged. It holds a marker that is used in the next call to ListItems to get the next page of results. After getting the last page of results this property will be empty. To get all the results continue to call ListItems until this property is empty.

Data Type

String