Interface: BackupContents
Defined in: areas/backup/contents.ts:61
What a backup file holds, as backupContents reads it.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
activities | BackupContentsActivity[] | - | areas/backup/contents.ts:71 |
gradebook | boolean | Whether it holds the course's gradebook setup (its categories): a whole course's with graded activities does, a part's doesn't. | areas/backup/contents.ts:81 |
identifies | BackupIdentifier[] | What in it still names a person or the site and course it came from: user ids (files' owners, questions' creators…), authors' names, the original site's address and identifier hash, the course's id and names, the site's host in question stamps, the site's address in texts, the backup's log. Empty for a backup anonymizeBackup wrote, so a catalog can check one before taking it. | areas/backup/contents.ts:88 |
moodle | object | The Moodle that made it: its version number ("2026042004") and release ("5.2.4 (Build: 20261005)"). | areas/backup/contents.ts:67 |
moodle.release | string | - | areas/backup/contents.ts:67 |
moodle.version | string | - | areas/backup/contents.ts:67 |
name | string | The file's name. | areas/backup/contents.ts:63 |
original | object | Where it was made: the site's address and the course. | areas/backup/contents.ts:69 |
original.courseFullName? | string | - | areas/backup/contents.ts:69 |
original.courseId | number | - | areas/backup/contents.ts:69 |
original.courseShortName? | string | - | areas/backup/contents.ts:69 |
original.format? | string | - | areas/backup/contents.ts:69 |
original.site? | string | - | areas/backup/contents.ts:69 |
plugins | string[] | The plugins a site needs to restore all of it, by their full names: activity modules (mod_quiz), question types (qtype_multichoice), blocks (block_html) and the course format (format_topics, used for a new course). | areas/backup/contents.ts:77 |
sections | BackupContentsSection[] | - | areas/backup/contents.ts:70 |
type | "course" | "activity" | "section" | A backup of a course (whole, or the part chosen), of one section or of one activity. | areas/backup/contents.ts:65 |
withUsers | boolean | Whether it holds people's data (users, and with them their work, grades, posts…). | areas/backup/contents.ts:79 |