CalendarSummary Property

Contains a summary of the calendar that is used to describe its purpose.

Syntax

 gcalendar.getCalendarSummary([callback])
 gcalendar.setCalendarSummary( calendarSummary, [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 getCalendarSummary([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 setCalendarSummary([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 get the summary of the calendar and is populated when EventIndex is set. It is required to be set before calling CreateCalendar.

This property is not available at design time.

Data Type

String