External Calendars
This package contains all external calendar related data models:
ExternalCalendar
External Calendar
- class integreat_cms.cms.models.external_calendars.external_calendar.ExternalCalendar(*args, **kwargs)[source]
Bases:
AbstractBaseModel
Model for representing external calendars, from which events can be imported.
- Parameters:
id (BigAutoField) – Primary key: ID
name (CharField) – Calendar name
url (URLField) – URL
import_filter_category (CharField) – The category that events need to have to get imported (Leave blank to import all events)
errors (CharField) – Import errors
last_changed_on (DateTimeField) – Last changed on
Relationship fields:
- Parameters:
region (
ForeignKey
toRegion
) – Region (related name:external_calendars
)created_by (
ForeignKey
toUser
) – Creator. The account that created this external calendar. (related name:externalcalendar
)last_changed_by (
ForeignKey
toUser
) – Last changed by. The account that was the last to change this external calendar. (related name:+
)
Reverse relationships:
- Parameters:
events (Reverse
ForeignKey
fromEvent
) – All events of this external calendar (related name ofexternal_calendar
)
- exception DoesNotExist[source]
Bases:
ObjectDoesNotExist
- exception MultipleObjectsReturned[source]
Bases:
MultipleObjectsReturned
- clean()[source]
Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.
- clean_fields(exclude=None)[source]
Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.
- created_by[source]
Type:
ForeignKey
toUser
Creator. The account that created this external calendar. (related name:
externalcalendar
)
- created_by_id[source]
Internal field, use
created_by
instead.
- events[source]
Type: Reverse
ForeignKey
fromEvent
All events of this external calendar (related name of
external_calendar
)
- full_clean(exclude=None, validate_unique=True, validate_constraints=True)[source]
Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_last_changed_on(*, field=<django.db.models.DateTimeField: last_changed_on>, is_next=True, **kwargs)[source]
Finds next instance based on
last_changed_on
. Seeget_next_by_FOO()
for more information.
- get_previous_by_last_changed_on(*, field=<django.db.models.DateTimeField: last_changed_on>, is_next=False, **kwargs)[source]
Finds previous instance based on
last_changed_on
. Seeget_previous_by_FOO()
for more information.
- get_repr() str [source]
This overwrites the default Django
__repr__()
method- Returns:
The canonical string representation of the external calendar
- Return type:
- id[source]
Type:
BigAutoField
Primary key: ID
- import_filter_category[source]
Type:
CharField
The category that events need to have to get imported (Leave blank to import all events)
- last_changed_by[source]
Type:
ForeignKey
toUser
Last changed by. The account that was the last to change this external calendar. (related name:
+
)
- last_changed_by_id[source]
Internal field, use
last_changed_by
instead.
- last_changed_on[source]
Type:
DateTimeField
Last changed on
- load_ical() Calendar [source]
Loads the url and creates an icalendar :return: The Icalendar returned by the url :raises OSError: If the url cannot be loaded :raises ValueError: If the data are not valid icalendar format
- Return type:
Calendar
- refresh_from_db(using=None, fields=None)[source]
Reload field values from the database.
By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.
Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.
When accessing deferred fields of an instance, the deferred loading of the field will call this method.
- region[source]
Type:
ForeignKey
toRegion
Region (related name:
external_calendars
)
- save(force_insert=False, force_update=False, using=None, update_fields=None)[source]
Save the current instance. Override this in a subclass if you want to control the saving process.
The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.
- save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)[source]
Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.
The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.
- serializable_value(field_name)[source]
Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.
Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.