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.
- all_tags
If all the of the selected tags must be present for the participants (ie. AND relation)
- 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
- default_render_mode = 1
- event
The Event this reminder is associated with
- event_end_delta
How long after the event end the reminder should be sent This is needed to update the scheduled_dt when changing the end time of the event.
- 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.
- forms
The registration forms assigned to this reminder
- 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.
- is_end_time_relative
Return true if the reminder is relative to the event end time.
- property is_overdue
- is_relative
Return true if the reminder is relative either to the event start or end time.
- is_sent
If the reminder has been sent
- is_start_time_relative
Return true if the reminder is relative to the event start time.
- property locator
- log(*args, **kwargs)
Log with prefilled metadata for the event reminder.
- message
- possible_render_modes = {RenderMode.html, RenderMode.plain_text}
- recipients
The recipients of the notification
- reminder_type
It is a standard reminder or a customized one.
- render_mode
- 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
- subject
Subject of reminder email for customized reminder.
- tags
The registration tags assigned to this reminder
Utilities
- indico.modules.events.reminders.util.get_reminder_email_tpl(event, reminder_type, render_mode, with_agenda, with_description, subject, message)
Return template modules for reminder email in both text/html and text/plain format if applicable.
Legacy reminder (text/plain message) -> text/plain email format only Standard reminder (text/html message) -> both text/html and text/plain email format Custom reminder (text/html message) -> text/html email format only
- Parameters:
event – The event
reminder_type – standard|custom
render_mode – plain_text|html
with_agenda – If the event’s agenda should be included
subject – Subject for the custom reminder
message – A custom message to include in the email (full email body for custom reminder)
- Returns:
tuple of templates for text/html and text/plain representation