openedx.features package

Subpackages

• openedx.features.announcements package
  • Subpackages
    • openedx.features.announcements.settings package
      • Submodules
      • openedx.features.announcements.settings.common module
      • Module contents
  • Submodules
  • openedx.features.announcements.apps module
    • AnnouncementsConfig
      • AnnouncementsConfig.name
      • AnnouncementsConfig.plugin_app
  • openedx.features.announcements.forms module
    • AnnouncementForm
      • AnnouncementForm.Meta
      • AnnouncementForm.base_fields
      • AnnouncementForm.declared_fields
      • AnnouncementForm.media
  • openedx.features.announcements.models module
    • Announcement
      • Announcement.DoesNotExist
      • Announcement.MultipleObjectsReturned
      • Announcement.active
      • Announcement.content
      • Announcement.id
      • Announcement.objects
  • openedx.features.announcements.urls module
  • openedx.features.announcements.views module
    • AnnouncementsJSONView
      • AnnouncementsJSONView.get()
      • AnnouncementsJSONView.model
      • AnnouncementsJSONView.object_list
      • AnnouncementsJSONView.paginate_by
  • Module contents
• openedx.features.calendar_sync package
  • Subpackages
    • openedx.features.calendar_sync.views package
      • Submodules
      • openedx.features.calendar_sync.views.calendar_sync module
      • Module contents
  • Submodules
  • openedx.features.calendar_sync.api module
    • subscribe_user_to_calendar()
    • unsubscribe_user_to_calendar()
  • openedx.features.calendar_sync.apps module
    • UserCalendarSyncConfig
      • UserCalendarSyncConfig.name
      • UserCalendarSyncConfig.ready()
  • openedx.features.calendar_sync.ics module
    • generate_ics_files_for_user_course()
    • generate_ics_for_event()
  • openedx.features.calendar_sync.models module
    • UserCalendarSyncConfig
      • UserCalendarSyncConfig.DoesNotExist
      • UserCalendarSyncConfig.MultipleObjectsReturned
      • UserCalendarSyncConfig.course_key
      • UserCalendarSyncConfig.enabled
      • UserCalendarSyncConfig.history
      • UserCalendarSyncConfig.ics_sequence
      • UserCalendarSyncConfig.id
      • UserCalendarSyncConfig.is_enabled_for_course()
      • UserCalendarSyncConfig.objects
      • UserCalendarSyncConfig.save_without_historical_record()
      • UserCalendarSyncConfig.user
      • UserCalendarSyncConfig.user_id
  • openedx.features.calendar_sync.plugins module
    • CalendarSyncToggleTool
      • CalendarSyncToggleTool.analytics_id()
      • CalendarSyncToggleTool.data()
      • CalendarSyncToggleTool.http_method
      • CalendarSyncToggleTool.icon_classes()
      • CalendarSyncToggleTool.is_enabled()
      • CalendarSyncToggleTool.link_title
      • CalendarSyncToggleTool.title()
      • CalendarSyncToggleTool.toggle_data
      • CalendarSyncToggleTool.url()
  • openedx.features.calendar_sync.signals module
    • handle_calendar_sync_email()
  • openedx.features.calendar_sync.urls module
  • openedx.features.calendar_sync.utils module
    • calendar_sync_initial_email_content()
    • calendar_sync_update_email_content()
    • prepare_attachments()
    • send_email_with_attachment()
  • Module contents
    • get_calendar_event_id()
