docs(crypto): Note that the in-room verification events need to be decrypted

Author: poljar

bindings/matrix-sdk-crypto-ffi/src/machine.rs

@@ -833,8 +833,7 @@ impl OlmMachine {
     /// This method can be used to pass verification events that are happening
     /// in unencrypted rooms to the `OlmMachine`.
     ///
-    /// **Note**: This does not need to be called for encrypted events since
-    /// those will get passed to the `OlmMachine` during decryption.
+    /// **Note**: This has been deprecated.
     pub fn receive_unencrypted_verification_event(
         &self,
         event: &str,
@@ -846,7 +845,7 @@ impl OlmMachine {
     /// Receive a verification event.
     ///
     /// This method can be used to pass verification events that are happening
-    /// in rooms to the `OlmMachine`.
+    /// in rooms to the `OlmMachine`. The event should be in the decrypted form.
     pub fn receive_verification_event(
         &self,
         event: &str,

bindings/matrix-sdk-crypto-js/src/machine.rs

@@ -635,8 +635,8 @@ impl OlmMachine {
 
     /// Receive a verification event.
     ///
-    /// This method can be used to pass verification events that are
-    /// happening in rooms to the `OlmMachine`.
+    /// This method can be used to pass verification events that are happening
+    /// in rooms to the `OlmMachine`. The event should be in the decrypted form.
     #[wasm_bindgen(js_name = "receiveVerificationEvent")]
     pub fn receive_verification_event(&self, event: &str) -> Result<Promise, JsError> {
         let event: ruma::events::AnyMessageLikeEvent = serde_json::from_str(event)?;

crates/matrix-sdk-crypto/src/machine.rs

@@ -740,7 +740,7 @@ impl OlmMachine {
 
     /// Receive a verification event.
     ///
-    /// This method can be used to pass verification events that are happening
+    /// in rooms to the `OlmMachine`. The event should be in the decrypted form.
     /// in rooms to the `OlmMachine`.
     pub async fn receive_verification_event(&self, event: &AnyMessageLikeEvent) -> StoreResult<()> {
         self.verification_machine.receive_any_event(event).await