Struct matrix_sdk_crypto::VerificationRequest

source · [−]

pub struct VerificationRequest { /* private fields */ }

Expand description

An object controlling key verification requests.

Interactive verification flows usually start with a verification request, this object lets you send and reply to such a verification request.

After the initial handshake the verification flow transitions into one of the verification methods.

Implementations

source

impl VerificationRequest

source

pub fn request(
 own_user_id: &UserId,
 own_device_id: &DeviceId,
 other_user_id: &UserId,
 methods: Option<Vec<VerificationMethod>>
) -> KeyVerificationRequestEventContent

Create an event content that can be sent as a room event to request verification from the other side. This should be used only for verifications of other users and it should be sent to a room we consider to be a DM with the other user.

source

pub fn own_user_id(&self) -> &UserId

Our own user id.

source

pub fn other_user(&self) -> &UserId

The id of the other user that is participating in this verification request.

source

pub fn other_device_id(&self) -> Option<OwnedDeviceId>

The id of the other device that is participating in this verification.

source

pub fn room_id(&self) -> Option<&RoomId>

Get the room id if the verification is happening inside a room.

source

pub fn cancel_info(&self) -> Option<CancelInfo>

Get info about the cancellation if the verification request has been cancelled.

source

pub fn is_passive(&self) -> bool

Has the verification request been answered by another device.

source

pub fn is_ready(&self) -> bool

Is the verification request ready to start a verification flow.

source

pub fn timed_out(&self) -> bool

Has the verification flow timed out.

source

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.

source

pub fn our_supported_methods(&self) -> Option<Vec<VerificationMethod>>

Get our own supported verification methods that we advertised.

Will be present only we requested the verification or if we’re in the ready state.

source

pub fn flow_id(&self) -> &FlowId

Get the unique ID of this verification request

source

pub fn is_self_verification(&self) -> bool

Is this a verification that is veryfying one of our own devices

source

pub fn we_started(&self) -> bool

Did we initiate the verification request

source

pub fn is_done(&self) -> bool

Has the verification flow that was started with this request finished.

source

pub fn is_cancelled(&self) -> bool

Has the verification flow that was started with this request been cancelled.

source

pub fn accept_with_methods(
&self,
methods: Vec<VerificationMethod>
) -> Option<OutgoingVerificationRequest>

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.

source

pub fn accept(&self) -> Option<OutgoingVerificationRequest>

Accept the verification request.

This method will accept the request and signal that it supports the m.sas.v1, the m.qr_code.show.v1, and m.reciprocate.v1 method.

m.qr_code.show.v1 will only be signaled if the qrcode feature is enabled. This feature is disabled by default. If it’s enabled and QR code scanning should be supported or QR code showing shouldn’t be supported the accept_with_methods() method should be used instead.

source