• openedx.features.content_type_gating package
  • Submodules
  • openedx.features.content_type_gating.apps module
    • ContentTypeGatingConfig
      • ContentTypeGatingConfig.name
  • openedx.features.content_type_gating.block_transformers module
    • ContentTypeGateTransformer
      • ContentTypeGateTransformer.READ_VERSION
      • ContentTypeGateTransformer.WRITE_VERSION
      • ContentTypeGateTransformer.collect()
      • ContentTypeGateTransformer.name()
      • ContentTypeGateTransformer.transform()
  • openedx.features.content_type_gating.field_override module
    • ContentTypeGatingFieldOverride
      • ContentTypeGatingFieldOverride.enabled_for()
      • ContentTypeGatingFieldOverride.get()
  • openedx.features.content_type_gating.helpers module
    • correct_modes_for_fbe()
    • enrollment_date_for_fbe()
    • has_full_access_role_in_masquerade()
  • openedx.features.content_type_gating.models module
    • ContentTypeGatingConfig
      • ContentTypeGatingConfig.DoesNotExist
      • ContentTypeGatingConfig.MultipleObjectsReturned
      • ContentTypeGatingConfig.STACKABLE_FIELDS
      • ContentTypeGatingConfig.change_date
      • ContentTypeGatingConfig.changed_by
      • ContentTypeGatingConfig.changed_by_id
      • ContentTypeGatingConfig.clean()
      • ContentTypeGatingConfig.course
      • ContentTypeGatingConfig.course_id
      • ContentTypeGatingConfig.enabled
      • ContentTypeGatingConfig.enabled_as_of
      • ContentTypeGatingConfig.enabled_as_of_datetime()
      • ContentTypeGatingConfig.enabled_for_course()
      • ContentTypeGatingConfig.enabled_for_enrollment()
      • ContentTypeGatingConfig.get_next_by_change_date()
      • ContentTypeGatingConfig.get_previous_by_change_date()
      • ContentTypeGatingConfig.id
      • ContentTypeGatingConfig.org
      • ContentTypeGatingConfig.org_course
      • ContentTypeGatingConfig.site
      • ContentTypeGatingConfig.site_id
      • ContentTypeGatingConfig.studio_override_enabled
  • openedx.features.content_type_gating.partitions module
    • ContentTypeGatingPartition
      • ContentTypeGatingPartition.access_denied_fragment()
      • ContentTypeGatingPartition.access_denied_message()
    • ContentTypeGatingPartitionScheme
      • ContentTypeGatingPartitionScheme.create_user_partition()
      • ContentTypeGatingPartitionScheme.get_group_for_user()
      • ContentTypeGatingPartitionScheme.read_only
    • create_content_gating_partition()
  • openedx.features.content_type_gating.services module
    • ContentTypeGatingService
      • ContentTypeGatingService.check_children_for_content_type_gating_paywall()
  • Module contents
• openedx.features.course_bookmarks package
  • Subpackages
    • openedx.features.course_bookmarks.views package
      • Submodules
      • openedx.features.course_bookmarks.views.course_bookmarks module
      • Module contents
  • Submodules
  • openedx.features.course_bookmarks.plugins module
    • CourseBookmarksTool
      • CourseBookmarksTool.analytics_id()
      • CourseBookmarksTool.icon_classes()
      • CourseBookmarksTool.is_enabled()
      • CourseBookmarksTool.title()
      • CourseBookmarksTool.url()
  • openedx.features.course_bookmarks.urls module
  • Module contents
• openedx.features.course_duration_limits package
  • Submodules
  • openedx.features.course_duration_limits.access module
    • AuditExpiredError
    • check_course_expired()
    • course_expiration_wrapper()
    • generate_course_expired_fragment()
    • generate_course_expired_fragment_from_key()
    • generate_course_expired_message()
    • generate_fragment_from_message()
    • get_access_expiration_data()
    • get_user_course_duration()
    • get_user_course_expiration_date()
  • openedx.features.course_duration_limits.apps module
    • CourseDurationLimitsConfig
      • CourseDurationLimitsConfig.name
  • openedx.features.course_duration_limits.config module
  • openedx.features.course_duration_limits.models module
    • CourseDurationLimitConfig
      • CourseDurationLimitConfig.DoesNotExist
      • CourseDurationLimitConfig.MultipleObjectsReturned
      • CourseDurationLimitConfig.STACKABLE_FIELDS
      • CourseDurationLimitConfig.change_date
      • CourseDurationLimitConfig.changed_by
      • CourseDurationLimitConfig.changed_by_id
      • CourseDurationLimitConfig.clean()
      • CourseDurationLimitConfig.course
      • CourseDurationLimitConfig.course_id
      • CourseDurationLimitConfig.enabled
      • CourseDurationLimitConfig.enabled_as_of
      • CourseDurationLimitConfig.enabled_as_of_datetime()
      • CourseDurationLimitConfig.enabled_for_course()
      • CourseDurationLimitConfig.enabled_for_enrollment()
      • CourseDurationLimitConfig.get_next_by_change_date()
      • CourseDurationLimitConfig.get_previous_by_change_date()
      • CourseDurationLimitConfig.id
      • CourseDurationLimitConfig.org
      • CourseDurationLimitConfig.org_course
      • CourseDurationLimitConfig.site
      • CourseDurationLimitConfig.site_id
  • Module contents
