Class EventGuest

  • EventGuest represents an event guest and provides methods to access their information.

  • You can retrieve guest details such as the number of additional guests, email address, status, and name using the provided methods.

  • All methods require authorization with specific scopes like https://www.googleapis.com/auth/calendar or https://www.google.com/calendar/feeds.

  • The getStatus() method is deprecated and getGuestStatus() should be used instead to get the guest's status.

EventGuest

Represents a guest of an event.

Methods

MethodReturn typeBrief description
getAdditionalGuests()IntegerGets the number of additional people that this guest has said are attending.
getEmail()StringGets the email address of the guest.
getGuestStatus()GuestStatusGets the status of the guest for the event.
getName()StringGets the name of the guest.

Detailed documentation

getAdditionalGuests()

Gets the number of additional people that this guest has said are attending.

Return

Integer — the number of additional people this guest has said are attending

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEmail()

Gets the email address of the guest.

Return

String — the guest's email address

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestStatus()

Gets the status of the guest for the event.

Return

GuestStatus — the status of this guest

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getName()

Gets the name of the guest. If the name of the guest is not available, this method returns the guest's email address.

Return

String — the guest's name, or the guest's email address if the name is not available

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

Deprecated methods