Skip to main content

Module pages

Module pages 

Source

StructsΒ§

CmsPageExercise
CmsPageExerciseSlide
CmsPageExerciseTask
CmsPageUpdate
ContentManagementPage
CourseMaterialPageContentFilterCache πŸ”’
CoursePageWithUserData
ExerciseTaskIdAndSpec πŸ”’
ExerciseWithExerciseTasks
HistoryRestoreData
IsChapterFrontPage
NewCoursePage
NewPage
Represents the subset of page fields that are required to create a new page.
NormalizedCmsExerciseTask
Page
PageAudioFiles
PageChapterAndCourseInformation
PageDetailsUpdate
Represents the subset of page fields that can be updated from the main frontend dialog β€œEdit page details”.
PageInfo
PageMetadata
PageNavigationInformation
PageRoutingData
PageSearchResult
PageUpdateArgs
PageWithExercises
RawPageSearchResult πŸ”’
SearchContentHeadlineRow πŸ”’
SearchRequest

EnumsΒ§

LockChapterContentState
PageSearchQueryType πŸ”’
PageVisibility

ConstantsΒ§

URL_PATH_ENCODE_SET πŸ”’

FunctionsΒ§

add_course_url_prefix_to_search_results πŸ”’
build_public_search_content_headlines πŸ”’
collect_searchable_text_from_content_value πŸ”’
create_for_course_id
delete_page_and_exercises
extract_searchable_text_from_content_value πŸ”’
fetch_derived_spec πŸ”’
filter_course_material_page
filter_course_material_page_with_cache πŸ”’
filter_course_material_pages
filter_course_material_pages_with_exercises
get_all_by_course_id_and_visibility
Gets all pages that belong to the given course that match the visibility filter.
get_by_exam_id
Gets the page that belongs to the given exam. For exams, the page visibility is ignored.
get_by_ids_and_visibility
get_by_ids_deleted_and_visibility
get_chapter_front_page_by_page_id
get_chapter_pages
get_chapters_pages_with_exercises
get_chapters_visible_pages_exclude_main_frontpage
get_course_and_exam_id
get_course_page_with_user_data_from_selected_page
get_course_pages_by_chapter_id_and_visibility
Gets all pages that belong to the given chapter that match the visibility filter.
get_course_top_level_pages_by_course_id_and_visibility
Gets all pages that belong to the given course but not in any chapter.
get_current_page_metadata πŸ”’
get_front_page_by_chapter_id
get_lock_chapter_content_state_for_page πŸ”’
get_next_order_number_for_courses_top_level_pages πŸ”’
get_next_page
get_next_page_by_chapter_number πŸ”’
get_next_page_by_order_number πŸ”’
get_next_page_order_number_in_chapter πŸ”’
get_organization_id
get_page
get_page_by_course_id_and_language_group
get_page_by_stored_path πŸ”’
get_page_chapter_and_course_information
get_page_info
get_page_navigation_data
get_page_search_results πŸ”’
get_page_search_results_for_phrase
Returns search results for a phrase i.e. looks for matches where the words come up right after each other
get_page_search_results_for_words
Returns search results for the given words. The words can appear in the source document in any order.
get_page_with_exercises
get_page_with_user_data_by_path
get_pages_by_course_id
get_previous_page
get_previous_page_by_chapter_number πŸ”’
get_previous_page_by_order_number πŸ”’
insert_course_page
insert_exam_page
insert_new_content_page
insert_page
is_chapter_front_page
normalize_url_path_for_storage πŸ”’
Percent-encodes URL path characters that are not part of the safe path alphabet.
reorder_chapters
reorder_pages
Makes the order numbers and chapter ids to match in the db what’s in the page objects Assumes that all pages belong to the given course id Also assumes the list of pages includes all nondeleted pages in the course, except chapter front pages, which cannot be moved, otherwise we will end up with random order numbers
restore
Restore page contents and exercises to a previous revision
restore_from_history_for_page_id
sanitized_searchable_text_for_public_page πŸ”’
set_chapter
try_to_find_redirected_page
try_to_find_redirected_page_by_stored_path πŸ”’
update_by_id_in_parent_context
update_page
update_page_content
Only used when testing.
update_page_details
upsert_exercise_slides πŸ”’
Remaps ids from updates to exercise slides that may have their ids changed.
upsert_exercise_tasks πŸ”’
Remaps ids from updates to exercise tasks that may have their ids changed.
upsert_exercises πŸ”’
Remaps ids from updates to exercises that may have their ids regenerated.
upsert_peer_or_self_review_configs
upsert_peer_or_self_review_questions