EventMarker Property

A marker when events are paged.

Syntax

 gcalendar.getEventMarker([callback])
 gcalendar.setEventMarker( eventMarker, [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 getEventMarker([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 setEventMarker([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 returns a marker used to iterate over pages of events. When ListEvents is called if the results are paged this property will be populated. Continue to call ListEvents until this property returns empty string in order to list all events.

This property is not available at design time.

Data Type

String