From 2b35962c199189656e6aa8b732bebdbec146d634 Mon Sep 17 00:00:00 2001 From: Timo K Date: Thu, 22 Feb 2024 16:10:58 +0100 Subject: [PATCH] review Signed-off-by: Timo K --- docs/url-params.md | 52 +++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/url-params.md b/docs/url-params.md index bcda6fbd..4a22359a 100644 --- a/docs/url-params.md +++ b/docs/url-params.md @@ -38,7 +38,7 @@ The id used by the widget. The presence of this parameter implies that element call will not connect to a homeserver directly and instead tries to establish postMessage communication via the `parentUrl`. -```js +```ts widgetId: string | null; ``` @@ -49,28 +49,28 @@ in an Iframe but in a dedicated webview we send the postMessages same webview the widget lives in. Filtering is done in the widget so it ignores the messages it receives from itself) -```js +```ts parentUrl: string | null; ``` **userId** The user's ID (only used in matryoshka mode). -```js +```ts userId: string | null; ``` **deviceId** The device's ID (only used in matryoshka mode). -```js +```ts deviceId: string | null; ``` **baseUrl** The base URL of the homeserver to use for media lookups in matryoshka mode. -```js +```ts baseUrl: string | null; ``` @@ -83,14 +83,14 @@ roomId is an exception as we need the room ID in embedded (matroyska) mode, and the room alias (or even the via params because we are not trying to join it). This is also not validated, where it is in useRoomIdentifier(). -```js +```ts roomId: string | null; ``` **confineToRoom** Whether the app should keep the user confined to the current call/room. -```js +```ts confineToRoom: boolean; (default: false) ``` @@ -98,7 +98,7 @@ confineToRoom: boolean; (default: false) Whether upon entering a room, the user should be prompted to launch the native mobile app. (Affects only Android and iOS.) -```js +```ts appPrompt: boolean; (default: true) ``` @@ -106,14 +106,14 @@ appPrompt: boolean; (default: true) Whether the app should pause before joining the call until it sees an io.element.join widget action, allowing it to be preloaded. -```js +```ts preload: boolean; (default: false) ``` **hideHeader** Whether to hide the room header when in a call. -```js +```ts hideHeader: boolean; (default: false) ``` @@ -121,14 +121,14 @@ hideHeader: boolean; (default: false) Whether to show the buttons to mute, screen-share, invite, hangup are shown when in a call. -```js +```ts showControls: boolean; (default: true) ``` **hideScreensharing** Whether to hide the screen-sharing button. -```js +```ts hideScreensharing: boolean; (default: false) ``` @@ -136,7 +136,7 @@ hideScreensharing: boolean; (default: false) Whether to use end-to-end encryption. This is a legacy flag for the full mesh branch. It is not used on the livekit branch and has no impact there! -```js +```ts enableE2EE: boolean; (default: true) ``` @@ -144,7 +144,7 @@ enableE2EE: boolean; (default: true) Whether to use per participant encryption. Keys will be exchanged over encrypted matrix room messages. -```js +```ts perParticipantE2EE: boolean; (default: false) ``` @@ -152,21 +152,21 @@ perParticipantE2EE: boolean; (default: false) E2EE password when using a shared secret. (For individual sender keys in embedded mode this is not required.) -```js +```ts password: string | null; ``` **displayName** The display name to use for auto-registration. -```js +```ts displayName: string | null; ``` **lang** The BCP 47 code of the language the app should use. -```js +```ts lang: string | null; ``` @@ -174,7 +174,7 @@ lang: string | null; The font/fonts which the interface should use. There can be multiple font url parameters: `?font=font-one&font=font-two...` -```js +```ts font: string; font: string; ... @@ -183,7 +183,7 @@ font: string; **fontScale** The factor by which to scale the interface's font size. -```js +```ts fontScale: number | null; ``` @@ -191,7 +191,7 @@ fontScale: number | null; The Posthog analytics ID. It is only available if the user has given consent for sharing telemetry in element web. -```js +```ts analyticsID: string | null; ``` @@ -199,7 +199,7 @@ analyticsID: string | null; Whether the app is allowed to use fallback STUN servers for ICE in case the user's homeserver doesn't provide any. -```js +```ts allowIceFallback: boolean; (default: false) ``` @@ -208,7 +208,7 @@ Setting this flag skips the lobby and brings you in the call directly. In the widget this can be combined with preload to pass the device settings with the join widget action. -```js +```ts skipLobby: boolean; (default: false) ``` @@ -218,7 +218,7 @@ a call. This is useful for video rooms. If set to false, the widget will show a blank page after leaving the call. -```js +```ts returnToLobby: boolean; (default: false) ``` @@ -227,7 +227,7 @@ The theme to use for element call. can be "light", "dark", "light-high-contrast" or "dark-high-contrast". If not set element call will use the dark theme. -```js +```ts theme: string | null; ``` @@ -237,7 +237,7 @@ It has to be set to a non default value for links to rooms that are not on the default homeserver, that is in use for the current user. -```js +```ts viaServers: string; (default: undefined) ``` @@ -247,6 +247,6 @@ a new (guest) user. This can be user to configure a non default guest user server when creating a spa link. -```js +```ts homeserver: string; (default: undefined) ```