diff --git a/bindings/matrix-sdk-crypto-js/src/verification.rs b/bindings/matrix-sdk-crypto-js/src/verification.rs index c9512f812..5b5d422d3 100644 --- a/bindings/matrix-sdk-crypto-js/src/verification.rs +++ b/bindings/matrix-sdk-crypto-js/src/verification.rs @@ -179,32 +179,32 @@ impl Sas { } /// Does this verification flow support displaying emoji for the - /// short authentication string. + /// short authentication string? #[wasm_bindgen(js_name = "supportsEmoji")] pub fn supports_emoji(&self) -> bool { self.inner.supports_emoji() } - /// Did this verification flow start from a verification request. + /// Did this verification flow start from a verification request? #[wasm_bindgen(js_name = "startedFromRequest")] pub fn started_from_request(&self) -> bool { self.inner.started_from_request() } - /// Is this a verification that is veryfying one of our own - /// devices. + /// Is this a verification that is verifying one of our own + /// devices? #[wasm_bindgen(js_name = "isSelfVerification")] pub fn is_self_verification(&self) -> bool { self.inner.is_self_verification() } - /// Have we confirmed that the short auth string matches. + /// Have we confirmed that the short auth string matches? #[wasm_bindgen(js_name = "haveWeConfirmed")] pub fn have_we_confirmed(&self) -> bool { self.inner.have_we_confirmed() } - /// Has the verification been accepted by both parties. + /// Has the verification been accepted by both parties? #[wasm_bindgen(js_name = "hasBeenAccepted")] pub fn has_been_accepted(&self) -> bool { self.inner.has_been_accepted() @@ -302,25 +302,25 @@ impl Sas { .map_err(Into::into) } - /// Has the SAS verification flow timed out. + /// Has the SAS verification flow timed out? #[wasm_bindgen(js_name = "timedOut")] pub fn timed_out(&self) -> bool { self.inner.timed_out() } - /// Are we in a state where we can show the short auth string. + /// Are we in a state where we can show the short auth string? #[wasm_bindgen(js_name = "canBePresented")] pub fn can_be_presented(&self) -> bool { self.inner.can_be_presented() } - /// Is the SAS flow done. + /// Is the SAS flow done? #[wasm_bindgen(js_name = "isDone")] pub fn is_done(&self) -> bool { self.inner.is_done() } - /// Is the SAS flow canceled. + /// Is the SAS flow cancelled? #[wasm_bindgen(js_name = "isCancelled")] pub fn is_cancelled(&self) -> bool { self.inner.is_cancelled() @@ -394,7 +394,7 @@ impl Qr { self.inner.has_been_scanned() } - /// Has the scanning of the QR code been confirmed by us. + /// Has the scanning of the QR code been confirmed by us? #[wasm_bindgen(js_name = "hasBeenConfirmed")] pub fn has_been_confirmed(&self) -> bool { self.inner.has_been_confirmed() @@ -419,7 +419,7 @@ impl Qr { self.inner.other_device_id().to_owned().into() } - /// Did we initiate the verification request. + /// Did we initiate the verification request? #[wasm_bindgen(js_name = "weStarted")] pub fn we_started(&self) -> bool { self.inner.we_started() @@ -432,26 +432,26 @@ impl Qr { self.inner.cancel_info().map(Into::into) } - /// Has the verification flow completed. + /// Has the verification flow completed? #[wasm_bindgen(js_name = "isDone")] pub fn is_done(&self) -> bool { self.inner.is_done() } - /// Has the verification flow been cancelled. + /// Has the verification flow been cancelled? #[wasm_bindgen(js_name = "isCancelled")] pub fn is_cancelled(&self) -> bool { self.inner.is_cancelled() } - /// Is this a verification that is veryfying one of our own devices. + /// Is this a verification that is verifying one of our own devices? #[wasm_bindgen(js_name = "isSelfVerification")] pub fn is_self_verification(&self) -> bool { self.inner.is_self_verification() } /// Have we successfully scanned the QR code and are able to send - /// a reciprocation event. + /// a reciprocation event? pub fn reciprocated(&self) -> bool { self.inner.reciprocated() } @@ -478,6 +478,8 @@ impl Qr { /// /// The `to_bytes` method can be used to instead output the raw /// bytes that should be encoded as a QR code. + /// + /// Returns a `QrCode`. #[wasm_bindgen(js_name = "toQrCode")] pub fn to_qr_code(&self) -> Result { Ok(self.inner.to_qr_code().map(Into::into)?) @@ -514,6 +516,9 @@ impl Qr { } /// Confirm that the other side has scanned our QR code. + /// + /// Returns either an `OutgoingRequest` which should be sent out, or + /// `undefined` if the verification is already confirmed. #[wasm_bindgen(js_name = "confirmScanning")] pub fn confirm_scanning(&self) -> Result { self.inner @@ -850,19 +855,19 @@ impl VerificationRequest { self.inner.cancel_info().map(Into::into) } - /// Has the verification request been answered by another device. + /// Has the verification request been answered by another device? #[wasm_bindgen(js_name = "isPassive")] pub fn is_passive(&self) -> bool { self.inner.is_passive() } - /// Is the verification request ready to start a verification flow. + /// Is the verification request ready to start a verification flow? #[wasm_bindgen(js_name = "isReady")] pub fn is_ready(&self) -> bool { self.inner.is_ready() } - /// Has the verification flow timed out. + /// Has the verification flow timed out? #[wasm_bindgen(js_name = "timedOut")] pub fn timed_out(&self) -> bool { self.inner.timed_out() @@ -904,34 +909,34 @@ impl VerificationRequest { .transpose() } - /// Get the unique ID of this verification request + /// Get the unique ID of this verification request. #[wasm_bindgen(getter, js_name = "flowId")] pub fn flow_id(&self) -> String { self.inner.flow_id().as_str().to_owned() } - /// Is this a verification that is veryfying one of our own - /// devices. + /// Is this a verification that is verifying one of our own + /// devices? #[wasm_bindgen(js_name = "isSelfVerification")] pub fn is_self_verification(&self) -> bool { self.inner.is_self_verification() } - /// Did we initiate the verification request. + /// Did we initiate the verification request? #[wasm_bindgen(js_name = "weStarted")] pub fn we_started(&self) -> bool { self.inner.we_started() } /// Has the verification flow that was started with this request - /// finished. + /// finished? #[wasm_bindgen(js_name = "isDone")] pub fn is_done(&self) -> bool { self.inner.is_done() } /// Has the verification flow that was started with this request - /// been cancelled. + /// been cancelled? #[wasm_bindgen(js_name = "isCancelled")] pub fn is_cancelled(&self) -> bool { self.inner.is_cancelled()