CalendarOperationScope Property
The scope of the calendar operations.
Syntax
gcalendar.getCalendarOperationScope([callback]) gcalendar.setCalendarOperationScope( calendarOperationScope, [callback])
Possible Values
0 (gcosCalendars), 1 (gcosCalendarList)
Default Value
0
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 getCalendarOperationScope([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 setCalendarOperationScope([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 defines the scope of the operations that will be performed. The scope is either a single calendar, or the list of calendars. The default value is gcosCalendars (0).
When this property is set to gcosCalendars (1) the operations are performed directly on calendar objects. For instance DeleteCalendar will delete the specified calendar. The following methods are applicable to the gcosCalendars scope:
When this property is set to gcosCalendarList (0) the operations are performed on the display list of calendars for the account. This list is visible when logging into your account via a web browser. For instance when calling DeleteCalendar with this property is set to gcosCalendarList the calendar is removed from the display list, but the calendar itself is not deleted. The following methods are applicable to the gcosCalendarList scope:
This property is not available at design time.
Data Type
Integer