diff options
Diffstat (limited to 'browser/components/backup/docs')
| -rw-r--r-- | browser/components/backup/docs/backup-ui-actors.rst | 22 | ||||
| -rw-r--r-- | browser/components/backup/docs/index.rst | 1 |
2 files changed, 23 insertions, 0 deletions
diff --git a/browser/components/backup/docs/backup-ui-actors.rst b/browser/components/backup/docs/backup-ui-actors.rst new file mode 100644 index 0000000000..eafe59d05b --- /dev/null +++ b/browser/components/backup/docs/backup-ui-actors.rst @@ -0,0 +1,22 @@ +========================== +Backup UI Actors Reference +========================== + +The ``BackupUIParent`` and ``BackupUIChild`` actors allow UI widgets to access +the current state of the ``BackupService`` and to subscribe to state updates. + +UI widgets that want to subscribe to state updates must ensure that they are +running in a process and on a page that the ``BackupUIParent/BackupUIChild`` +actor pair are registered for, and then fire a ``BackupUI::InitWidget`` event. + +It is expected that these UI widgets will respond to having their +``backupServiceState`` property set. + +.. js:autoclass:: BackupUIParent + :members: + :private-members: + +.. js:autoclass:: BackupUIChild +.. js::autoattribute:: BackupUIChild#inittedWidgets + :members: + :private-members: diff --git a/browser/components/backup/docs/index.rst b/browser/components/backup/docs/index.rst index db9995dad2..fc8751f9d2 100644 --- a/browser/components/backup/docs/index.rst +++ b/browser/components/backup/docs/index.rst @@ -12,3 +12,4 @@ into a single file that can be easily restored from. backup-service backup-resources + backup-ui-actors |