• openedx.features.course_experience package
  • Subpackages
    • openedx.features.course_experience.api package
      • Subpackages
      • Module contents
    • openedx.features.course_experience.views package
      • Submodules
      • openedx.features.course_experience.views.course_dates module
      • openedx.features.course_experience.views.course_home module
      • openedx.features.course_experience.views.course_sock module
      • openedx.features.course_experience.views.course_updates module
      • Module contents
  • Submodules
  • openedx.features.course_experience.course_tools module
    • CourseTool
      • CourseTool.analytics_id()
      • CourseTool.data()
      • CourseTool.http_method
      • CourseTool.icon_classes()
      • CourseTool.is_enabled()
      • CourseTool.title()
      • CourseTool.url()
    • CourseToolsPluginManager
      • CourseToolsPluginManager.NAMESPACE
      • CourseToolsPluginManager.get_course_tools()
      • CourseToolsPluginManager.get_enabled_course_tools()
    • HttpMethod
      • HttpMethod.DELETE
      • HttpMethod.GET
      • HttpMethod.OPTIONS
      • HttpMethod.POST
      • HttpMethod.PUT
  • openedx.features.course_experience.course_updates module
    • dismiss_current_update_for_user()
    • get_current_update_for_user()
    • get_ordered_updates()
  • openedx.features.course_experience.plugins module
    • CourseUpdatesTool
      • CourseUpdatesTool.analytics_id()
      • CourseUpdatesTool.icon_classes()
      • CourseUpdatesTool.is_enabled()
      • CourseUpdatesTool.title()
      • CourseUpdatesTool.url()
  • openedx.features.course_experience.url_helpers module
    • get_courseware_url()
    • get_learning_mfe_home_url()
    • is_request_from_learning_mfe()
    • make_learning_mfe_courseware_url()
  • openedx.features.course_experience.urls module
  • openedx.features.course_experience.utils module
    • dates_banner_should_display()
    • get_course_outline_block_tree()
    • get_start_block()
    • is_block_structure_complete_for_assignments()
  • openedx.features.course_experience.waffle module
  • Module contents
    • course_home_page_title()
    • course_home_url()
    • default_course_url()
