ListEvents Method

Lists events.

Syntax

gcalendar.listEvents([callback])

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 this 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 method lists the events of the calendar. After calling this method EventCount will be populated with the number of events. Select an event by setting EventIndex to a value from 0 to EventCount - 1. After setting EventIndex you may inspect other Event* properties.