Function: backupContents()
function backupContents(file): Promise<BackupContents>;
Defined in: areas/backup/contents.ts:266
What a backup file (.mbz) holds, read on this computer without restoring it, without a browser
or a session: the Moodle that made it, the original site and course, its sections and activities
(the original site's ids), the plugins a site needs to restore it, whether it holds people's data,
and, per activity, what it refers to that the backup doesn't hold (restrictions on activities left
out, links to them in its text, its grade category), which a restore elsewhere leaves broken.
BackupError when the file isn't a Moodle backup (or is a zip-format one, which isn't read).
Parameters
| Parameter | Type |
|---|---|
file | string |
Returns
Promise<BackupContents>