Class EventGuest
Stay organized with collections
Save and categorize content based on your preferences.
EventGuest
Represents a guest of an event.
Deprecated methods
| Method | Return type | Brief description |
getStatus() | String | Gets the status of the guest for the event. |
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
getStatus()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the status of the guest for the event.
Return
String — 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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eEventGuest\u003c/code\u003e represents an event guest and provides methods to access their information.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve guest details such as the number of additional guests, email address, status, and name using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eAll methods require authorization with specific scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/calendar\u003c/code\u003e or \u003ccode\u003ehttps://www.google.com/calendar/feeds\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetStatus()\u003c/code\u003e method is deprecated and \u003ccode\u003egetGuestStatus()\u003c/code\u003e should be used instead to get the guest's status.\u003c/p\u003e\n"]]],[],null,["# Class EventGuest\n\nEventGuest\n\nRepresents a guest of an event. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------------------|\n| [getAdditionalGuests()](#getAdditionalGuests()) | `Integer` | Gets the number of additional people that this guest has said are attending. |\n| [getEmail()](#getEmail()) | `String` | Gets the email address of the guest. |\n| [getGuestStatus()](#getGuestStatus()) | [GuestStatus](/apps-script/reference/calendar/guest-status) | Gets the status of the guest for the event. |\n| [getName()](#getName()) | `String` | Gets the name of the guest. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|-----------------------------|-------------|---------------------------------------------|\n| [getStatus()](#getStatus()) | `String` | Gets the status of the guest for the event. |\n\nDetailed documentation\n----------------------\n\n### `get``Additional``Guests()`\n\nGets the number of additional people that this guest has said are attending.\n\n#### Return\n\n\n`Integer` --- the number of additional people this guest has said are attending\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](/identity/protocols/googlescopes):\n\n- `https://www.googleapis.com/auth/calendar`\n- `https://www.googleapis.com/auth/calendar.readonly`\n- `https://www.google.com/calendar/feeds`\n\n*** ** * ** ***\n\n### `get``Email()`\n\nGets the email address of the guest.\n\n#### Return\n\n\n`String` --- the guest's email address\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](/identity/protocols/googlescopes):\n\n- `https://www.googleapis.com/auth/calendar`\n- `https://www.googleapis.com/auth/calendar.readonly`\n- `https://www.google.com/calendar/feeds`\n\n*** ** * ** ***\n\n### `get``Guest``Status()`\n\nGets the status of the guest for the event.\n\n#### Return\n\n\n[GuestStatus](/apps-script/reference/calendar/guest-status) --- the status of this guest\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](/identity/protocols/googlescopes):\n\n- `https://www.googleapis.com/auth/calendar`\n- `https://www.googleapis.com/auth/calendar.readonly`\n- `https://www.google.com/calendar/feeds`\n\n*** ** * ** ***\n\n### `get``Name()`\n\nGets the name of the guest. If the name of the guest is not available, this method returns the\nguest's email address.\n\n#### Return\n\n\n`String` --- the guest's name, or the guest's email address if the name is not available\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](/identity/protocols/googlescopes):\n\n- `https://www.googleapis.com/auth/calendar`\n- `https://www.googleapis.com/auth/calendar.readonly`\n- `https://www.google.com/calendar/feeds`\n\nDeprecated methods\n------------------\n\n### `get``Status()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGets the status of the guest for the event.\n\n#### Return\n\n\n`String` --- the status of this guest\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes) or appropriate scopes from the [related REST API](/identity/protocols/googlescopes):\n\n- `https://www.googleapis.com/auth/calendar`\n- `https://www.googleapis.com/auth/calendar.readonly`\n- `https://www.google.com/calendar/feeds`"]]
