Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 6.39 KB

embedded-standalone.md

File metadata and controls

39 lines (27 loc) · 6.39 KB

Element Call packages

Element Call is available as two different packages: Full Package and Embedded Package.

The Full Package is designed for standalone use, while the Embedded Package is designed for widget mode only.

The table below provides a comparison of the two packages:

Full Package Embedded Package
Supports use as standalone ✅ ❌
Supports use as widget ✅ ✅
Deployment mode Hosted as a static web page and accessed via a URL when used as a widget Bundled within a messenger app for seamless integration
Release artifacts Docker Image, Tarball Tarball, NPM for Web, Android AAR, SwiftPM for iOS
Recommended for Standalone/guest access usage Embedding within messenger apps
Responsibility for regulatory compliance The administrator that is deploying the app is responsible for compliance with any applicable regulations (e.g. privacy) The developer of the messenger app is responsible for compliance
Analytics consent Element Call will show a consent UI. Element Call will not show a consent UI. The messenger app should only provide the embedded Element Call with the analytics URL parameters if consent has been granted.
Analytics data Element Call will send data to the Posthog, Sentry and Open Telemetry targets specified by the administrator in the config.json Element Call will send data to the Posthog and Sentry targets specified in the URL parameters by the messenger app

Using the embedded package within a messenger app

Currently the best way to understand the necessary steps is to look at the implementations in the Element Messenger apps: Web, iOS and Android.

The basics are:

  1. Add the appropriate platform dependency as given for a release, or use the embedded tarball. e.g. npm install @element-hq/[email protected]
  2. Include the assets from the platform dependency in the build process. e.g. copy the assets during a Webpack build.
  3. Use the index.html entrypointof the imported assets when you are constructing the WebView or iframe. e.g. using a relative path in a webapp, or on the the Android WebViewAssetLoader
  4. Set any of the embedded-only URL parameters that you need.

Widget vs standalone mode

Element Call is developed using the js-sdk with matroska mode. This means the app can run either as a standalone app directly connected to a homeserver providing login interfaces or it can be used as a widget within a Matrix client.

As a widget, the app only uses the core calling (MatrixRTC) parts. The rest (authentication, sending events, getting room state updates about calls) is done by the hosting client. Element Call and the hosting client are connected via the widget API.

Element Call detects that it is run as a widget if a widgetId is defined in the url parameters. If widgetId is present then Element Call will try to connect to the client via the widget postMessage API using the parameters provided in Url Format and parameters .