CreateCalendar Method

Create a new calendar.

Syntax

gcalendar.createCalendar([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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method creates a new calendar. The CalendarOperationScope should be set to gcosCalendars before calling this method to create a new calendar. The Id of the newly created calendar is returned by this method. The following properties are applicable when creating a new calendar:

• CalendarSummary (required)
• CalendarDescription
• CalendarLocation
• CalendarTimezone

Note that it may be beneficial to set the CalendarIndex to -1 prior to setting the above properties and creating the calendar. This will ensure that no properties are set unintentionally when calling CreateCalendar.

After this method returns CalendarIndex is automatically set to 0 and the following properties will be populated:

• CalendarId
• CalendarETag
• CalendarSummary
• CalendarDescription
• CalendarLocation
• CalendarTimezone

By default the newly created calendar is automatically added to the display list of calendars. This list is shown when logging into your account via a web browser.

When CalendarOperationScope is set to gcosCalendarList and this method is called the calendar specified by CalendarId is added to the display list. The calendar must already exist, it will only be added to the display list.