Cookie usage
This page provides comprehensive details on variables stored in the browser by web app, including both local storage variables and session storage variables.
Web app cookie usage
Serial no. | Variable name | Description/use |
---|---|---|
1 | JWT | It securely stores the JWT token for each active user session within the web app portal: save it upon successful user sign-in. |
2 | ACTIVE_CALL _INFO |
It captures and retains call information when a participant joins a call, encompassing essential parameters, such as
This variable is destroyed as soon as the participant leaves the call. It is unique for every call. |
3 | LAST_SELECTED_LAYOUT | This variable serves as a storage for the participant's last chosen layout. Web app has an automatic layout switching functionality based on the user's network health status to enhance the overall user experience. In instances of network improvement, the stored information in this variable is used for selecting the user's previously selected layout. |
4 | MEDIA_STATISTICS_HEALTH_STATUS | This variable is used to save the resulting media status from calculations based on real-time media statistics. This health status is then used for automatic layout switching based on the participant's network conditions. |
5 | MIRRORED_SELF_VIEWS | If a user selects mirrored self-view during the call, this variable is used to retain that user-preferred information to use it for upcoming future calls. This variable is stored if the user has selected mirrored self-view along with camera ID, which was being used for that call. |
6 | MEDIA_RECONNECT_IN_PROGRESS |
With the introduction of a new feature in the web app, we now implement retry attempts for call connection when a user faces disconnection due to a poor network. Throughout these retry attempts, a specific variable is employed to determine whether the reconnection is still in progress, signalling participants to remain on the call page.
This variable is cleared upon the participant exiting the call. |
7 | OPTIMISE_FOR_TEXT | Users have the option to optimise text during presentations in case of network issues or low bandwidth. This feature is accessible in the user's self-view settings menu. This variable OPTIMISE_FOR_TEXT retains the user's selection (true/false), which will be used for future calls involving that participant. |
8 | PINNED_PRESENTATION_PREVIEW | Upon initiating screen sharing, participants are presented with a presentation preview pane with the option to pin or unpin it. This variable is used to store the participant's preference for pinning or unpinning, to use the same choice for future calls. |
9 | PINNED_SELF_VIEW | Similar to PINNED_PRESENTATION_PREVIEW, the variable PINNED_SELF_VIEW is used to store the participant's preference for pin/unpin for the self-view preview pane and to use it for future calls. |
10 | PINNED_SPEAKING_INDICATOR | This variable is used to store the participant's preference for pin/unpin for the speaking indicator and to use it for future calls. |
11 | PREVIOUSLY_INVITED_PARTICIPANTS_WITH_AVATARS | We have an 'Add participant' option in the call's right-side pane. This variable is used for storing information about invited participants using the Add participant button. Later, these variable details are displayed in the participant pane under the 'Invited' section. It includes parameters such as the participant's URI and avatar. |
12 | SELECTED_PARTICIPANT_GUID_TO_SEND_CHAT_MESSAGE | This variable is used to retain the GUID that the participant selected for private chat messaging. Within the chat pane, users can choose a specific participant to send private messages to, and this selection is stored. Even if a participant navigates away from the chat pane and returns later, the last selected participant remains set for messaging from the participant's drop-down. Upon a participant exiting the call, this variable is cleared. |
13 | CAPTION_LANGUAGE_SELECTED | This variable is used to store the participant's preferred language for sending closed captions during the call and it is cleared once the participant leaves the call. |
14 | MEETING_NOTES_STORE | Within the Notes pane during a call, participants can write notes and navigate away without saving, sending or discarding them. This variable is used to store such draft notes, allowing participants to edit the same draft upon returning to the Notes pane without losing data. The variable is destroyed upon the participant leaving the call, and its data is also cleared when the participant chooses to discard, save or send the notes. |
15 | RESPONSE_SUBMITTED_SURVEY_ID | This variable serves the purpose of storing the survey ID for which a participant has already submitted a response. It ensures that participants are prevented from retaking the same survey, as each participant is only allowed to submit responses for a particular survey once. |
16 | DISPLAY_NAME | This variable is used to show the name provided by a guest participant upon joining the call, if they join without signing in. |
17 | ELTANIN_PORT | This variable stores Meeting App's port number configured by admin/user using MMP commands in Meeting Server. |
18 | ELTANIN_ADDRESS | This variable stores Meeting App's IP address configured by admin/user using MMP commands in Meeting Server. |
19 | ELTANIN_JWT | This variable is required for Meeting App's authentication for the active session. It stores the Meeting App JWT for the user session and is created when authentication is successful and receives a response from Meeting App. |
20 | ELTANIN_JWT_ID | This variable stores Meeting App's JWT ID, it is similar to ELTANIN_JWT. |
21 | INVITATION_LANGUAGE | Web app space pages have a Share invitation option where we support multiple languages. This variable preserves the user's chosen language for sharing invitations, and the same preference is automatically selected for future use. |
22 | FECC_CAMERA_CONTROLS_POSITION | This variable retains the user's chosen position preference for the FECC (Far End Camera Control) camera controls pane. The same preference is applied for future calls unless the user decides to change it again. |
23 | PREVIOUSLY_INVITED_PARTICIPANTS | This variable is designed for the same purpose as PREVIOUSLY_INVITED_PARTICIPANTS_WITH_AVATARS, but for older releases (e.g. 2.9 or 3.0), it only stores participant URIs without avatars. |
24 | SELF_VIEW_SNAP_POSITION | This variable retains the user's chosen position preference for the self-view pane. The same preference is applied for future calls unless the user decides to change it again. |
25 | PRESENTATION_PREVIEW_SNAP_POSITION | This variable retains the user's chosen position preference for the presentation preview pane. The same preference is applied for future calls unless the user decides to change it again. |
26 | PRESENTATION_RESTRICT_MODE | This variable stores the value received from the CMS in the configuration API for the 'contentResolution' parameter. The available values for this parameter are unrestricted, max720p and max1080p, and can be individually configured in the CMS API for web bridge profiles. The stored value in this variable is then used to establish the presentation resolution for content shared by participants in each call conducted on that web bridge. |
27 | ADMIN_CENTRIC | This variable is employed to manage background change options, specifically distinguishing between admin-centric images uploaded using branding on the CMS via MMP and default images stored by the web app. If the admin-centric image option is set and images have been uploaded, this variable stores the relevant information. Additionally, it serves as a boolean indicator, helping determine whether images have been uploaded. The same variable is utilised to dynamically display either static images or admin-uploaded images in the self-view pane. |
28 | BACKGROUND_IMAGE | This variable stores the name of the user's selected background image during the call. As a result, when the user navigates away or closes the self-view pane and returns, the last chosen image is highlighted. |
29 | BLUR_INTENSITY | This variable retains the user's chosen blur intensity set during the call. Consequently, when the user navigates away or closes the self-view pane and returns, the last configured blur intensity is displayed. |
30 | BLUR_MODE | This variable stores the user's selected blur mode (blur, none, background images) during the call. As a result, when the user navigates away or closes the self-view pane and returns, the last chosen image is highlighted. |
31 | HD_MODE | The web app provides an HD mode selection option under the self-view pane, and this variable stores the user's preferred choice. This preference is applied to the user's self-video in future calls. |
32 | SELECTED_CAMERA | This variable stores the selected camera device ID when the user chooses a device from the 'Select camera' options under the settings menu of the self-view pane. This selection can occur either from the Join call page or during the call. The data stored in this variable facilitates passing the selected option from the Join call page to the In-call page to ensure that the user's preferred camera device is set. Additionally, this preferred device will be automatically chosen for all future calls as long as it remains available. |
33 | SELECTED_MICROPHONE | Similar to SELECTED_CAMERA, this variable stores the selected microphone device ID (audio input device ID). |
34 | SELECTED_SPEAKER | Similar to SELECTED_CAMERA, this variable stores the selected speaker device ID (audio output device ID). |
Serial no. | Variable name | Description/use |
---|---|---|
1 | SESSION_TOKEN | This variable holds the session token value upon a successful sign-in to the web app. It is cleared when the user signs out from the web app. |
2 | MICROPHONE_MUTE | During a call, participants can toggle their microphone device between mute and unmute. This variable stores the boolean value representing the mute/unmute status of the microphone, and the same value is applied for future calls. |
3 | CAMERA_MUTE | During a call, participants can toggle their camera device between mute and unmute. This variable stores the boolean value representing the mute/unmute status of the camera, and the same value is applied for future calls. |
4 | CAMERA_MUTED_FORCEFULLY | This variable stores the boolean value if the camera is muted forcefully by another participant during the call (mute option on the other participant's video) or in studio mode. |
5 | CURRENT_SSO_LOGIN_ATTEMPT_USER | This variable retains the username when a user attempts to sign in as a Single Sign-On (SSO) user. It is instrumental in authenticating the user for SSO purposes. The variable is removed upon successful sign-in or when the user closes the Sign-in page. |
6 | CURRENT_SSO_LOGIN_ATTEMPT_MEETING | This variable holds essential data, such as join parameters and URLs, primarily intended for non-member participants attempting Single Sign-On (SSO) sign-in from the Join call page. These details play a crucial role in redirecting and facilitating SSO login during meeting entry. The variable is cleared either when transitioning to the Sign-in page from the Join call page or upon closing the Join call page. |