feat(element-call url params): split url params into configuration and properties (#5560)

This PR is part of an onging effort to move responsiblity to the EC app
and out of the EX apps.

4 intends (f.ex `join_existing` `start_new_dm`... ) (as url paramters)
are introduced in recent element call versions. Those intends behave
like defaults. If an intend is set a set of url parameters are
predefined.
Not all params can be covered by the intend (for insteance the
`widget_id` or the `host_url`).
This PR splits the url parameters into configuration (things that can be
configured by the intent) and properties (things that still need to be
passed one by one)


The goal with this change is that EX only needs to configre the intent
once and the EC codebase can update the behavior in those 4 specific
scenarios in case new features come along (auto hangup when other
participants leave, send call ring notification...)


Signed-off-by: Timo K <toger5@hotmail.de>

<!-- description of the changes in this PR -->

- [ ] Public API changes documented in changelogs (optional)

<!-- Sign-off, if not part of the commits -->
<!-- See CONTRIBUTING.md if you don't know what this is -->
Signed-off-by:

---------

Signed-off-by: Timo K <toger5@hotmail.de>

Author: toger5

bindings/matrix-sdk-ffi/src/widget.rs

@@ -125,9 +125,10 @@ pub async fn generate_webview_url(
 ///   call widget.
 #[matrix_sdk_ffi_macros::export]
 pub fn new_virtual_element_call_widget(
-    props: matrix_sdk::widget::VirtualElementCallWidgetOptions,
+    props: matrix_sdk::widget::VirtualElementCallWidgetProperties,
+    config: matrix_sdk::widget::VirtualElementCallWidgetConfig,
 ) -> Result<WidgetSettings, ParseError> {
-    Ok(matrix_sdk::widget::WidgetSettings::new_virtual_element_call_widget(props)
+    Ok(matrix_sdk::widget::WidgetSettings::new_virtual_element_call_widget(props, config)
         .map(|w| w.into())?)
 }
 

crates/matrix-sdk/CHANGELOG.md

@@ -84,6 +84,40 @@ All notable changes to this project will be documented in this file.
   ([#5431](https://github.com/matrix-org/matrix-rust-sdk/pull/5431))
 - [**breaking**] `Room::send_call_notification` and `Room::send_call_notification_if_needed` have been removed, since the event type they send is outdated, and `Client` is not actually supposed to be able to join MatrixRTC sessions (yet). In practice, users of these methods probably already rely on another MatrixRTC implementation to participate in sessions, and such an implementation should be capable of sending notifications itself.
   ([#5452](https://github.com/matrix-org/matrix-rust-sdk/pull/5452))
+- [**breaking**] The `new_virtual_element_call_widget` now uses a `props` and a `config` parameter instead of only `props`.
+  This splits the configuration of the widget into required properties ("widget_id", "parent_url"...) so the widget can work
+  and optional config parameters ("skip_lobby", "header", "...").
+  The config option should in most cases only provide the `"intent"` property.
+  All other config options will then be chosen by EC based on platform + `intent`.
+
+  Before:
+
+  ```rust
+  new_virtual_element_call_widget(
+    VirtualElementCallWidgetProperties {
+      widget_id: "my_widget_id", // required property
+      skip_lobby: Some(true), // optional configuration
+      preload: Some(true), // optional configuration
+      // ...
+    }
+  )
+  ```
+
+  Now:
+
+  ```rust
+  new_virtual_element_call_widget(
+    VirtualElementCallWidgetProperties {
+      widget_id: "my_widget_id", // required property
+      // ... only required properties
+    },
+    VirtualElementCallWidgetConfig {
+      intend: Intend.StartCallDM, // defines the default values for all other configuration
+      skip_lobby: Some(false), // overwrite a specific default value
+      ..VirtualElementCallWidgetConfig::default() // set all other config options to `None`. Use defaults from intent.
+    }
+  )
+  ```
 
 ### Bugfix
 

crates/matrix-sdk/src/widget/mod.rs

@@ -45,7 +45,8 @@ pub use self::{
     capabilities::{Capabilities, CapabilitiesProvider},
     filter::{Filter, MessageLikeEventFilter, StateEventFilter, ToDeviceEventFilter},
     settings::{
-        ClientProperties, EncryptionSystem, Intent, VirtualElementCallWidgetOptions, WidgetSettings,
+        ClientProperties, EncryptionSystem, Intent, VirtualElementCallWidgetConfig,
+        VirtualElementCallWidgetProperties, WidgetSettings,
     },
 };