ListCalendars Method

Lists all calendars.

Syntax

gcalendar.listCalendars([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 all calendars for the account. After calling this method CalendarCount will be populated with the number of calendars. Select a calendar by setting CalendarIndex to a value from 0 to CalendarCount - 1. After setting CalendarIndex you may inspect other Calendar* properties such as CalendarSummary, CalendarDescription, etc.