Struct VirtualElementCallWidgetProperties

pub struct VirtualElementCallWidgetProperties {
    pub element_call_url: String,
    pub widget_id: String,
    pub parent_url: Option<String>,
    pub font_scale: Option<f64>,
    pub font: Option<String>,
    pub encryption: EncryptionSystem,
    pub posthog_user_id: Option<String>,
    pub posthog_api_host: Option<String>,
    pub posthog_api_key: Option<String>,
    pub rageshake_submit_url: Option<String>,
    pub sentry_dsn: Option<String>,
    pub sentry_environment: Option<String>,
}

Available on crate feature experimental-widgets only.

Properties to create a new virtual Element Call widget.

All these are required to start the widget in the first place. This is different from the VirtualElementCallWidgetConfiguration which configures the widgets behavior.

Fields

element_call_url: String

The url to the app.

E.g. https://call.element.io, https://call.element.dev, https://call.element.dev/room

widget_id: String

The widget id.

parent_url: Option<String>

The url that is used as the target for the PostMessages sent by the widget (to the client).

For a web app client this is the client url. In case of using other platforms the client most likely is setup up to listen to postmessages in the same webview the widget is hosted. In this case the parent_url is set to the url of the webview with the widget. Be aware that this means that the widget will receive its own postmessage messages. The matrix-widget-api (js) ignores those so this works but it might break custom implementations.

Defaults to element_call_url for the non-iframe (dedicated webview) usecase.

font_scale: Option<f64>

The font scale which will be used inside element call.

Default: 1

font: Option<String>

The font to use, to adapt to the system font.

encryption: EncryptionSystem

The encryption system to use.

Use EncryptionSystem::Unencrypted to disable encryption.

posthog_user_id: Option<String>

Can be used to pass a PostHog id to element call.

posthog_api_host: Option<String>

The host of the posthog api. This is only used by the embedded package of Element Call.

posthog_api_key: Option<String>

The key for the posthog api. This is only used by the embedded package of Element Call.

rageshake_submit_url: Option<String>

The url to use for submitting rageshakes. This is only used by the embedded package of Element Call.

sentry_dsn: Option<String>

Sentry DSN This is only used by the embedded package of Element Call.

sentry_environment: Option<String>

Sentry environment This is only used by the embedded package of Element Call.

Trait Implementations

impl Clone for VirtualElementCallWidgetProperties

fn clone(&self) -> VirtualElementCallWidgetProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for VirtualElementCallWidgetProperties

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for VirtualElementCallWidgetProperties

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

Formats the value using the given formatter.

impl Default for VirtualElementCallWidgetProperties

fn default() -> VirtualElementCallWidgetProperties

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for VirtualElementCallWidgetProperties

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for VirtualElementCallWidgetProperties

type FfiType = <VirtualElementCallWidgetProperties as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for VirtualElementCallWidgetProperties

type LiftType = VirtualElementCallWidgetProperties

impl<UT> LiftReturn<UT> for VirtualElementCallWidgetProperties

type ReturnType = <VirtualElementCallWidgetProperties as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for VirtualElementCallWidgetProperties

type FfiType = <VirtualElementCallWidgetProperties as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for VirtualElementCallWidgetProperties

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for VirtualElementCallWidgetProperties

type ReturnType = <VirtualElementCallWidgetProperties as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl<UT> TypeId<UT> for VirtualElementCallWidgetProperties

const TYPE_ID_META: MetadataBuffer