CalendarETag Property
The ETag of the current calendar.
Syntax
gcalendar.getCalendarETag([callback]) gcalendar.setCalendarETag( calendarETag, [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 getCalendarETag([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 setCalendarETag([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 is used to obtain the ETag of the specified calendar and will be populated once CalendarIndex is set.
This property is also used when querying, updating, or deleting calendars. When CalendarETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when ListCalendars is called. This allows you to perform conditional retrievals in the case that you only want to list a calendar if it has been modified (e.g. contains a different ETag value).
When UpdateCalendar or DeleteCalendar is called, an "If-Match" header will be sent with the entered value. If set to a calendar's ETag value, a check will be performed by the server to ensure that the document has not been changed (e.g. the ETag values are the same) before updating or deleting the calendar. If CalendarETag is set to "*", the document will be updated or deleting regardless of whether it has been changed.
This property is not available at design time.
Data Type
String