• openedx.features.discounts package
  • Submodules
  • openedx.features.discounts.applicability module
    • can_receive_discount()
    • can_show_streak_discount_coupon()
    • discount_percentage()
    • get_discount_expiration_date()
  • openedx.features.discounts.apps module
    • DiscountsConfig
      • DiscountsConfig.name
  • openedx.features.discounts.models module
    • DiscountPercentageConfig
      • DiscountPercentageConfig.DoesNotExist
      • DiscountPercentageConfig.MultipleObjectsReturned
      • DiscountPercentageConfig.STACKABLE_FIELDS
      • DiscountPercentageConfig.change_date
      • DiscountPercentageConfig.changed_by
      • DiscountPercentageConfig.changed_by_id
      • DiscountPercentageConfig.course
      • DiscountPercentageConfig.course_id
      • DiscountPercentageConfig.enabled
      • DiscountPercentageConfig.get_next_by_change_date()
      • DiscountPercentageConfig.get_previous_by_change_date()
      • DiscountPercentageConfig.id
      • DiscountPercentageConfig.org
      • DiscountPercentageConfig.org_course
      • DiscountPercentageConfig.percentage
      • DiscountPercentageConfig.site
      • DiscountPercentageConfig.site_id
    • DiscountRestrictionConfig
      • DiscountRestrictionConfig.DoesNotExist
      • DiscountRestrictionConfig.MultipleObjectsReturned
      • DiscountRestrictionConfig.STACKABLE_FIELDS
      • DiscountRestrictionConfig.change_date
      • DiscountRestrictionConfig.changed_by
      • DiscountRestrictionConfig.changed_by_id
      • DiscountRestrictionConfig.course
      • DiscountRestrictionConfig.course_id
      • DiscountRestrictionConfig.disabled
      • DiscountRestrictionConfig.disabled_for_course_stacked_config()
      • DiscountRestrictionConfig.enabled
      • DiscountRestrictionConfig.get_next_by_change_date()
      • DiscountRestrictionConfig.get_previous_by_change_date()
      • DiscountRestrictionConfig.id
      • DiscountRestrictionConfig.org
      • DiscountRestrictionConfig.org_course
      • DiscountRestrictionConfig.site
      • DiscountRestrictionConfig.site_id
  • openedx.features.discounts.urls module
  • openedx.features.discounts.utils module
    • format_strikeout_price()
    • generate_offer_data()
    • offer_banner_wrapper()
  • openedx.features.discounts.views module
    • CourseUserDiscount
      • CourseUserDiscount.authentication_classes
      • CourseUserDiscount.get()
      • CourseUserDiscount.permission_classes
    • CourseUserDiscountWithUserParam
      • CourseUserDiscountWithUserParam.authentication_classes
      • CourseUserDiscountWithUserParam.get()
      • CourseUserDiscountWithUserParam.permission_classes
  • Module contents
• openedx.features.effort_estimation package
  • Submodules
  • openedx.features.effort_estimation.api module
  • openedx.features.effort_estimation.apps module
    • EffortEstimationConfig
      • EffortEstimationConfig.name
  • openedx.features.effort_estimation.block_transformers module
    • EffortEstimationTransformer
      • EffortEstimationTransformer.CACHE_VIDEO_DURATIONS
      • EffortEstimationTransformer.DEFAULT_WPM
      • EffortEstimationTransformer.DISABLE_ESTIMATION
      • EffortEstimationTransformer.EFFORT_ACTIVITIES
      • EffortEstimationTransformer.EFFORT_TIME
      • EffortEstimationTransformer.HTML_WORD_COUNT
      • EffortEstimationTransformer.MissingEstimationData
      • EffortEstimationTransformer.READ_VERSION
      • EffortEstimationTransformer.VIDEO_CLIP_DURATION
      • EffortEstimationTransformer.VIDEO_DURATION
      • EffortEstimationTransformer.WRITE_VERSION
      • EffortEstimationTransformer.collect()
      • EffortEstimationTransformer.name()
      • EffortEstimationTransformer.transform()
  • openedx.features.effort_estimation.toggles module
  • Module contents
