Skip to content
Snippets Groups Projects
Commit 791ac125 authored by Dariusz Rybicki's avatar Dariusz Rybicki
Browse files

Update docs

parent c87b61ae
No related branches found
No related tags found
2 merge requests!107Messenger - backup,!102Release 1.0.0
This commit is part of merge request !107. Comments created here will be created in the context of that merge request.
...@@ -95,4 +95,54 @@ let e2e = messenger.e2e() ...@@ -95,4 +95,54 @@ let e2e = messenger.e2e()
// get UserDicovery: // get UserDicovery:
let ud = messenger.ud() 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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment