Skip to main content

gcal.attendee

Home > @runlightyear/gcal > Attendee

Attendee interface

Signature:
interface Attendee 

Required Properties

PropertyModifiersTypeDescription
additionalGuestsnumber

Number of additional guests.

The default is 0.

commentstringThe attendee's response comment.
displayNamestringThe attendee's name, if available.
emailstring

The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.

Required when adding an attendee.

resourceboolean

Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored.

The default is False.

responseStatus"needsAction" | "declined" | "tentative" | "accepted"The attendee's response status.

Optional Properties

PropertyModifiersTypeDescription
optional?boolean

Whether this is an optional attendee.

The default is False.