Struct VirtualElementCallWidgetConfig

pub struct VirtualElementCallWidgetConfig {
    pub intent: Option<Intent>,
    pub skip_lobby: Option<bool>,
    pub header: Option<HeaderStyle>,
    pub hide_header: Option<bool>,
    pub preload: Option<bool>,
    pub app_prompt: Option<bool>,
    pub confine_to_room: Option<bool>,
    pub hide_screensharing: Option<bool>,
    pub controlled_audio_devices: Option<bool>,
    pub send_notification_type: Option<NotificationType>,
}

Available on crate feature experimental-widgets only.

Configuration parameters, to create a new virtual Element Call widget.

If intent is provided the appropriate default values for all other parameters will be used by element call. In most cases its enough to only set the intent. Use the other properties only if you want to deviate from the intent defaults.

Set docs/url-params.md to find out more about the parameters and their defaults.

Fields

intent: Option<Intent>

The intent of showing the call. If the user wants to start a call or join an existing one. Controls if the lobby is skipped or not.

skip_lobby: Option<bool>

Skip the lobby when joining a call.

header: Option<HeaderStyle>

Whether the branding header of Element call should be shown or if a mobile header navbar should be render.

Default: [HeaderStyle::Standard]

hide_header: Option<bool>

👎Deprecated since 0.12.1: Use header instead

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

app_prompt: Option<bool>

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

Default: false

confine_to_room: Option<bool>

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

Default: true

hide_screensharing: Option<bool>

Do not show the screenshare button.

controlled_audio_devices: Option<bool>

Make the audio devices be controlled by the os instead of the element-call webview.

send_notification_type: Option<NotificationType>

Whether and what type of notification Element Call should send, when starting a call.

Trait Implementations

impl Clone for VirtualElementCallWidgetConfig

fn clone(&self) -> VirtualElementCallWidgetConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for VirtualElementCallWidgetConfig

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

impl Debug for VirtualElementCallWidgetConfig

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

Formats the value using the given formatter.

impl Default for VirtualElementCallWidgetConfig

fn default() -> VirtualElementCallWidgetConfig

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for VirtualElementCallWidgetConfig

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 VirtualElementCallWidgetConfig

type FfiType = <VirtualElementCallWidgetConfig 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 VirtualElementCallWidgetConfig

type LiftType = VirtualElementCallWidgetConfig

impl<UT> LiftReturn<UT> for VirtualElementCallWidgetConfig

type ReturnType = <VirtualElementCallWidgetConfig 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 VirtualElementCallWidgetConfig

type FfiType = <VirtualElementCallWidgetConfig 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 VirtualElementCallWidgetConfig

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for VirtualElementCallWidgetConfig

type ReturnType = <VirtualElementCallWidgetConfig 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 VirtualElementCallWidgetConfig

const TYPE_ID_META: MetadataBuffer