diff --git a/Docs/XXMessengerClient.md b/Docs/XXMessengerClient.md index 05afa4aaa33cb74d114d0548faf8c157e00678ce..46ded0e727b4b8836a4560f8e4434780d44ccf54 100644 --- a/Docs/XXMessengerClient.md +++ b/Docs/XXMessengerClient.md @@ -95,4 +95,54 @@ let e2e = messenger.e2e() // get UserDicovery: let ud = messenger.ud() -``` \ No newline at end of file + +// get Backup: +let backup = messenger.backup() +``` + +## 💾 Backup + +Make backup: + +```swift +// start receiving backup data before starting or resuming backup: +let cancellable = messenger.registerBackupCallback(.init { data in + // handle backup data, save on disk, upload to cloud, etc. +}) + +// check if backup is already running: +if messenger.isBackupRunning() == false { + do { + // try to resume previous backup: + try messenger.resumeBackup() + } catch { + // try to start a new backup: + try messenger.startBackup(password: "backup-passphrase") + } +} + +// add backup params to the backup: +let params: BackupParams = ... +try messenger.backupParams(params) + +// stop the backup: +try messenger.stopBackup() + +// optionally stop receiving backup data +cancellable.cancel() +``` + +The registered backup callback can be reused later when a new backup is started. There is no need to cancel it and register a new callback in such a case. + +Restore from backup: + +```swift +let result = try messenger.restoreBackup( + backupData: ..., + backupPassphrase: "backup-passphrase" +) + +// handle restore result +``` + +If no error was thrown during restoration, the `Messenger` is already loaded, started, connected, and logged in. \ No newline at end of file