Reminder¶
Todo
Docstrings (module)
Models¶
- class indico.modules.events.reminders.models.reminders.EventReminder(**kwargs)¶
Email reminders for events.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
- property all_recipients¶
Return all recipients of the notifications.
This includes both explicit recipients and, if enabled, participants/speakers of the event.
- attach_ical¶
If the notification should include the event’s iCalendar file.
- created_dt¶
The date/time when the reminder was created
- creator¶
The user who created the reminder
- creator_id¶
The ID of the user who created the reminder
- event¶
The Event this reminder is associated with
- event_id¶
The ID of the event
- event_start_delta¶
How long before the event start the reminder should be sent This is needed to update the scheduled_dt when changing the start time of the event.
- id¶
The ID of the reminder
- include_description¶
If the notification should include the event’s description.
- include_summary¶
If the notification should include a summary of the event’s schedule.
- property is_overdue¶
- is_relative¶
Return if the reminder is relative to the event time.
- is_sent¶
If the reminder has been sent
- property locator¶
- message¶
Custom message to include in the email
- query: IndicoBaseQuery¶
A SQLAlchemy query for a model. Equivalent to
db.session.query(Model). Can be customized per-model by overridingquery_class.Warning
The query interface is considered legacy in SQLAlchemy. Prefer using
session.execute(select())instead.
- recipients¶
The recipients of the notification
- reply_to_address¶
The address to use as Reply-To in the notification email.
- scheduled_dt¶
The date/time when the reminder should be sent
- send()¶
Send the reminder to its recipients.
- send_to_participants¶
If the notification should also be sent to all event participants
- send_to_speakers¶
If the notification should also be sent to all event speakers
Utilities¶
- indico.modules.events.reminders.util.make_reminder_email(event, with_agenda, with_description, note)¶
Return the template module for the reminder email.
- Parameters:
event – The event
with_agenda – If the event’s agenda should be included
note – A custom message to include in the email