char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

matrix-sdk: Explain what needs to be done to restore a client.

master
Damir Jelić 2020-07-07 15:47:34 +02:00
parent 11aa306de2
commit f33298b1a6
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
matrix_sdk/src/client.rs
View File

@ -414,6 +414,15 @@ impl Client {
/// Login to the server.
///
/// This can be used for the first login as well as for subsequent logins,
/// note that if the device id isn't provided a new device will be created.
///
/// If this isn't the first login a device id should be provided to restore
/// the correct stores.
///
/// Alternatively the `restore_login()` method can be used to restore a
/// logged in client without the password.
///
/// # Arguments
///
/// * `user` - The user that should be logged in to the homeserver.
@ -451,6 +460,12 @@ impl Client {
/// Restore a previously logged in session.
///
/// This can be used to restore the client to a logged in state, loading all
/// the stored state and encryption keys.
///
/// Alternatively, if the whole session isn't stored the `login()` method
/// can be used with a device id.
///
/// # Arguments
///
/// * `session` - A session that the user already has from a