• openedx.features.enterprise_support package
  • Subpackages
    • openedx.features.enterprise_support.admin package
      • Submodules
      • openedx.features.enterprise_support.admin.forms module
      • openedx.features.enterprise_support.admin.views module
      • Module contents
    • openedx.features.enterprise_support.enrollments package
      • Submodules
      • openedx.features.enterprise_support.enrollments.exceptions module
      • openedx.features.enterprise_support.enrollments.utils module
      • Module contents
  • Submodules
  • openedx.features.enterprise_support.api module
    • ConsentApiClient
      • ConsentApiClient.consent_required()
      • ConsentApiClient.provide_consent()
      • ConsentApiClient.revoke_consent()
    • ConsentApiServiceClient
    • EnterpriseApiClient
      • EnterpriseApiClient.fetch_enterprise_learner_data()
      • EnterpriseApiClient.get_enterprise_customer()
      • EnterpriseApiClient.post_enterprise_course_enrollment()
    • EnterpriseApiException
    • EnterpriseApiServiceClient
      • EnterpriseApiServiceClient.get_enterprise_customer()
    • EnterpriseServiceClientMixin
    • activate_learner_enterprise()
    • add_enterprise_customer_to_session()
    • cache_enterprise()
    • consent_needed_for_course()
    • data_sharing_consent_required()
    • enterprise_customer_for_request()
    • enterprise_customer_from_api()
    • enterprise_customer_from_cache()
    • enterprise_customer_from_session()
    • enterprise_customer_from_session_or_learner_data()
    • enterprise_customer_uuid_for_request()
    • enterprise_customer_uuid_from_cookie()
    • enterprise_customer_uuid_from_query_param()
    • enterprise_customer_uuid_from_session()
    • enterprise_enabled()
    • enterprise_is_enabled()
    • get_active_enterprise_customer_user()
    • get_consent_notification_data()
    • get_consent_required_courses()
    • get_dashboard_consent_notification()
    • get_data_sharing_consents()
    • get_enterprise_consent_url()
    • get_enterprise_course_enrollments()
    • get_enterprise_customer_cache_key()
    • get_enterprise_learner_data_from_api()
    • get_enterprise_learner_data_from_db()
    • get_enterprise_learner_portal_context()
    • get_enterprise_learner_portal_enabled_message()
    • insert_enterprise_pipeline_elements()
    • unlink_enterprise_user_from_idp()
  • openedx.features.enterprise_support.apps module
    • EnterpriseSupportConfig
      • EnterpriseSupportConfig.name
      • EnterpriseSupportConfig.ready()
  • openedx.features.enterprise_support.context module
    • get_enterprise_event_context()
  • openedx.features.enterprise_support.serializers module
    • EnterpriseCourseEnrollmentSerializer
      • EnterpriseCourseEnrollmentSerializer.Meta
      • EnterpriseCourseEnrollmentSerializer.get_enterprise_customer_name()
      • EnterpriseCourseEnrollmentSerializer.get_license()
  • openedx.features.enterprise_support.signals module
    • handle_enterprise_learner_passing_grade()
    • handle_enterprise_learner_subsection()
    • refund_order_voucher()
    • update_dsc_cache_on_course_enrollment()
    • update_dsc_cache_on_enterprise_customer_update()
  • openedx.features.enterprise_support.tasks module
  • openedx.features.enterprise_support.utils module
    • clear_data_consent_share_cache()
    • enterprise_branding_configuration()
    • enterprise_fields_only()
    • fetch_enterprise_customer_by_id()
    • get_data_consent_share_cache_key()
    • get_enterprise_learner_generic_name()
    • get_enterprise_learner_portal()
    • get_enterprise_readonly_account_fields()
    • get_enterprise_sidebar_context()
    • get_enterprise_slug_login_url()
    • get_is_enterprise_cache_key()
    • get_provider_login_url()
    • handle_enterprise_cookies_for_logistration()
    • is_course_accessed()
    • is_enterprise_learner()
    • update_account_settings_context_for_enterprise()
    • update_logistration_context_for_enterprise()
    • update_third_party_auth_context_for_enterprise()
  • Module contents
• openedx.features.learner_profile package
  • Subpackages
    • openedx.features.learner_profile.views package
      • Submodules
      • openedx.features.learner_profile.views.learner_achievements module
      • openedx.features.learner_profile.views.learner_profile module
      • Module contents
  • Submodules
  • openedx.features.learner_profile.toggles module
    • should_redirect_to_profile_microfrontend()
  • openedx.features.learner_profile.urls module
  • Module contents
• openedx.features.lti_course_tab package
  • Submodules
  • openedx.features.lti_course_tab.tab module
    • DiscussionLtiCourseTab
      • DiscussionLtiCourseTab.allow_multiple
      • DiscussionLtiCourseTab.is_dynamic
      • DiscussionLtiCourseTab.is_enabled()
      • DiscussionLtiCourseTab.priority
      • DiscussionLtiCourseTab.title
      • DiscussionLtiCourseTab.type
    • LtiCourseLaunchMixin
      • LtiCourseLaunchMixin.DEFAULT_ROLE
      • LtiCourseLaunchMixin.ROLE_MAP
      • LtiCourseLaunchMixin.render_to_fragment()
    • LtiCourseTab
      • LtiCourseTab.allow_multiple
      • LtiCourseTab.is_default
      • LtiCourseTab.priority
      • LtiCourseTab.to_json()
      • LtiCourseTab.type
      • LtiCourseTab.validate()
  • Module contents
