EventSummary Property
The summary of the event.
Syntax
gcalendar.getEventSummary([callback]) gcalendar.setEventSummary( eventSummary, [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 getEventSummary([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 setEventSummary([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 specifies the summary of the event. It must be set when creating and event and may be set when updating an event.
This property is not available at design time.
Data Type
String