google-calendar-simple-api/docs/source/attendees.rst

.. _attendees:

Attendees
=========

If you want to add attendee(s) to your event, just create :py:class:`~gcsa.attendee.Attendee` (s) and pass
as an ``attendees`` parameter (you can also pass just an email of the attendee and
the :py:class:`~gcsa.attendee.Attendee` will be created for you):

.. code-block:: python

    from gcsa.attendee import Attendee

    attendee = Attendee(
        '[email protected]',
        display_name='Friend',
        additional_guests=3
    )

    event = Event('Meeting',
                  start=(17/Jul/2020)[12:00],
                  attendees=attendee)

or

.. code-block:: python

    event = Event('Meeting',
                  start=(17/Jul/2020)[12:00],
                  attendees='[email protected]')

You can pass multiple attendees at once in a list.


.. code-block:: python

    event = Event('Meeting',
                  start=(17/Jul/2020)[12:00],
                  attendees=[
                      '[email protected]',
                      Attendee('[email protected]', display_name='Friend')
                  ])

To **notify** attendees about created/updated/deleted event use `send_updates` parameter in `add_event`, `update_event`,
and `delete_event` methods. See :py:class:`~gcsa.google_calendar.SendUpdatesMode` for possible values.

To add attendees to an existing event use its :py:meth:`~gcsa.event.Event.add_attendee` method:

.. code-block:: python

    event.add_attendee(
            Attendee('[email protected]',
                display_name='Friend',
                additional_guests=3
            )
    )

or

.. code-block:: python

    event.add_attendee('[email protected]')

to add a single attendee.

Use :py:meth:`~gcsa.event.Event.add_attendees` method to add multiple at once:

.. code-block:: python

    event.add_attendees(
        [
            Attendee('[email protected]',
                display_name='Friend',
                additional_guests=3
            ),
            '[email protected]',
            '[email protected]'
        ]
    )

Update event using :py:meth:`~gcsa.google_calendar.GoogleCalendar.update_event` method to save the changes.