Settings

class gcsa.settings.Settings(*, auto_add_hangouts=False, date_field_order='MDY', default_event_length=60, format24_hour_time=False, hide_invitations=False, hide_weekends=False, locale='en', remind_on_responded_events_only=False, show_declined_events=True, timezone='Etc/GMT', use_keyboard_shortcuts=True, week_start=0)

Represents settings that users can change from the Calendar UI, such as the user’s time zone. They can be retrieved via get_settings().

Parameters:

  • auto_add_hangouts (bool) – Whether to automatically add Hangouts to all events.

  • date_field_order (str) – What should the order of day (D), month (M) and year (Y) be when displaying dates.

  • default_event_length (int) – The default length of events (in minutes) that were created without an explicit duration.

  • format24_hour_time (bool) – Whether to show the time in 24-hour format.

  • hide_invitations (bool) – Whether to hide events to which the user is invited but hasn’t acted on (for example by responding).

  • hide_weekends (bool) – Whether the weekends should be hidden when displaying a week.

  • locale (str) – User’s locale.

  • remind_on_responded_events_only (bool) – Whether event reminders should be sent only for events with the user’s response status “Yes” and “Maybe”.

  • show_declined_events (bool) – Whether events to which the user responded “No” should be shown on the user’s calendar.

  • timezone (str) – The ID of the user’s timezone.

  • use_keyboard_shortcuts (bool) – Whether the keyboard shortcuts are enabled.

  • week_start (int) – Whether the week should start on Sunday (0), Monday (1) or Saturday (6).