EventAttendeeAdditionalGuests Property

Number of additional guests.

Syntax

 gcalendar.getEventAttendeeAdditionalGuests(index, [callback])
 gcalendar.setEventAttendeeAdditionalGuests(index,  eventAttendeeAdditionalGuests, [callback])

Default Value

0

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 getEventAttendeeAdditionalGuests([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 setEventAttendeeAdditionalGuests([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

Number of additional guests.

This property specifies the number of additional guests attending the event along with the attendee. This may optionally be set when adding or updating an attendee. The default is 0.

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

This property is not available at design time.

Data Type

Integer