summaryrefslogtreecommitdiffstats
path: root/browser/components/backup/docs/backup-resources.rst
blob: 4ead0d316d4530e224a4770ea8c6c121a57223e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
================================
Backup Resources Reference
================================

A ``BackupResource`` is the base class used to represent a group of data within
a user profile that is logical to backup together. For example, the
``PlacesBackupResource`` represents both the ``places.sqlite`` SQLite database,
as well as the ``favicons.sqlite`` database. The ``AddonsBackupResource``
represents not only the preferences for various addons, but also the XPI files
that those addons are defined in.

Each ``BackupResource`` subclass is registered for use by the
``BackupService`` by adding it to the default set of exported classes in the
``BackupResources`` module in ``BackupResources.sys.mjs``.

.. js:autoclass:: BackupResource
  :members:
  :private-members: