Constants

Details

ECal.BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS = 'alarm-email-address'

An email address preferred for e-mail reminders by the calendar.

New in version 3.2.

ECal.BACKEND_PROPERTY_CAL_EMAIL_ADDRESS = 'cal-email-address'

An email address associated with the calendar.

New in version 3.2.

ECal.BACKEND_PROPERTY_DEFAULT_OBJECT = 'default-object'

A default object for the calendar. Calendars use VEVENT, memo lists VJOURNAL and task lists VTODO, which can have prefilled values by the backend.

New in version 3.2.

ECal.BACKEND_PROPERTY_REVISION = 'revision'

The current overall revision string, this can be used as a quick check to see if data has changed at all since the last time the calendar revision was observed.

New in version 3.4.

ECal.EVOLUTION_ALARM_UID_PROPERTY = 'X-EVOLUTION-ALARM-UID'

Extension property for alarm components so that we can reference them by UID.

New in version 3.34.

ECal.EVOLUTION_ENDDATE_PARAMETER = 'X-EVOLUTION-ENDDATE'

The X parameter name being used to store the enddate in RRULE and EXRULE properties.

New in version 3.34.

ECal.LIBICAL_GLIB_UNSTABLE_API = 1
ECal.STATIC_CAPABILITY_ALARM_DESCRIPTION = 'alarm-description'

Flag indicating that the backend supports alarm description

New in version 3.8.

ECal.STATIC_CAPABILITY_ALL_DAY_EVENT_AS_TIME = 'all-day-event-as-time'

Let the client know that it should store All Day event times as time with a time zone, rather than as a date.

New in version 3.18.

ECal.STATIC_CAPABILITY_BULK_ADDS = 'bulk-adds'

Flag indicating that the backend supports bulk additions.

New in version 3.6.

ECal.STATIC_CAPABILITY_BULK_MODIFIES = 'bulk-modifies'

Flag indicating that the backend supports bulk modifications.

New in version 3.6.

ECal.STATIC_CAPABILITY_BULK_REMOVES = 'bulk-removes'

Flag indicating that the backend supports bulk removals.

New in version 3.6.

ECal.STATIC_CAPABILITY_COMPONENT_COLOR = 'component-color'

When the capability is set, the client supports storing color for individual components.

New in version 3.30.

ECal.STATIC_CAPABILITY_CREATE_MESSAGES = 'create-messages'

New in version 2.26.

ECal.STATIC_CAPABILITY_DELEGATE_SUPPORTED = 'delegate-support'
ECal.STATIC_CAPABILITY_DELEGATE_TO_MANY = 'delegate-to-many'
ECal.STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING = 'has-unaccepted-meeting'
ECal.STATIC_CAPABILITY_ITIP_SUPPRESS_ON_REMOVE_SUPPORTED = 'itip-suppress-on-remove-supported'

Set, when the backend supports ECal.STATIC_CAPABILITY_SAVE_SCHEDULES and it can suppress iTip message on component removal. The capability should be ignored when the ECal.STATIC_CAPABILITY_SAVE_SCHEDULES is not present.

The backend checks ECal.OperationFlags.DISABLE_ITIP_MESSAGE flag when these capabilities are present and sends or does not send iTip message accordingly.

New in version 3.50.

ECal.STATIC_CAPABILITY_NO_ALARM_AFTER_START = 'no-alarm-after-start'

Flag indicating that the backend does not support alarm after start the event

New in version 3.8.

