Skip to content

Commit fd2c1f6

Browse files
authored
Clarify who is responsible for compliance and consent in relation to analytics (#3116)
It varies depending on if you are using the full or embedded package.
1 parent 1be0733 commit fd2c1f6

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/embedded-standalone.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
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:
44

5-
| | Full Package | Embedded Package |
6-
| ------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------- |
7-
| **Supports use as standalone** |||
8-
| **Supports use as widget** |||
9-
| **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 |
10-
| **Release artifacts** | Docker Image, Tarball | Tarball, NPM for Web, Android AAR, SwiftPM for iOS |
11-
| **Recommended for** | Standalone/guest access usage | Embedding within messenger apps |
5+
| | Full Package | Embedded Package |
6+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| **Supports use as standalone** |||
8+
| **Supports use as widget** |||
9+
| **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 |
10+
| **Release artifacts** | Docker Image, Tarball | Tarball, NPM for Web, Android AAR, SwiftPM for iOS |
11+
| **Recommended for** | Standalone/guest access usage | Embedding within messenger apps |
12+
| **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 |
13+
| **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](./url-params.md#embedded-only-parameters) if consent has been granted. |
14+
| **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 |
1215

1316
For examples of how to use the platform specific release artifacts (e.g. Android AAR) see
1417
the Element Messenger apps for: [Web](https://github.com/element-hq/element-web), [iOS](https://github.com/element-hq/element-x-ios) and [Android](https://github.com/element-hq/element-x-android).

0 commit comments

Comments
 (0)