Struct matrix_sdk::widget::WidgetSettings

pub struct WidgetSettings { /* private fields */ }

Available on crate feature experimental-widgets only.

Settings of the widget.

Implementations

impl WidgetSettings

pub fn new_virtual_element_call_widget( props: VirtualElementCallWidgetOptions ) -> Result<Self, ParseError>

WidgetSettings are usually created from a state event. (currently unimplemented)

In some cases the client wants to create custom WidgetSettings for specific rooms based on other conditions. This function returns a WidgetSettings object which can be used to setup a widget using run_client_widget_api and to generate the correct url for the widget.

Arguments

• • props A struct containing the configuration parameters for a element call widget.

impl WidgetSettings

pub fn new( id: String, init_on_content_load: bool, raw_url: &str ) -> Result<Self, ParseError>

Create a new WidgetSettings instance

pub fn widget_id(&self) -> &str

Widget’s unique identifier.

pub fn init_on_content_load(&self) -> bool

Whether or not the widget should be initialized on load message (ContentLoad message), or upon creation/attaching of the widget to the SDK’s state machine that drives the API.

pub fn raw_url(&self) -> &Url

This contains the url from the widget state event. In this url placeholders can be used to pass information from the client to the widget. Possible values are: $matrix_widget_id, $matrix_display_name, etc.

Examples

http://widget.domain?username=$userId will become http://widget.domain?username=@user_matrix_id:server.domain.

pub fn base_url(&self) -> Option<Url>

Get the base url of the widget. Used as the target for PostMessages. In case the widget is in a webview and not an IFrame. It contains the schema and the authority e.g. https://my.domain.org. A postmessage would be sent using: postMessage(myMessage, widget_base_url).

pub async fn generate_webview_url( &self, room: &Room, props: ClientProperties ) -> Result<Url, ParseError>

Create the actual Url that can be used to setup the WebView or IFrame that contains the widget.

Arguments

• room - A matrix room which is used to query the logged in username
• props - Properties from the client that can be used by a widget to adapt to the client. e.g. language, font-scale…

Trait Implementations

impl Clone for WidgetSettings

fn clone(&self) -> WidgetSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetSettings

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

Formats the value using the given formatter.