ECal.STATIC_CAPABILITY_NO_ALARM_REPEAT = 'no-alarm-repeat'
ECal.STATIC_CAPABILITY_NO_AUDIO_ALARMS = 'no-audio-alarms'
ECal.STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK = 'no-conv-to-assign-task'
ECal.STATIC_CAPABILITY_NO_CONV_TO_RECUR = 'no-conv-to-recur'
ECal.STATIC_CAPABILITY_NO_DISPLAY_ALARMS = 'no-display-alarms'
ECal.STATIC_CAPABILITY_NO_EMAIL_ALARMS = 'no-email-alarms'
ECal.STATIC_CAPABILITY_NO_GEN_OPTIONS = 'no-general-options'
ECal.STATIC_CAPABILITY_NO_MEMO_START_DATE = 'no-memo-start-date'
ECal.STATIC_CAPABILITY_NO_ORGANIZER = 'no-organizer'
ECal.STATIC_CAPABILITY_NO_PROCEDURE_ALARMS = 'no-procedure-alarms'
ECal.STATIC_CAPABILITY_NO_TASK_ASSIGNMENT = 'no-task-assignment'
ECal.STATIC_CAPABILITY_NO_THISANDFUTURE = 'no-thisandfuture'
ECal.STATIC_CAPABILITY_NO_THISANDPRIOR = 'no-thisandprior'
ECal.STATIC_CAPABILITY_NO_TRANSPARENCY = 'no-transparency'
ECal.STATIC_CAPABILITY_ONE_ALARM_ONLY = 'one-alarm-only'
ECal.STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT = 'organizer-must-accept'
ECal.STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND = 'organizer-must-attend'
ECal.STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS = 'organizer-not-email-address'
ECal.STATIC_CAPABILITY_RECURRENCES_NO_MASTER = 'recurrences-no-master-object'
ECal.STATIC_CAPABILITY_REFRESH_SUPPORTED = 'refresh-supported'

New in version 2.30.

ECal.STATIC_CAPABILITY_REMOVE_ALARMS = 'remove-alarms'
ECal.STATIC_CAPABILITY_REMOVE_ONLY_THIS = 'remove-only-this'

FIXME: Document me.

New in version 3.2.

ECal.STATIC_CAPABILITY_REQ_SEND_OPTIONS = 'require-send-options'
ECal.STATIC_CAPABILITY_RETRACT_SUPPORTED = 'retract-supported'

Set, when the backend supports retract. That’s a way to ask for a meeting deletion with a comment, which is stored in a component as X-EVOLUTION-RETRACT-COMMENT property.

New in version 3.50.

ECal.STATIC_CAPABILITY_SAVE_SCHEDULES = 'save-schedules'
ECal.STATIC_CAPABILITY_SIMPLE_MEMO = 'simple-memo'

When the capability is set, the backend handles only simple memos, which means it stores only memo description. The summary can be changed by the backend, if needed.

New in version 3.38.

ECal.STATIC_CAPABILITY_SIMPLE_MEMO_WITH_SUMMARY = 'simple-memo-with-summary'

Similar to the ECal.STATIC_CAPABILITY_SIMPLE_MEMO, except the backend stores the description and the summary separately.

New in version 3.42.

ECal.STATIC_CAPABILITY_TASK_CAN_RECUR = 'task-can-recur'

When the capability is set, the client can store and provide recurring tasks, otherwise it cannot.

New in version 3.30.

ECal.STATIC_CAPABILITY_TASK_DATE_ONLY = 'task-date-only'

Let the client know that the Task Start date, Due date and Completed date can be entered only as dates. When the capability is not set, then these can be date and time.

New in version 3.24.

ECal.STATIC_CAPABILITY_TASK_ESTIMATED_DURATION = 'task-estimated-duration'

Set, when the backend supports ESTIMATED-DURATION property for tasks.

New in version 3.44.

ECal.STATIC_CAPABILITY_TASK_HANDLE_RECUR = 'task-handle-recur'

When the capability is set, the backend handles task recurrence completion on its own. This does not imply ECal.STATIC_CAPABILITY_TASK_CAN_RECUR.

New in version 3.34.

ECal.STATIC_CAPABILITY_TASK_NO_ALARM = 'task-no-alarm'

When the capability is set, the client cannot store reminders on tasks, otherwise it can.

New in version 3.30.