Struct matrix_sdk::widget::VirtualElementCallWidgetOptions

pub struct VirtualElementCallWidgetOptions {
    pub element_call_url: String,
    pub widget_id: String,
    pub parent_url: Option<String>,
    pub hide_header: Option<bool>,
    pub preload: Option<bool>,
    pub font_scale: Option<f64>,
    pub app_prompt: Option<bool>,
    pub skip_lobby: Option<bool>,
    pub confine_to_room: Option<bool>,
    pub font: Option<String>,
    pub analytics_id: Option<String>,
    pub encryption: EncryptionSystem,
}

Available on crate feature experimental-widgets only.

Properties to create a new virtual Element Call widget.

Fields

element_call_url: String

The url to the app.

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

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.

hide_header: Option<bool>

Whether the branding header of Element call should be hidden.

Default: true

preload: Option<bool>

If set, the lobby will be skipped and the widget will join the call on the io.element.join action.

Default: false

font_scale: Option<f64>

The font scale which will be used inside element call.

Default: 1

app_prompt: Option<bool>

Whether element call should prompt the user to open in the browser or the app.

Default: false

skip_lobby: Option<bool>

Don’t show the lobby and join the call immediately.

Default: false

confine_to_room: Option<bool>

Make it not possible to get to the calls list in the webview.

Default: true

font: Option<String>

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

analytics_id: Option<String>

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

encryption: EncryptionSystem

The encryption system to use.

Use EncryptionSystem::Unencrypted to disable encryption.

Trait Implementations

impl Debug for VirtualElementCallWidgetOptions

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

Formats the value using the given formatter.