From a07767d41711fb3e12a04e92136a77becbd4b215 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 30 Jul 2020 11:50:42 +0200 Subject: [PATCH] base: Hide the SAS getting method behind the encryption feature. --- matrix_sdk_base/src/client.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/matrix_sdk_base/src/client.rs b/matrix_sdk_base/src/client.rs index 714dfb27..b428d1a5 100644 --- a/matrix_sdk_base/src/client.rs +++ b/matrix_sdk_base/src/client.rs @@ -1847,6 +1847,15 @@ impl BaseClient { } /// Get a `Sas` verification object with the given flow id. + /// + /// # Arguments + /// * `flow_id` - The unique id that identifies a interactive verification + /// flow. For in-room verifications this will be the event id of the + /// *m.key.verification.request* event that started the flow, for the + /// to-device verification flows this will be the transaction id of the + /// *m.key.verification.start* event. + #[cfg(feature = "encryption")] + #[cfg_attr(docsrs, doc(cfg(feature = "encryption")))] pub async fn get_verification(&self, flow_id: &str) -> Option { self.olm .lock()