Code reference

This is a generated reference of the core of the pretalx codebase. All database models and functions in the domain layer are fully documented. See Project structure for an explanation of the layering system.

Warning

This reference serves purely for developer convenience. Interfaces listed here are not guaranteed to be stable across pretalx versions.

Models 50

common

• ActivityLog models.log
• CachedFile models.file
• FileCleanupMixin models.mixins
• GenerateCode models.mixins
• GlobalSettings models.settings
• GlobalSettings_SettingsStore models.settings
• LogMixin models.mixins
• OrderedModel models.mixins
• PretalxModel models.mixins
• TimestampedModel models.mixins

event

• Event models.event
• EventExtraLink models.event
• Event_SettingsStore models.event
• Organiser models.organiser
• Team models.organiser
• TeamInvite models.organiser

mail

• MailTemplate models.templates
• QueuedMail models.queued_mail

person

• AttendeeProfile models.attendee
• ProfilePicture models.picture
• ProfilePictureMixin models.picture
• SpeakerInformation models.information
• SpeakerProfile models.profile
• User models.user
• UserApiToken models.auth_token
• UserEventPreferences models.preferences

schedule

• Availability models.availability
• Room models.room
• Schedule models.schedule
• TalkSlot models.slot

submission

• Answer models.question
• AnswerOption models.question
• AttendeeSignup models.signup
• CfP models.cfp
• Feedback models.feedback
• Question models.question
• Resource models.resource
• Review models.review
• ReviewPhase models.review
• ReviewScore models.review
• ReviewScoreCategory models.review
• SpeakerRole models.submission
• Submission models.submission
• SubmissionComment models.comment
• SubmissionFavourite models.submission
• SubmissionInvitation models.submission
• SubmissionType models.type
• SubmitterAccessCode models.access_code
• Tag models.tag
• Track models.track

Domain 303

common

domain.queries.log

• actions_by()
• event_activity_log()
• generic_event_prefetch()

event

domain.event

• activate_event()
• apply_date_edit()
• apply_event_changes()
• apply_timezone_edit()
• copy_event_data()
• create_event()
• deactivate_event()
• initialise_event()
• move_full_event()
• post_create_event()
• shred_event()

domain.lifecycle

• send_lifecycle_notifications()

domain.mail

• send_orga_mail()

domain.organiser

• create_organiser_with_team()
• shred_organiser()

domain.plugins

• apply_plugin_changes()
• disable_plugin()
• enable_plugin()

domain.queries.event

• events_for_custom_domain()
• events_for_user()
• speaker_events_for_user()

domain.queries.organiser

• organisers_for_user()

domain.queries.team

• active_reviewers_for_event()
• event_reviewer_teams()
• speaker_access_events_for_user()
• user_reviewer_teams_in_event()
• user_teams_in_organiser()

domain.team

• accept_team_invite()
• create_team_invite()
• create_team_invites()
• remove_team_member()
• retract_team_invite()
• send_team_invite()

mail

• BaseMailTextPlaceholder domain.placeholders
• BaseRichMailTextPlaceholder domain.placeholders
• LinkMailTextPlaceholder domain.placeholders
• PreviewFormatter domain.preview
• Recipient domain.recipient
• TrustedMarkdownMailTextPlaceholder domain.placeholders
• TrustedPlainMailTextPlaceholder domain.placeholders
• UntrustedMarkdownMailTextPlaceholder domain.placeholders
• UntrustedPlainMailTextPlaceholder domain.placeholders
• UntrustedSpeakerNameMailTextPlaceholder domain.placeholders

domain.compose

• build_session_mail_task_data()
• send_team_mail()

domain.context

• base_placeholders()
• get_all_reviews()
• get_mail_context()
• placeholder_aliases()

domain.placeholders

• escape_for_html_body()
• escape_for_plain_body()
• get_available_placeholders()
• get_invalid_placeholders()
• get_used_placeholders()
• placeholders_for_role()
• placeholders_for_template()
• untrusted_plain_value()

domain.preview

• build_preview_context()
• mark_placeholder_value()
• render_preview_body()
• render_preview_subject()

domain.queries

• draft_mail_counts()
• outbox_mails()
• search_mails()
• sent_mails()

domain.queue

• bulk_create_drafts()
• copy_to_draft()
• expire_stale_queued_mails()
• save_draft()
• send_outbox_mails()

domain.recipient

• recipient_account()
• recipient_speaker()

domain.render

• assert_rendered()
• build_trusted_mail()
• delivery_html()
• delivery_html_body()
• delivery_text()
• get_prefixed_subject()
• render_template_to_mail()
• render_to_mail()

domain.send

• get_send_mail_exceptions()
• send_draft()
• send_system_mail()
• send_transient()

domain.smtp

• build_message()
• deliver_payload()
• deliver_persisted()
• filter_recipients()
• mail_backend_for_event()
• resolve_envelope()
• to_recipients()

domain.template

• mail_template_by_role()

person

• AlreadyVerifiedError domain.verification
• ExpiredVerificationTokenError domain.verification
• InvalidVerificationTokenError domain.verification
• PendingEmailExpiredError domain.verification
• PendingEmailTakenError domain.verification
• SendCooldownError domain.verification
• VerificationError domain.verification

domain.auth_token

• abbreviate_token()
• revoke_token()
• update_token_events()
• upgrade_token()

domain.picture

• assign_avatar()
• set_avatar()

domain.profile

• adopt_profile_picture()
• apply_speaker_profile_changes()
• claim_speaker_profile()
• create_speaker_profile()
• merge_speaker_profiles()
• profile_deletable_after_removal()
• retract_speaker_invite()
• send_speaker_invite()
• shred_speaker_profile()

