EventStartDate Property

The date of the all-day event.

Syntax

 gcalendar.getEventStartDate([callback])
 gcalendar.setEventStartDate( eventStartDate, [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 getEventStartDate([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 setEventStartDate([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

The date of the all-day event.

This property specifies the date of the all-day event. This is only used for all-day events. The format is "yyyy-mm-dd".

The start date of the event. This must be set when creating an event, and may be set when updating an event.

This property is not available at design time.

Data Type

String