• openedx.features.name_affirmation_api package
  • Submodules
  • openedx.features.name_affirmation_api.apps module
    • NameAffirmationApiConfig
      • NameAffirmationApiConfig.name
      • NameAffirmationApiConfig.ready()
  • openedx.features.name_affirmation_api.utils module
    • get_name_affirmation_service()
    • is_name_affirmation_installed()
  • Module contents
• openedx.features.personalized_learner_schedules package
  • Subpackages
    • openedx.features.personalized_learner_schedules.show_answer package
      • Submodules
      • openedx.features.personalized_learner_schedules.show_answer.show_answer_field_override module
      • Module contents
  • Submodules
  • openedx.features.personalized_learner_schedules.call_to_action module
    • PersonalizedLearnerScheduleCallToAction
      • PersonalizedLearnerScheduleCallToAction.CAPA_SUBMIT_DISABLED
      • PersonalizedLearnerScheduleCallToAction.VERTICAL_BANNER
      • PersonalizedLearnerScheduleCallToAction.get_ctas()
      • PersonalizedLearnerScheduleCallToAction.past_due_class_warnings
  • Module contents
• openedx.features.survey_report package
  • Subpackages
    • openedx.features.survey_report.management package
      • Subpackages
      • Module contents
  • Submodules
  • openedx.features.survey_report.api module
    • generate_report()
    • get_id()
    • get_report_data()
    • send_report_to_external_api()
    • update_report()
  • openedx.features.survey_report.apps module
    • SurveyReportConfig
      • SurveyReportConfig.default_auto_field
      • SurveyReportConfig.name
  • openedx.features.survey_report.models module
    • SurveyReport
      • SurveyReport.DoesNotExist
      • SurveyReport.MultipleObjectsReturned
      • SurveyReport.courses_offered
      • SurveyReport.created_at
      • SurveyReport.enrollments
      • SurveyReport.extra_data
      • SurveyReport.generated_certificates
      • SurveyReport.get_next_by_created_at()
      • SurveyReport.get_previous_by_created_at()
      • SurveyReport.get_state_display()
      • SurveyReport.id
      • SurveyReport.learners
      • SurveyReport.objects
      • SurveyReport.registered_learners
      • SurveyReport.state
      • SurveyReport.surveyreportupload_set
    • SurveyReportAnonymousSiteID
      • SurveyReportAnonymousSiteID.DoesNotExist
      • SurveyReportAnonymousSiteID.MultipleObjectsReturned
      • SurveyReportAnonymousSiteID.id
      • SurveyReportAnonymousSiteID.objects
    • SurveyReportUpload
      • SurveyReportUpload.DoesNotExist
      • SurveyReportUpload.MultipleObjectsReturned
      • SurveyReportUpload.get_next_by_sent_at()
      • SurveyReportUpload.get_previous_by_sent_at()
      • SurveyReportUpload.id
      • SurveyReportUpload.is_uploaded()
      • SurveyReportUpload.objects
      • SurveyReportUpload.report
      • SurveyReportUpload.report_id
      • SurveyReportUpload.request_details
      • SurveyReportUpload.sent_at
      • SurveyReportUpload.status_code
  • openedx.features.survey_report.queries module
    • get_course_enrollments()
    • get_generated_certificates()
    • get_recently_active_users()
    • get_registered_learners()
    • get_unique_courses_offered()
  • openedx.features.survey_report.tasks module
  • openedx.features.survey_report.urls module
  • openedx.features.survey_report.views module
    • SurveyReportView
      • SurveyReportView.post()
  • Module contents

Module contents