Struct IdentityVerification

#[repr(transparent)]
pub struct IdentityVerification {
    inner: TypedObjectRef<IdentityVerification, ()>,
    phantom: PhantomData<()>,
}

An identity verification request.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<IdentityVerification, ()>

phantom: PhantomData<()>

Implementations

impl IdentityVerification

pub fn user(&self) -> <BoundConstructOnlyObject<User> as Property>::Value

pub fn room(&self) -> <WeakRef<Room> as Property>::Value

pub fn state(&self) -> <Cell<VerificationState> as Property>::Value

pub fn was_accepted(&self) -> <Cell<bool> as Property>::Value

pub fn is_finished(&self) -> <PhantomData<bool> as Property>::Value

pub fn supported_methods( &self, ) -> <VerificationSupportedMethods as Property>::Value

pub fn flow_id(&self) -> <PhantomData<String> as Property>::Value

pub fn received_time(&self) -> <OnceCell<DateTime> as Property>::Value

pub fn display_name(&self) -> <PhantomData<String> as Property>::Value

pub fn camera_paintable( &self, ) -> <RefCell<Option<Paintable>> as Property>::Value

pub fn was_viewed(&self) -> <Cell<bool> as Property>::Value

pub fn set_was_viewed<'a>( &self, value: impl Borrow<<<Cell<bool> as Property>::Value as HasParamSpec>::SetValue>, )

pub fn connect_request_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_user_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_room_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_state_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_was_accepted_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_is_finished_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_supported_methods_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_flow_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_received_time_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_display_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_camera_paintable_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_was_viewed_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn notify_request(&self)

pub fn notify_user(&self)

pub fn notify_room(&self)

pub fn notify_state(&self)

pub fn notify_was_accepted(&self)

pub fn notify_is_finished(&self)

pub fn notify_supported_methods(&self)

pub fn notify_flow_id(&self)

pub fn notify_received_time(&self)

pub fn notify_display_name(&self)

pub fn notify_camera_paintable(&self)

pub fn notify_was_viewed(&self)

impl IdentityVerification

pub async fn new( request: VerificationRequest, user: &User, room: Option<&Room>, ) -> Self

Construct a verification for the given request.

pub fn session(&self) -> Session

The current session.

fn request(&self) -> &VerificationRequest

The SDK’s verification request.

pub fn key(&self) -> VerificationKey

The unique identifying key of this verification.

pub fn is_self_verification(&self) -> bool

Whether this is a self-verification.

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

The ID of the other device that is being verified.

fn set_was_accepted(&self, was_accepted: bool)

Set whether this request was accepted.

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

Information about the verification cancellation, if any.

async fn init(&self)

Initialize this verification to listen to changes in the request’s state.

async fn handle_request_state(&self, state: VerificationRequestState)

Handle a change in the request’s state.

fn handle_cancelled_state(&self, cancel_info: CancelInfo)

Handle when the request was cancelled.

pub async fn cancel(&self) -> Result<(), Error>

Cancel the verification request.

This can be used to decline the request or cancel it at any time.

pub async fn accept(&self) -> Result<(), ()>

Accept the verification request.

fn set_supported_methods(&self, supported_methods: Vec<VerificationMethod>)

Set the supported methods of this verification.

pub fn choose_method(&self)

Go back to the state to choose a verification method.

async fn set_verification(&self, verification: Verification)

Set the SDK’s Verification.

fn handle_qr_verification_state(&self, state: QrVerificationState)

Handle a change in the QR verification’s state.

fn qr_verification(&self) -> Option<QrVerification>

The SDK’s QR verification, if one was started.

async fn handle_sas_verification_state(&self, state: SasState)

Handle a change in the SAS verification’s state.

fn sas_verification(&self) -> Option<SasVerification>

The SDK’s SAS verification, if one was started.

pub fn sas_supports_emoji(&self) -> bool

Whether the current SAS verification supports emoji.

pub fn sas_emoji(&self) -> Option<[Emoji; 7]>

The list of emojis for the current SAS verification, if any.

pub fn sas_decimals(&self) -> Option<(u16, u16, u16)>

The list of decimals for the current SAS verification, if any.

async fn load_qr_code(&self) -> bool

Try to load the QR Code.

Return true if it was successfully loaded, false otherwise.

pub fn qr_code(&self) -> Option<QrCode>

The QR Code, if the QrCodeShowV1 method is supported.

pub fn has_qr_code(&self) -> bool

Whether we have the QR code.

pub async fn start_qr_code_scan(&self) -> Result<(), ()>

Start a QR Code scan.

pub async fn qr_code_scanned(&self, data: QrVerificationData) -> Result<(), ()>

The QR Code was scanned.

pub async fn confirm_qr_code_scanned(&self) -> Result<(), ()>

Confirm that the QR Code was scanned by the other party.

pub async fn start_sas(&self) -> Result<(), ()>

Start a SAS verification.

pub async fn sas_mismatch(&self) -> Result<(), ()>

The SAS data does not match.

pub async fn sas_match(&self) -> Result<(), ()>

The SAS data matches.

pub async fn restart(&self) -> Result<Self, ()>

Restart this verification with a new one to the same user.

pub fn dismiss(&self)

The verification can be dismissed.

Also removes it from the verification list.

pub fn remove_from_list(&self)

The verification can be removed from the verification list.

You will usually want to use IdentityVerification::dismiss() because the interface listens for the signal it emits, and it calls this method internally.

pub fn connect_sas_data_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the SAS data changed.

pub fn connect_cancel_info_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the cancel info changed.

pub fn connect_replaced<F: Fn(&Self, &Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the verification has been replaced.

The second parameter to the function is the new verification.

pub fn connect_done<F: Fn(&Self) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the verification is done, but its state does not reflect that yet.

Return glib::Propagation::Stop in the signal handler to prevent the state from changing to VerificationState::Done. Can be used to replace the last screen of IdentityVerificationView.

pub fn connect_dismiss<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Connect to the signal emitted when the verification can be dismissed.

pub(super) fn connect_remove_from_list<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the verification can be removed from the verification list.

Trait Implementations

impl Clone for IdentityVerification

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IdentityVerification

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for IdentityVerification

type ParamSpec = ParamSpecObject

type SetValue = IdentityVerification

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, IdentityVerification>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IdentityVerification

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for IdentityVerification

type Subclass = IdentityVerification

impl Ord for IdentityVerification

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for IdentityVerification

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for IdentityVerification

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for IdentityVerification

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for IdentityVerification

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IdentityVerification