Struct matrix_sdk::encryption::verification::VerificationRequest
source · [−]pub struct VerificationRequest { /* private fields */ }
e2e-encryption
only.Expand description
An object controlling the interactive verification flow.
Implementations
sourceimpl VerificationRequest
impl VerificationRequest
sourcepub fn is_cancelled(&self) -> bool
pub fn is_cancelled(&self) -> bool
Has the verification been cancelled.
sourcepub fn cancel_info(&self) -> Option<CancelInfo>
pub fn cancel_info(&self) -> Option<CancelInfo>
Get info about the cancellation if the verification request has been cancelled.
sourcepub fn own_user_id(&self) -> &UserId
pub fn own_user_id(&self) -> &UserId
Get our own user id.
sourcepub fn is_passive(&self) -> bool
pub fn is_passive(&self) -> bool
Has the verification request been answered by another device.
sourcepub fn we_started(&self) -> bool
pub fn we_started(&self) -> bool
Did we initiate the verification flow.
sourcepub fn other_user_id(&self) -> &UserId
pub fn other_user_id(&self) -> &UserId
Get the user id of the other user participating in this verification flow.
sourcepub fn is_self_verification(&self) -> bool
pub fn is_self_verification(&self) -> bool
Is this a verification that is veryfying one of our own devices.
sourcepub fn their_supported_methods(&self) -> Option<Vec<VerificationMethod>>
pub fn their_supported_methods(&self) -> Option<Vec<VerificationMethod>>
Get the supported verification methods of the other side.
Will be present only if the other side requested the verification or if we’re in the ready state.
sourcepub async fn accept(&self) -> Result<()>
pub async fn accept(&self) -> Result<()>
Accept the verification request.
This method will accept the request and signal by default that it
supports the m.sas.v1
, the m.qr_code.show.v1
, and m.reciprocate.v1
method. If the qrcode
feature is disabled it will only signal that it
supports the m.sas.v1
method.
If QR code scanning should be supported or QR code showing shouldn’t be
supported the accept_with_methods()
method should be used instead.
sourcepub async fn accept_with_methods(
&self,
methods: Vec<VerificationMethod>
) -> Result<()>
pub async fn accept_with_methods(
&self,
methods: Vec<VerificationMethod>
) -> Result<()>
Accept the verification request signaling that our client supports the given verification methods.
Arguments
methods
- The methods that we should advertise as supported by us.
sourcepub async fn generate_qr_code(&self) -> Result<Option<QrVerification>>
Available on crate feature qrcode
only.
pub async fn generate_qr_code(&self) -> Result<Option<QrVerification>>
qrcode
only.Generate a QR code
sourcepub async fn scan_qr_code(
&self,
data: QrVerificationData
) -> Result<Option<QrVerification>>
Available on crate feature qrcode
only.
pub async fn scan_qr_code(
&self,
data: QrVerificationData
) -> Result<Option<QrVerification>>
qrcode
only.Start a QR code verification by providing a scanned QR code for this verification flow.
Returns an Error
if the QR code isn’t valid or sending a reciprocate
event to the other side fails, None
if the verification request
isn’t in the ready state or we don’t support QR code verification,
otherwise a newly created QrVerification
object which will be used
for the remainder of the verification flow.
sourcepub async fn start_sas(&self) -> Result<Option<SasVerification>>
pub async fn start_sas(&self) -> Result<Option<SasVerification>>
Transition from this verification request into a SAS verification flow.
Trait Implementations
sourceimpl Clone for VerificationRequest
impl Clone for VerificationRequest
sourcefn clone(&self) -> VerificationRequest
fn clone(&self) -> VerificationRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for VerificationRequest
impl Send for VerificationRequest
impl Sync for VerificationRequest
impl Unpin for VerificationRequest
impl !UnwindSafe for VerificationRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more