domain.queries.profile

• annotate_speaker_submission_counts()
• annotate_user_submission_counts()
• filter_by_accepted_role()
• filter_reachable()
• other_speaker_profiles()
• speaker_by_email()
• speaker_name_expression()
• speakers_for_event()
• submitters_for_event()
• visible_talk_slots()

domain.queries.user

• with_profiles()

domain.user

• change_password()
• create_user()
• deactivate_user()
• get_password_reset_url()
• reset_password()
• shred_user()

domain.verification

• cancel_email_change()
• check_send_cooldown()
• confirm_verification()
• correct_unverified_email()
• finalize_registration()
• get_verification_url()
• make_verification_token()
• parse_verification_token()
• pending_email_expired()
• promote_on_invitation_match()
• request_email_change()
• send_cooldown_remaining()
• send_verification_mail()
• set_verification_state()

schedule

domain.availability

• merged_speaker_availabilities()
• replace_availabilities()

domain.changelog

• build_changelog()

domain.changes

• calculate_schedule_changes()
• get_cached_schedule_changes()
• has_unreleased_schedule_changes()
• invalidate_cached_schedule_changes()
• update_unreleased_schedule_changes()

domain.ical

• build_slot_vevent()
• get_calendar()
• get_slot_ical()
• get_slots_ical()
• get_speaker_ical()
• get_submission_ical()
• serialize_calendar()

domain.notifications

• compute_speakers_concerned()
• count_pending_notifications()
• generate_notifications()
• get_current_notifications()
• get_full_notifications()
• get_notification_date_format()
• render_notifications()

domain.queries.schedule

• get_schedule()
• parallel_slots()
• public_talk_slots()
• published_schedules()
• room_neighbour_slots()
• schedule_day_start()

domain.release

• apply_signup_capacity_changes()
• apply_signup_capacity_defaults()
• freeze_schedule()
• guess_schedule_version()
• unfreeze_schedule()

domain.room

• active_schedule_pks()
• annotate_room_usage()
• delete_room()
• hide_room()
• room_is_in_use()
• rooms_for_schedule()
• unhide_room()

domain.slot

• copy_slot()
• create_slot()
• move_slot()
• unschedule_slot()

domain.warnings

• compute_signup_warnings()
• compute_warnings()
• get_all_talk_warnings()
• get_talk_warnings()
• overbooked_slots_for_room()

submission

domain.access_code

• can_delete_access_code()
• delete_orphan_access_codes()
• redeem_access_code()
• send_access_code()

domain.cfp

• access_code_blocker()
• can_submit_without_access_code()
• cfp_deadlines()
• submission_types_by_deadline()

domain.comment

• create_comment()

domain.feedback

• create_feedback()

domain.invitation

• accept_invitation()
• retract_invitation()
• send_invitation()

domain.queries.feedback

• feedback_for_speaker()

domain.queries.question

• active_questions()
• answers_for_user()
• count_missing_answers()
• filter_submissions_by_speaker_role()
• missing_questions_for_speaker()
• public_answers_for_speaker()
• public_answers_for_submission()
• question_answer_summary()
• question_scope_speakers()
• question_scope_submissions()
• questions_for_user()

domain.queries.review

• annotate_aggregate_scores()
• annotate_review_count()
• annotate_scored_review_count()
• annotate_state_rank()
• annotate_user_review_score()
• review_dashboard_prefetches()
• review_view_submissions()

domain.queries.speaker

• speakers_for_user()

domain.queries.submission

• annotate_assigned_reviews()
• annotate_confirmed_signup_count()
• annotate_requires_signup()
• annotate_slot_confirmed_signup_count()
• annotate_slot_requires_signup()
• annotate_slot_signup_status()
• annotate_submission_count()
• annotate_submission_signup_status()
• featured_submissions()
• filter_submissions_by_state()
• has_featured_submissions()
• information_for_user()
• reviewable_submissions_for_user()
• search_submissions()
• signed_up_submission_codes()
• signed_up_submissions_for_user()
• sorted_speakers_prefetch()
• speaker_search_q()
• submission_field_counts()
• submission_state_facets()
• submissions_for_reviewer()
• submissions_for_user()
• talks_for_event()
• unreviewed_submissions_for_user()

domain.question

• apply_uploaded_options()
• delete_question()
• export_answer_files()
• reorder_questions()
• replace_question_options()
• save_answer()
• set_question_active()

domain.resource

• create_resource()
• delete_resource()

domain.review

• activate_review_phase()
• create_or_update_review()
• recalculate_event_scores()
• recalculate_submission_scores()
• update_review_phase()
• update_review_score()
• validate_review_phases()

domain.signup

• can_user_signup()
• cancel_signup()
• create_signup()
• email_domain_allowed()
• get_confirmed_signup_for_user()
• get_signup_for_user()

domain.submission

• add_speaker()
• apply_field_changes()
• apply_invite_addresses()
• apply_pending_state()
• available_submission_types_for_submitter()
• available_tracks_for_submitter()
• create_submission()
• delete_submission()
• notify_speaker_added()
• pin_signup_required()
• queue_initial_mails()
• remove_speaker()
• reorder_speakers()
• send_initial_mails()
• send_state_mail()
• set_pending_state()
• set_submission_state()
• set_wip_slot()
• submit_draft()
• update_duration()
• update_talk_slots()

domain.submission_type

• apply_submission_type_field_changes()
• can_delete_submission_type()
• make_default_submission_type()
• propagate_default_duration()

domain.track

• apply_track_field_changes()
• can_delete_track()