EventAttendeeOptional Property

Whether or not the attendee is optional.

Syntax

 gcalendar.getEventAttendeeOptional(index, [callback])
 gcalendar.setEventAttendeeOptional(index,  eventAttendeeOptional, [callback])

Default Value

FALSE

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 getEventAttendeeOptional([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 setEventAttendeeOptional([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

Whether or not the attendee is optional.

This property indicates whether or not the attendee is optional. This may optionally be set when adding or updating an attendee. The default is False.

The size of the array is controlled by the EventAttendeeCount property.

This property is not available at design time.

Data Type

Boolean