From c1a2d4aef2b773d272092e6f26f1d3c0426e9431 Mon Sep 17 00:00:00 2001 From: BillCarsonFr Date: Mon, 27 May 2024 14:03:01 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20matrix-o?= =?UTF-8?q?rg/matrix-analytics-events@53b2e899332ee609f40f5202354fd587b677?= =?UTF-8?q?0336=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 2690 +++++++++++++++++++++++++++------------------------- 1 file changed, 1372 insertions(+), 1318 deletions(-) diff --git a/index.html b/index.html index 027240e..1f804b3 100644 --- a/index.html +++ b/index.html @@ -33,8 +33,8 @@

Analytics events for Element clients

-

Composer

-

Triggered when the user sends a message via the composer.

+

Error

+

Triggered when an error occurred.

@@ -46,69 +46,85 @@

Composer

- - - - - - - - + + - - + + - - + + + + + + + + - - + + + + + + + + - -
inThreadWhether the user was using the composer inside of a thread. - - boolean - -
isEditingWhether the user's composer interaction was editing a previously sent event.contextContext - client defined, can be used for debugging. - boolean + string
isReplyWhether the user's composer interaction was a reply to a previously sent event.cryptoModuleDEPRECATED: Which crypto module is the client currently using. - - boolean + +
    + +
  • + + Native: Native / legacy crypto module specific to each platform. + +
    • + +
  • + + Rust: Shared / cross-platform crypto module written in Rust. + +
    • + +
messageTypeThe type of the message.cryptoSDKWhich crypto backend is the client currently using.
  • - Text: A text message. + Legacy: Legacy crypto backend specific to each platform.
  • - LocationPin: A pin drop location message. + Rust: Cross-platform crypto backend written in Rust.
    • +
+ +
domain + +
    +
  • - LocationUser: A user current location message. + E2EE
  • - Poll: A poll message. + VOIP
  • - VoiceMessage: A voice message. + TO_DEVICE
    • @@ -118,8 +134,18 @@

    Composer

startsThreadWhether this message begins a new thread or not.eventLocalAgeMillisAn heuristic based on event origin_server_ts and the current device creation time (origin_server_ts - device_ts). This would be used to get the source of the event scroll-back/live/initialSync. + + integer + +
isFederatedtrue if userDomain != senderDomain. boolean @@ -127,75 +153,92 @@

Composer
-
- -
-

Signup

-

Triggered once onboarding has completed, but only if the user registered a new account.

- - - - - - - - - + + + + + - - + + - -
PropertyDescriptionType
isMatrixDotOrgtrue if the current user is using matrix.org. + + boolean + +
authenticationTypeThe type of authentication that was used to sign up.name
  • - Password: Registration with a username and password. + OlmIndexError: E2EE domain error. The room key is known but is ratcheted (index > 0).
  • - Apple: Social login using Apple. + OlmKeysNotSentError: E2EE domain error. Generic unknown inbound group session error.
  • - Facebook: Social login using Facebook. + OlmUnspecifiedError: E2EE domain error. Any other decryption error (missing field, format errors...).
  • - GitHub: Social login using GitHub. + UnknownError: E2EE domain error. Decryption failed due to unknown error.
  • - GitLab: Social login using GitLab. + HistoricalMessage: E2EE domain error. Decryption failed for a message sent before the device logged in, and key backup is not enabled.
  • - Google: Social login using Google. + ExpectedDueToMembership: E2EE domain error. Decryption failed for a message sent before you were in the room (shared history visibility and support for sharing past keys is not available/supported).
  • - SSO: Registration using another SSO provider. + VoipUserHangup: VOIP domain error. The user hung up the call.
  • - Other: Registration using some other mechanism such as fallback. + VoipIceFailed: VOIP domain error. ICE negotiation failed. + +
    • + +
  • + + VoipInviteTimeout: VOIP domain error. The call invite timed out. + +
    • + +
  • + + VoipIceTimeout: VOIP domain error. ICE negotiation timed out. + +
    • + +
  • + + VoipUserMediaFailed: VOIP domain error. The user's media failed to start. + +
    • + +
  • + + ToDeviceFailedToDecrypt: TO_DEVICE domain error. The to-device message failed to decrypt.
    • @@ -204,26 +247,29 @@

    Signup
-
- -
-

NotificationTroubleshoot

-

Triggered when the user runs the troubleshoot notification test suite.

- - - - - - - - - + + + + + - - + + + + + + + +
PropertyDescriptionType
timeToDecryptMillisUTDs can be permanent or temporary. If temporary, this field will contain the time it took to decrypt the message in milliseconds. If permanent should be -1. + + integer + +
hasErrorWhether one or more tests are in error.userTrustsOwnIdentitytrue if the current user trusts their own identity (verified session) at time of decryption. + + boolean + +
wasVisibleToUsertrue if that unable to decrypt error was visible to the user. boolean @@ -236,8 +282,8 @@

NotificationTroubleshoot

-

SuperProperties

-

Super Properties are properties associated with events that are sent with every capture call, be it a $pageview, an autocaptured button click, or anything else.

+

ViewRoom

+

Triggered when the user changes rooms.

@@ -249,31 +295,33 @@

SuperProperties

- - - - - - - - + + - - + + - -
appPlatformUsed by web to identify the platform (Web Platform/Electron Platform). - - string - -
cryptoSDKWhich crypto backend is the client currently using.activeSpaceactive space when user navigated to the room.
  • - Legacy: Legacy crypto backend specific to each platform. + Home: Active space is Home.
  • - Rust: Cross-platform crypto backend written in Rust. + Private: Active space is a private space. + +
    • + +
  • + + Public: Active space is a public space. + +
    • + +
  • + + Meta: Active space is a meta space.
    • @@ -283,811 +331,737 @@

    SuperProperties

cryptoSDKVersionVersion of the crypto backend.isDMWhether the room is a DM. - string + boolean
-
- -
-

Error

-

Triggered when an error occurred.

- - - - - - - - - - - - + + - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescriptionType
contextContext - client defined, can be used for debugging.isSpaceWhether the room is a Space. - string + boolean
cryptoModuleDEPRECATED: Which crypto module is the client currently using. - -
    - -
  • - - Native: Native / legacy crypto module specific to each platform. - -
    • - -
  • - - Rust: Shared / cross-platform crypto module written in Rust. - -
    • - -
- -
cryptoSDKWhich crypto backend is the client currently using. - -
    - -
  • - - Legacy: Legacy crypto backend specific to each platform. - -
    • - -
  • - - Rust: Cross-platform crypto backend written in Rust. - -
    • - -
- -
domaintriggerThe reason for the room change if known.
  • - E2EE + Created: Room accessed due to being just created.
  • - VOIP + RoomList: Room accessed via the room list.
  • - TO_DEVICE + RoomDirectory: Room accessed via the public rooms directory.
    • -
- -
eventLocalAgeMillisAn heuristic based on event origin_server_ts and the current device creation time (origin_server_ts - device_ts). This would be used to get the source of the event scroll-back/live/initialSync. - - integer - -
isFederatedtrue if userDomain != senderDomain. - - boolean - -
isMatrixDotOrgtrue if the current user is using matrix.org. - - boolean - -
name - -
    -
  • - OlmIndexError: E2EE domain error. The room key is known but is ratcheted (index > 0). + SpaceHierarchy: Room accessed via the space hierarchy view.
  • - OlmKeysNotSentError: E2EE domain error. Generic unknown inbound group session error. + Timeline: Room accessed via a timeline pill or link in another room.
  • - OlmUnspecifiedError: E2EE domain error. Any other decryption error (missing field, format errors...). + Notification: Room accessed via a push/desktop notification.
  • - UnknownError: E2EE domain error. Decryption failed due to unknown error. + Tombstone: Room accessed via a tombstone at the bottom of a predecessor room.
  • - HistoricalMessage: E2EE domain error. Decryption failed for a message sent before the device logged in, and key backup is not enabled. + Predecessor: Room accessed via the predecessor link at the top of the upgraded room.
  • - ExpectedDueToMembership: E2EE domain error. Decryption failed for a message sent before you were in the room (shared history visibility and support for sharing past keys is not available/supported). + Widget: Room switched due to widget interaction.
  • - VoipUserHangup: VOIP domain error. The user hung up the call. + MessageSearch: Room switched due to user interacting with a message search result.
  • - VoipIceFailed: VOIP domain error. ICE negotiation failed. + MessageUser: Room switched due to user selecting a user to go to a DM with.
  • - VoipInviteTimeout: VOIP domain error. The call invite timed out. + VerificationRequest: Room switched due to user interacting with incoming verification request.
  • - VoipIceTimeout: VOIP domain error. ICE negotiation timed out. + SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto.
  • - VoipUserMediaFailed: VOIP domain error. The user's media failed to start. + Shortcut: Room accessed via a shortcut.
  • - ToDeviceFailedToDecrypt: TO_DEVICE domain error. The to-device message failed to decrypt. + WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel.
    • -
- -
timeToDecryptMillisUTDs can be permanent or temporary. If temporary, this field will contain the time it took to decrypt the message in milliseconds. If permanent should be -1. - - integer - -
userTrustsOwnIdentitytrue if the current user trusts their own identity (verified session) at time of decryption. - - boolean - -
wasVisibleToUsertrue if that unable to decrypt error was visible to the user. - - boolean - -
-
- -
-

Interaction

-

Triggered when the user clicks/taps/activates a UI element.

- - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
PropertyDescriptionType
indexThe index of the element, if its in a list of elements. - - integer - -
interactionTypeThe manner with which the user activated the UI element. - -
    -
  • - Pointer + WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages.
  • - Keyboard + WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list.
  • - Touch + WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu.
    • -
- -
nameThe unique name of this element. - -
    -
  • - WebRoomListRoomTileContextMenuFavouriteToggle: User adjusted their favourites using the context menu on a room tile in the room list in Element Web/Desktop. + WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop.
  • - WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop. + WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop.
  • - WebSettingsNotificationsShowBoldToggle: User toggled the 'Notifications.showbold' in Element Web/Desktop. + WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal.
  • - WebSettingsNotificationsTACOnlyNotificationsToggle: User toggled the 'Notifications.tac_only_notifications' in Element Web/Desktop. + WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal.
  • - WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via the context menu on a room tile in the room list in Element Web/Desktop. + WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop.
  • - WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop. + WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop.
  • - WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop. + WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop.
  • - WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop. + WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop.
  • - WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop. + WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop.
  • - WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop. + WebThreadsActivityCentre: Room accessed via interacting with the Threads Activity Centre in Element Web/Desktop.
  • - WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop. + MobileFileSearch: Room switched due to user interacting with a file search result.
  • - WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop. + MobileRoomSearch: Room switched due to user interacting with a room search result.
  • - WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop. + MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen.
  • - WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop. + MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen.
  • - WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of Element Web/Desktop. + MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen.
  • - WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop. + MobileInCall: Room accessed via interacting with the incall screen.
  • - WebRoomListRoomTileContextMenuMarkRead: User marked a message as read using the context menu on a room tile in the room list in Element Web/Desktop. + MobileSpaceMenu: Space accessed via interacting with the space menu.
  • - WebRoomListRoomTileContextMenuMarkUnread: User marked a room as unread using the context menu on a room tile in the room list in Element Web/Desktop. + MobileSpaceSettings: Space accessed via interacting with a space settings menu item.
  • - WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop. + MobileRoomPreview: Room accessed via preview.
  • - WebRightPanelMemberListInviteButton: User accessed the room invite flow using the button at the top of the room member list in the right panel of Element Web/Desktop. + MobilePermalink: Room accessed via link.
  • - WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop. + MobileLinkShare: Room accessed during external sharing.
  • - WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop. + MobileExploreRooms: Room accessed via space explore.
  • - WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop. + MobileSpaceMembers: Room accessed via space members list.
  • - WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop. + MobileSpaceBottomSheet: Room accessed via space bottom sheet list.
    • +
+ +
viaKeyboardWhether the interaction was performed via the keyboard input. + + boolean + +
+
+ +
+

CallStarted

+

Triggered when a call is started.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescriptionType
isVideoWhether its a video call or not. + + boolean + +
numParticipantsNumber of participants in the call. + + integer + +
placedWhether this user placed it. + + boolean + +
+
+ +
+

$screen

+

Triggered when the user changed screen on Element Android/iOS.

+ + + + + + + + + + + + + + + + + + + +
PropertyDescriptionType
durationMsHow long the screen was displayed for in milliseconds. + + integer + +
screenName + +
    +
  • - WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop. + Home: The Home tab on iOS | possibly the same on Android?
  • - WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop. + Welcome: The splash screen.
  • - WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop. + Login: The screen that displays the login flow (when the user already has an account).
  • - WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop. + ForgotPassword: The form for the forgot password use case.
  • - WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop. + Register: The screen that displays the registration flow (when the user wants to create an account).
  • - WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop. + Room: The screen that displays the messages and events received in a room.
  • - WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop. + RoomDetails: The screen shown when tapping the name of a room from the Room screen.
  • - WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop. + RoomMembers: The screen that displays the list of members that are part of a room.
  • - WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop. + User: A screen that shows information about a room member.
  • - WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop. + RoomSearch: The screen that allows you to search for messages/files in a specific room.
  • - WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop. + RoomUploads: The screen that allows you to see all of the files sent in a specific room.
  • - WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop. + RoomSettings: The settings screen shown from the Room Details screen.
  • - WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
  • - WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop. + RoomAddresses: The room addresses screen shown from the Room Details screen.
  • - WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop. + RoomPermissions: The roles permissions screen shown from the Room Details screen.
  • - WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop. + RoomDirectory: The screen that lists public rooms for you to discover.
  • - WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
  • - WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop. + StartChat: The screen shown to create a new direct room.
  • - WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop. + CreateRoom: The screen shown to create a new (non-direct) room.
  • - WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the room list header in Element Web/Desktop. + DeactivateAccount: The confirmation screen shown before deactivating an account.
  • - WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop. + Group: Legacy: The screen that shows information about a specific group.
  • - WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop. + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
  • - WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space.
  • - WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop. + Sidebar: The sidebar shown on mobile with spaces, settings etc.
  • - WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop. + Favourites: The Favourites tab on mobile that lists your favourite people/rooms.
  • - WebThreadsActivityCentreButton: User clicked on the Threads Activity Centre button of Element Web/Desktop. + People: The People tab on mobile that lists all the DM rooms you have joined.
  • - WebThreadsActivityCentreRoomItem: User clicked on a room in the Threads Activity Centre of Element Web/Desktop. + Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined.
  • - WebThreadsMarkAllReadButton: User clicked on the button to mark all threads in a room as read in Element Web/Desktop. + Dialpad: The tab on mobile that displays the dialpad.
  • - WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop. + SearchRooms: The Rooms tab shown in the global search screen on Mobile.
  • - WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop. + SearchMessages: The Messages tab shown in the global search screen on Mobile.
  • - WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop. + SearchPeople: The People tab shown in the global search screen on Mobile.
  • - WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop. + SearchFiles: The Files tab shown in the global search screen on Mobile.
  • - WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop. + SwitchDirectory: The screen shown to select which room directory you'd like to use.
  • - WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop. + InviteFriends: The screen shown to share a link to download the app.
  • - WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop. + Breadcrumbs: The screen that displays the user's breadcrumbs.
  • - WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop. + Settings: The global settings screen shown in the app.
  • - SpacePanelSelectedSpace: User tapped the already selected space from the space list. + SettingsSecurity: The global security settings screen.
  • - SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur. + SettingsDefaultNotifications: The settings screen to change the default notification options.
  • - SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur. + SettingsGeneral: The settings screen with general profile settings.
  • - MobileRoomLeave: User tapped on Leave Room button on Room Details screen. + NotificationTroubleshoot: The screen containing tests to help user to fix issues around notifications.
  • - MobileRoomAddHome: User tapped on Add to Home button on Room Details screen. + SettingsNotifications: The notifications settings screen.
  • - MobileRoomFavouriteToggle: User switched the favourite toggle on Room Details screen. + SettingsPreferences: The preferences screen (theme, language, editor preferences, etc.
  • - MobileRoomThreadListButton: User tapped on Threads button on Room screen. + SettingsVoiceVideo: The calls settings screen.
  • - MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen. + SettingsIgnoredUsers: The settings screen with list of the ignored users.
  • - MobileThreadListThreadItem: User selected a thread on ThreadList screen. + SettingsLabs: The experimental features settings screen.
  • - MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen. + SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules).
  • - MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings. + SettingsHelp: The Help and About screen.
  • - MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings. + SettingsLegals: The settings screen with legals information.
  • - MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings. + SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords.
  • - MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings. + SpaceMenu: The bottom sheet that list all space options.
  • - MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab. + SpaceMembers: Screen that displays the list of members of a space.
  • - MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab. + RoomPreview: Screen that displays room preview if user hasn't joined yet.
  • - MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab. + ThreadList: Screen that displays list of threads for a room.
  • - MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab. + SpaceBottomSheet: Room accessed via space bottom sheet list.
  • - MobileSpaceCreationValidated: User validated the creation of a new space. + Invites: Room accessed via space bottom sheet list.
  • - MobileRoomListRoomContextMenuUnreadToggle: User adjusted their unread rooms using the context menu on a room in the room list. + CreateSpace: The screen shown to create a new space.
  • - MobileRoomListRoomContextMenuFavouriteToggle: User adjusted their favourite rooms using the context menu on a room in the room list. + LocationSend: The screen shown to share location. + +
    • + +
  • + + LocationView: The screen shown to view a shared location. + +
    • + +
  • + + CreatePollView: The screen shown to create a poll. + +
    • + +
  • + + EditPollView: The screen shown to edit a poll.
    • @@ -1101,8 +1075,8 @@

    Interaction

    -

    CallEnded

    -

    Triggered when a call has ended.

    +

    Interaction

    +

    Triggered when the user clicks/taps/activates a UI element.

    @@ -1114,8 +1088,8 @@

    CallEnded

    - - + + - - - - - - - - - - - - - - - - - - -
    durationMsThe duration of the call in milliseconds.indexThe index of the element, if its in a list of elements. integer @@ -1124,74 +1098,27 @@

    CallEnded

    isVideoWhether its a video call or not. - - boolean - -
    numParticipantsNumber of participants in the call. - - integer - -
    placedWhether this user placed it. - - boolean - -
    -
    - -
    -

    CryptoSessionState

    -

    Describe the current session crypto state, that is if the session is verified or not, if recovery is correctly setup.

    - - - - - - - - - - - - - + + - - + + - - - -
    PropertyDescriptionType
    recoveryStateinteractionTypeThe manner with which the user activated the UI element.
    • - Enabled: Secret storage is set up and we have all the secrets locally. + Pointer
    • - Disabled: No default secret storage key exists or it is disabled explicitly using the account data event. + Keyboard
    • - Incomplete: Secret storage is set up but we're missing some secrets. + Touch
      • @@ -1201,646 +1128,495 @@

      CryptoSessionState

    verificationStatenameThe unique name of this element.
    • - Verified: The device is considered to be verified, it has been signed by its user identity. + WebRoomListRoomTileContextMenuFavouriteToggle: User adjusted their favourites using the context menu on a room tile in the room list in Element Web/Desktop.
    • - NotVerified: The device is unverified. + WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop.
      • -
    - -
    -
    - -
    -

    PollEnd

    -

    Triggered when a poll has been ended.

    - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without properties other than the event name. - - boolean - -
    -
    - -
    -

    PermissionChanged

    -

    Triggered when the user changes a permission status.

    - - - - - - - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    grantedWhether the permission has been granted by the user. - - boolean - -
    permissionThe name of the permission. - -
      -
    • - Notification: Permissions related to sending notifications have changed. + WebSettingsNotificationsShowBoldToggle: User toggled the 'Notifications.showbold' in Element Web/Desktop.
      • -
    - -
    -
    - -
    -

    $screen

    -

    Triggered when the user changed screen on Element Android/iOS.

    - - - - - - - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    durationMsHow long the screen was displayed for in milliseconds. - - integer - -
    screenName - -
      -
    • - Home: The Home tab on iOS | possibly the same on Android? + WebSettingsNotificationsTACOnlyNotificationsToggle: User toggled the 'Notifications.tac_only_notifications' in Element Web/Desktop.
    • - Welcome: The splash screen. + WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via the context menu on a room tile in the room list in Element Web/Desktop.
    • - Login: The screen that displays the login flow (when the user already has an account). + WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop.
    • - ForgotPassword: The form for the forgot password use case. + WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop.
    • - Register: The screen that displays the registration flow (when the user wants to create an account). + WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop.
    • - Room: The screen that displays the messages and events received in a room. + WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop.
    • - RoomDetails: The screen shown when tapping the name of a room from the Room screen. + WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop.
    • - RoomMembers: The screen that displays the list of members that are part of a room. + WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop.
    • - User: A screen that shows information about a room member. + WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop.
    • - RoomSearch: The screen that allows you to search for messages/files in a specific room. + WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop.
    • - RoomUploads: The screen that allows you to see all of the files sent in a specific room. + WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop.
    • - RoomSettings: The settings screen shown from the Room Details screen. + WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of Element Web/Desktop.
    • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop.
    • - RoomAddresses: The room addresses screen shown from the Room Details screen. + WebRoomListRoomTileContextMenuMarkRead: User marked a message as read using the context menu on a room tile in the room list in Element Web/Desktop.
    • - RoomPermissions: The roles permissions screen shown from the Room Details screen. + WebRoomListRoomTileContextMenuMarkUnread: User marked a room as unread using the context menu on a room tile in the room list in Element Web/Desktop.
    • - RoomDirectory: The screen that lists public rooms for you to discover. + WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop.
    • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + WebRightPanelMemberListInviteButton: User accessed the room invite flow using the button at the top of the room member list in the right panel of Element Web/Desktop.
    • - StartChat: The screen shown to create a new direct room. + WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop.
    • - CreateRoom: The screen shown to create a new (non-direct) room. + WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop.
    • - DeactivateAccount: The confirmation screen shown before deactivating an account. + WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop.
    • - Group: Legacy: The screen that shows information about a specific group. + WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop.
    • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop.
    • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space. + WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop.
    • - Sidebar: The sidebar shown on mobile with spaces, settings etc. + WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop.
    • - Favourites: The Favourites tab on mobile that lists your favourite people/rooms. + WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop.
    • - People: The People tab on mobile that lists all the DM rooms you have joined. + WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop.
    • - Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined. + WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop.
    • - Dialpad: The tab on mobile that displays the dialpad. + WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop.
    • - SearchRooms: The Rooms tab shown in the global search screen on Mobile. + WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop.
    • - SearchMessages: The Messages tab shown in the global search screen on Mobile. + WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop.
    • - SearchPeople: The People tab shown in the global search screen on Mobile. + WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop.
    • - SearchFiles: The Files tab shown in the global search screen on Mobile. + WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop.
    • - SwitchDirectory: The screen shown to select which room directory you'd like to use. + WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop.
    • - InviteFriends: The screen shown to share a link to download the app. + WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop.
    • - Breadcrumbs: The screen that displays the user's breadcrumbs. + WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop.
    • - Settings: The global settings screen shown in the app. + WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop.
    • - SettingsSecurity: The global security settings screen. + WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop.
    • - SettingsDefaultNotifications: The settings screen to change the default notification options. + WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop.
    • - SettingsGeneral: The settings screen with general profile settings. + WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop.
    • - NotificationTroubleshoot: The screen containing tests to help user to fix issues around notifications. + WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop.
    • - SettingsNotifications: The notifications settings screen. + WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the room list header in Element Web/Desktop.
    • - SettingsPreferences: The preferences screen (theme, language, editor preferences, etc. + WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop.
    • - SettingsVoiceVideo: The calls settings screen. + WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop.
    • - SettingsIgnoredUsers: The settings screen with list of the ignored users. + WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop.
    • - SettingsLabs: The experimental features settings screen. + WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop.
    • - SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules). + WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop.
    • - SettingsHelp: The Help and About screen. + WebThreadsActivityCentreButton: User clicked on the Threads Activity Centre button of Element Web/Desktop.
    • - SettingsLegals: The settings screen with legals information. + WebThreadsActivityCentreRoomItem: User clicked on a room in the Threads Activity Centre of Element Web/Desktop.
    • - SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords. + WebThreadsMarkAllReadButton: User clicked on the button to mark all threads in a room as read in Element Web/Desktop.
    • - SpaceMenu: The bottom sheet that list all space options. + WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop.
    • - SpaceMembers: Screen that displays the list of members of a space. + WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop.
    • - RoomPreview: Screen that displays room preview if user hasn't joined yet. + WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop.
    • - ThreadList: Screen that displays list of threads for a room. + WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop.
    • - SpaceBottomSheet: Room accessed via space bottom sheet list. + WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop.
    • - Invites: Room accessed via space bottom sheet list. + WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop.
    • - CreateSpace: The screen shown to create a new space. + WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop.
    • - LocationSend: The screen shown to share location. + WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop.
    • - LocationView: The screen shown to view a shared location. + SpacePanelSelectedSpace: User tapped the already selected space from the space list.
    • - CreatePollView: The screen shown to create a poll. + SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur.
    • - EditPollView: The screen shown to edit a poll. + SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur.
      • -
    - -
    -
    - -
    -

    PerformanceTimer

    -

    Triggered after timing an operation in the app.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    contextClient defined, can be used for debugging. - - string - -
    itemCountClient defined, an optional value to indicate how many items were handled during the operation. - - integer - -
    nameThe timer that is being reported. - -
      +
    • + + MobileRoomLeave: User tapped on Leave Room button on Room Details screen. + +
    • - StartupInitialSync: The duration of an initial /sync request during startup (if the store has been wiped). In this case, `itemCount` should contain the number of joined rooms. + MobileRoomAddHome: User tapped on Add to Home button on Room Details screen.
    • - StartupIncrementalSync: The duration of a regular /sync request when resuming the app. In this case, `itemCount` should contain the number of joined rooms in the response. + MobileRoomFavouriteToggle: User switched the favourite toggle on Room Details screen.
    • - StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store. + MobileRoomThreadListButton: User tapped on Threads button on Room screen.
    • - StartupStoreReady: The time to load all data from the store (including StartupStorePreload time). In this case, `itemCount` should contain the number of rooms loaded into the session + MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen.
    • - StartupLaunchScreen: How long the app launch screen is displayed for. + MobileThreadListThreadItem: User selected a thread on ThreadList screen.
    • - InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. + MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen.
    • - InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. + MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings.
    • - NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification. + MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings.
      • -
    - -
    timeMsThe time reported by the timer in milliseconds. - - integer - -
    -
    - -
    -

    UnauthenticatedError

    -

    Triggered when the user becomes unauthenticated without actually clicking sign out(E.g. Due to expiry of an access token without a way to refresh).

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver. - -
      +
    • + + MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings. + +
    • - M_UNKNOWN + MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings.
    • - M_FORBIDDEN + MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab.
    • - M_UNKNOWN_TOKEN + MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab. + +
      • + +
    • + + MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab. + +
      • + +
    • + + MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab. + +
      • + +
    • + + MobileSpaceCreationValidated: User validated the creation of a new space. + +
      • + +
    • + + MobileRoomListRoomContextMenuUnreadToggle: User adjusted their unread rooms using the context menu on a room in the room list. + +
      • + +
    • + + MobileRoomListRoomContextMenuFavouriteToggle: User adjusted their favourite rooms using the context menu on a room in the room list.
      • @@ -1849,90 +1625,13 @@

      UnauthenticatedError
    errorReasonThe reason for the error. The source of this error is from the homeserver, the reason can vary and is subject to change so there is no enum of possible values. - - string - -
    refreshTokenAuthWhether the auth mechanism is refresh-token-based. - - boolean - -
    softLogoutWhether a soft logout or hard logout was triggered. - - boolean - -
    -
    - -
    -

    WebSearch

    -

    Triggered when the user searches rooms.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    PropertyDescriptionType
    numResultsHow many results the user got to their query. - - integer - -
    queryLengthThe length of the user's query. - - integer - -
    viaSpotlightWhether the user is using the new search experience beta. - - boolean - -
    -

    $pageview

    -

    Triggered when the user changed screen on Element Web/Desktop

    +

    RoomModeration

    +

    Triggered when a moderation action is performed within a room.

    @@ -1944,568 +1643,583 @@

    $pageview

    - - + + + + + + + + + + + +
    $current_urlactionThe action that was performed.
    • - Home: Home page. + ChangeMemberRole: Changed a room member's power level.
    • - Welcome: The splash screen. + KickMember: Kicked a room member.
    • - Login: The screen that displays the login flow (when the user already has an account). + BanMember: Banned a room member.
    • - ForgotPassword: The form for the forgot password use case + UnbanMember: Unbanned a room member.
    • - Register: The screen that displays the registration flow (when the user wants to create an account) + ChangePermissionsRoomName: Changed the power level required to set the room's name.
    • - UseCaseSelection: The screen where users choose their expected use case for Element. + ChangePermissionsRoomAvatar: Changed the power level required to set the room's avatar.
    • - Room: The screen that displays the messages and events received in a room. + ChangePermissionsRoomTopic: Changed the power level required to set the room's topic.
    • - RoomDetails: The screen shown when tapping the name of a room from the Room screen. + ChangePermissionsSendMessages: Changed the power level required to send messages in the room.
    • - RoomMembers: The screen that displays the list of members that are part of a room. + ChangePermissionsRedactMessages: Changed the power level required to redact messages in the room.
    • - User: A screen that shows information about a room member. + ChangePermissionsInviteUsers: Changed the power level required to invite users to the room.
    • - RoomSearch: The screen that allows you to search for messages/files in a specific room. + ChangePermissionsKickMembers: Changed the power level required to kick room members.
    • - RoomUploads: The screen that allows you to see all of the files sent in a specific room. + ChangePermissionsBanMembers: Changed the power level required to ban room members.
    • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + ResetPermissions: Reset all of the room permissions back to their default values.
      • +
    + +
    roleWhen the action sets a particular power level, this is the suggested role for that the power level. + +
      +
    • - RoomDirectory: The screen that lists public rooms for you to discover. + Administrator: A power level of 100.
    • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + Moderator: A power level of 50.
    • - StartChat: The screen shown to create a new direct room. + User: A power level of 0.
    • - CreateRoom: The screen shown to create a new (non-direct) room. + Other: Any other power level.
      • +
    + +
    +
    + +
    +

    CreatedRoom

    +

    Triggered when the user creates a room.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    isDMWhether the room is a DM. + + boolean + +
    +
    + +
    +

    PollEnd

    +

    Triggered when a poll has been ended.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without properties other than the event name. + + boolean + +
    +
    + +
    +

    UnauthenticatedError

    +

    Triggered when the user becomes unauthenticated without actually clicking sign out(E.g. Due to expiry of an access token without a way to refresh).

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver. + +
      +
    • - DeactivateAccount: The confirmation screen shown before deactivating an account. + M_UNKNOWN
    • - Group: Legacy: The screen that shows information about a specific group. + M_FORBIDDEN
    • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + M_UNKNOWN_TOKEN
      • +
    + +
    errorReasonThe reason for the error. The source of this error is from the homeserver, the reason can vary and is subject to change so there is no enum of possible values. + + string + +
    refreshTokenAuthWhether the auth mechanism is refresh-token-based. + + boolean + +
    softLogoutWhether a soft logout or hard logout was triggered. + + boolean + +
    +
    + +
    +

    $pageview

    +

    Triggered when the user changed screen on Element Web/Desktop

    + + + + + + + + + + + + + + - - - - - - - - - -
    PropertyDescriptionType
    $current_url + +
      +
    • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space + Home: Home page.
    • - Loading: Screen showing loading spinner. + Welcome: The splash screen.
    • - CompleteSecurity: Screen showing flow to trust this new device with cross-signing. + Login: The screen that displays the login flow (when the user already has an account).
    • - E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account. + ForgotPassword: The form for the forgot password use case
    • - SoftLogout: Screen showing device has been soft logged out by the server. + Register: The screen that displays the registration flow (when the user wants to create an account)
    • - UserSettings: Screen showing User Settings (unknown tab). + UseCaseSelection: The screen where users choose their expected use case for Element.
    • - UserSettingsGeneral: Screen showing User Settings General Tab. + Room: The screen that displays the messages and events received in a room.
    • - UserSettingsAppearance: Screen showing User Settings Appearance Tab. + RoomDetails: The screen shown when tapping the name of a room from the Room screen.
    • - UserSettingsNotifications: Screen showing User Settings Notifications Tab. + RoomMembers: The screen that displays the list of members that are part of a room.
    • - UserSettingsPreferences: Screen showing User Settings Preferences Tab. + User: A screen that shows information about a room member.
    • - UserSettingsKeyboard: Screen showing User Settings Keyboard Tab. + RoomSearch: The screen that allows you to search for messages/files in a specific room.
    • - UserSettingsSidebar: Screen showing User Settings Sidebar Tab. + RoomUploads: The screen that allows you to see all of the files sent in a specific room.
    • - UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
    • - UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab. + RoomDirectory: The screen that lists public rooms for you to discover.
    • - UserSettingsLabs: Screen showing User Settings Labs Tab. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
    • - UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab. + StartChat: The screen shown to create a new direct room.
    • - UserSettingsHelpAbout: Screen showing User Settings Help & About Tab. + CreateRoom: The screen shown to create a new (non-direct) room.
    • - UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab. + DeactivateAccount: The confirmation screen shown before deactivating an account.
    • - UserSettingFlair: Legacy: screen showing User Settings Flair Tab. + Group: Legacy: The screen that shows information about a specific group.
    • - RoomSettings: Screen showing Room Settings (unknown tab). + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
    • - RoomSettingsGeneral: Screen showing Room Settings General Tab. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space
    • - RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab. + Loading: Screen showing loading spinner.
    • - RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab. + CompleteSecurity: Screen showing flow to trust this new device with cross-signing.
    • - RoomSettingsNotifications: Screen showing Room Settings Notifications Tab. + E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account.
    • - RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab. + SoftLogout: Screen showing device has been soft logged out by the server.
    • - RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab. + UserSettings: Screen showing User Settings (unknown tab).
    • - UnifiedSearch: Screen showing the new unified search modal (Project Spotlight). + UserSettingsGeneral: Screen showing User Settings General Tab.
    • - FavouriteMessages: Screen showing all messages that have been added to favourites. + UserSettingsAppearance: Screen showing User Settings Appearance Tab.
    • - ConfirmStartup: Screen showing that the app is already running in another window. + UserSettingsNotifications: Screen showing User Settings Notifications Tab.
    • - SessionLockStolen: Screen showing that the app has been started in another window. + UserSettingsPreferences: Screen showing User Settings Preferences Tab.
      • -
    - -
    durationMsHow long the screen took to load, if applicable. - - integer - -
    -
    - -
    -

    UserProperties

    -

    The user properties to apply when identifying. This is not an event definition. These properties must all be device independent.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
    PropertyDescriptionType
    WebLayoutWhich layout the user is using in Element Web/Desktop. This is known to clobber between devices. - -
      -
    • - IRC: IRC layout. + UserSettingsKeyboard: Screen showing User Settings Keyboard Tab.
    • - Bubble: Bubble layout. + UserSettingsSidebar: Screen showing User Settings Sidebar Tab.
    • - Group: Modern layout. + UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab.
    • - Compact: Modern layout with compact option enabled. + UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab.
      • -
    - -
    WebMetaSpaceFavouritesEnabledWhether the user has the favourites space enabled. - - boolean - -
    WebMetaSpaceHomeAllRoomsWhether the user has the home space set to all rooms. - - boolean - -
    WebMetaSpaceHomeEnabledWhether the user has the home space enabled. - - boolean - -
    WebMetaSpaceOrphansEnabledWhether the user has the other rooms space enabled. - - boolean - -
    WebMetaSpacePeopleEnabledWhether the user has the people space enabled. - - boolean - -
    allChatsActiveFilterThe active filter in the All Chats screen. - -
      -
    • - All: Filters are activated and All is selected. + UserSettingsLabs: Screen showing User Settings Labs Tab.
    • - Unreads: Filters are activated and Unreads is selected. + UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab.
    • - Favourites: Filters are activated and Favourites is selected. + UserSettingsHelpAbout: Screen showing User Settings Help & About Tab.
    • - People: Filters are activated and People is selected. + UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab.
      • -
    - -
    ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. - -
      +
    • + + UserSettingFlair: Legacy: screen showing User Settings Flair Tab. + +
    • - PersonalMessaging: The first option, Friends and family. + RoomSettings: Screen showing Room Settings (unknown tab).
    • - WorkMessaging: The second option, Teams. + RoomSettingsGeneral: Screen showing Room Settings General Tab.
    • - CommunityMessaging: The third option, Communities. + RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab.
    • - Skip: The footer option to skip the question. + RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab.
      • -
    - -
    numFavouriteRoomsNumber of joined rooms the user has favourited. - - integer - -
    numSpacesNumber of spaces (and sub-spaces) the user is joined to. - - integer - -
    recoveryStateDescribe the current session recovery state, that if 4S is setup, complete (all secrets cached) or not. - -
      +
    • + + RoomSettingsNotifications: Screen showing Room Settings Notifications Tab. + +
    • - Enabled: Secret storage is set up and we have all the secrets locally. + RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab.
    • - Disabled: No default secret storage key exists or it is disabled explicitly using the account data event. + RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab.
    • - Incomplete: Secret storage is set up but we're missing some secrets. + UnifiedSearch: Screen showing the new unified search modal (Project Spotlight).
      • -
    - -
    verificationStateDescribe the current session verification state, that is if the session is verified or not. - -
      +
    • + + FavouriteMessages: Screen showing all messages that have been added to favourites. + +
    • - Verified: The device is considered to be verified, it has been signed by its user identity. + ConfirmStartup: Screen showing that the app is already running in another window.
    • - NotVerified: The device is unverified. + SessionLockStolen: Screen showing that the app has been started in another window.
      • @@ -2514,13 +2228,23 @@

      UserProperties
    durationMsHow long the screen took to load, if applicable. + + integer + +
    -

    ViewRoom

    -

    Triggered when the user changes rooms.

    +

    SuperProperties

    +

    Super Properties are properties associated with events that are sent with every capture call, be it a $pageview, an autocaptured button click, or anything else.

    @@ -2532,33 +2256,31 @@

    ViewRoom

    - - + + + + + + + + - - - - - - - - + + - - + + + + + +
    activeSpaceactive space when user navigated to the room.appPlatformUsed by web to identify the platform (Web Platform/Electron Platform). + + string + +
    cryptoSDKWhich crypto backend is the client currently using.
    • - Home: Active space is Home. - -
      • - -
    • - - Private: Active space is a private space. - -
      • - -
    • - - Public: Active space is a public space. + Legacy: Legacy crypto backend specific to each platform.
    • - Meta: Active space is a meta space. + Rust: Cross-platform crypto backend written in Rust.
      • @@ -2568,281 +2290,422 @@

      ViewRoom

    isDMWhether the room is a DM. - - boolean - -
    isSpaceWhether the room is a Space.cryptoSDKVersionVersion of the crypto backend. - boolean + string
    triggerThe reason for the room change if known.platformCodeNameUsed as a discriminant to breakdown usage per client.
    • - Created: Room accessed due to being just created. - -
      • - -
    • - - RoomList: Room accessed via the room list. - -
      • - -
    • - - RoomDirectory: Room accessed via the public rooms directory. - -
      • - -
    • - - SpaceHierarchy: Room accessed via the space hierarchy view. - -
      • - -
    • - - Timeline: Room accessed via a timeline pill or link in another room. - -
      • - -
    • - - Notification: Room accessed via a push/desktop notification. - -
      • - -
    • - - Tombstone: Room accessed via a tombstone at the bottom of a predecessor room. + Web: Element Web platform code.
    • - Predecessor: Room accessed via the predecessor link at the top of the upgraded room. + Desktop: Element Desktop platform code.
    • - Widget: Room switched due to widget interaction. + EI: Element iOS platform code.
    • - MessageSearch: Room switched due to user interacting with a message search result. + EXI: Element-X iOS platform code.
    • - MessageUser: Room switched due to user selecting a user to go to a DM with. + EA: Element Android platform code.
    • - VerificationRequest: Room switched due to user interacting with incoming verification request. + EXA: Element-X Android platform code.
    • - SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto. + Other: Other Platform code.
      • -
    • - - Shortcut: Room accessed via a shortcut. - -
      • - -
    • - - WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel. - -
      • - -
    • - - WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages. - -
      • +
    + +
    +
    + +
    +

    Signup

    +

    Triggered once onboarding has completed, but only if the user registered a new account.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    authenticationTypeThe type of authentication that was used to sign up. + +
    • - WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list. + Password: Registration with a username and password.
    • - WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu. + Apple: Social login using Apple.
    • - WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop. + Facebook: Social login using Facebook.
    • - WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop. + GitHub: Social login using GitHub.
    • - WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal. + GitLab: Social login using GitLab.
    • - WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal. + Google: Social login using Google.
    • - WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop. + SSO: Registration using another SSO provider.
    • - WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop. + Other: Registration using some other mechanism such as fallback.
      • -
    • - - WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop. - -
      • +
    + +
    +
    + +
    +

    Composer

    +

    Triggered when the user sends a message via the composer.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    inThreadWhether the user was using the composer inside of a thread. + + boolean + +
    isEditingWhether the user's composer interaction was editing a previously sent event. + + boolean + +
    isReplyWhether the user's composer interaction was a reply to a previously sent event. + + boolean + +
    messageTypeThe type of the message. + +
    • - WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop. + Text: A text message.
    • - WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop. + LocationPin: A pin drop location message.
    • - WebThreadsActivityCentre: Room accessed via interacting with the Threads Activity Centre in Element Web/Desktop. + LocationUser: A user current location message.
    • - MobileFileSearch: Room switched due to user interacting with a file search result. + Poll: A poll message.
    • - MobileRoomSearch: Room switched due to user interacting with a room search result. + VoiceMessage: A voice message.
      • -
    • - - MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen. - -
      • +
    + +
    startsThreadWhether this message begins a new thread or not. + + boolean + +
    +
    + +
    +

    PollCreation

    +

    Triggered when a poll is created or edited.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    actionWhether this poll has been created or edited. + +
    • - MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen. + Create: Newly created poll.
    • - MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen. + Edit: Edit of an existing poll.
      • -
    • - - MobileInCall: Room accessed via interacting with the incall screen. - -
      • +
    + +
    isUndisclosedWhether this poll is undisclosed. + + boolean + +
    numberOfAnswersNumber of answers in the poll. + + integer + +
    +
    + +
    +

    PollVote

    +

    Triggered when a poll vote has been cast.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without properties other than the event name. + + boolean + +
    +
    + +
    +

    PerformanceTimer

    +

    Triggered after timing an operation in the app.

    + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + +
    PropertyDescriptionType
    contextClient defined, can be used for debugging. + + string + +
    itemCountClient defined, an optional value to indicate how many items were handled during the operation. + + integer + +
    nameThe timer that is being reported. + +
    • - MobileSpaceMenu: Space accessed via interacting with the space menu. + StartupInitialSync: The duration of an initial /sync request during startup (if the store has been wiped). In this case, `itemCount` should contain the number of joined rooms.
    • - MobileSpaceSettings: Space accessed via interacting with a space settings menu item. + StartupIncrementalSync: The duration of a regular /sync request when resuming the app. In this case, `itemCount` should contain the number of joined rooms in the response.
    • - MobileRoomPreview: Room accessed via preview. + StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store.
    • - MobilePermalink: Room accessed via link. + StartupStoreReady: The time to load all data from the store (including StartupStorePreload time). In this case, `itemCount` should contain the number of rooms loaded into the session
    • - MobileLinkShare: Room accessed during external sharing. + StartupLaunchScreen: How long the app launch screen is displayed for.
    • - MobileExploreRooms: Room accessed via space explore. + InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
    • - MobileSpaceMembers: Room accessed via space members list. + InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
    • - MobileSpaceBottomSheet: Room accessed via space bottom sheet list. + NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification.
      • @@ -2852,8 +2715,55 @@

      ViewRoom

    viaKeyboardWhether the interaction was performed via the keyboard input.timeMsThe time reported by the timer in milliseconds. + + integer + +
    +
    + +
    +

    CallError

    +

    Triggered when an error occurred in a call.

    + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    isVideoWhether its a video call or not. + + boolean + +
    numParticipantsNumber of participants in the call. + + integer + +
    placedWhether this user placed it. boolean @@ -2866,8 +2776,8 @@

    ViewRoom

    -

    PollCreation

    -

    Triggered when a poll is created or edited.

    +

    WebSearch

    +

    Triggered when the user searches rooms.

    @@ -2879,45 +2789,31 @@

    PollCreation

    - - + + - - + + - - + + @@ -3067,26 +2963,215 @@

    JoinedRoom

    - -
    actionWhether this poll has been created or edited.numResultsHow many results the user got to their query. - -
      - -
    • - - Create: Newly created poll. - -
      • - -
    • - - Edit: Edit of an existing poll. - -
      • - -
    + + integer
    isUndisclosedWhether this poll is undisclosed.queryLengthThe length of the user's query. - boolean + integer
    numberOfAnswersNumber of answers in the poll.viaSpotlightWhether the user is using the new search experience beta. - integer + boolean
    -
    - -
    -

    CreatedRoom

    -

    Triggered when the user creates a room.

    - - - - - - - - - - + +
    PropertyDescriptionType
    +
    + +
    +

    NotificationTroubleshoot

    +

    Triggered when the user runs the troubleshoot notification test suite.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    hasErrorWhether one or more tests are in error. + + boolean + +
    +
    + +
    +

    PermissionChanged

    +

    Triggered when the user changes a permission status.

    + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    grantedWhether the permission has been granted by the user. + + boolean + +
    permissionThe name of the permission. + +
      + +
    • + + Notification: Permissions related to sending notifications have changed. + +
      • + +
    + +
    +
    + +
    +

    SlashCommand

    +

    Triggered when the user runs a slash command in their composer.

    + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    commandThe name of this command. + +
      + +
    • + + Part + +
      • + +
    • + + Invite + +
      • + +
    + +
    +
    + +
    +

    UserProperties

    +

    The user properties to apply when identifying. This is not an event definition. These properties must all be device independent.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - -
    PropertyDescriptionType
    WebLayoutWhich layout the user is using in Element Web/Desktop. This is known to clobber between devices. + +
      + +
    • + + IRC: IRC layout. + +
      • + +
    • + + Bubble: Bubble layout. + +
      • + +
    • + + Group: Modern layout. + +
      • + +
    • + + Compact: Modern layout with compact option enabled. + +
      • + +
    + +
    WebMetaSpaceFavouritesEnabledWhether the user has the favourites space enabled. + + boolean + +
    WebMetaSpaceHomeAllRoomsWhether the user has the home space set to all rooms. + + boolean + +
    WebMetaSpaceHomeEnabledWhether the user has the home space enabled. + + boolean + +
    WebMetaSpaceOrphansEnabledWhether the user has the other rooms space enabled. + + boolean + +
    isDMWhether the room is a DM.WebMetaSpacePeopleEnabledWhether the user has the people space enabled. boolean @@ -3094,105 +3179,120 @@

    CreatedRoom
    -
    - -
    -

    RoomModeration

    -

    Triggered when a moderation action is performed within a room.

    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + +
    PropertyDescriptionType
    actionThe action that was performed.allChatsActiveFilterThe active filter in the All Chats screen.
    • - ChangeMemberRole: Changed a room member's power level. + All: Filters are activated and All is selected.
    • - KickMember: Kicked a room member. + Unreads: Filters are activated and Unreads is selected.
    • - BanMember: Banned a room member. + Favourites: Filters are activated and Favourites is selected.
    • - UnbanMember: Unbanned a room member. + People: Filters are activated and People is selected.
      • -
    • - - ChangePermissionsRoomName: Changed the power level required to set the room's name. - -
      • +
    + +
    ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. + +
    • - ChangePermissionsRoomAvatar: Changed the power level required to set the room's avatar. + PersonalMessaging: The first option, Friends and family.
    • - ChangePermissionsRoomTopic: Changed the power level required to set the room's topic. + WorkMessaging: The second option, Teams.
    • - ChangePermissionsSendMessages: Changed the power level required to send messages in the room. + CommunityMessaging: The third option, Communities.
    • - ChangePermissionsRedactMessages: Changed the power level required to redact messages in the room. + Skip: The footer option to skip the question.
      • -
    • - - ChangePermissionsInviteUsers: Changed the power level required to invite users to the room. - -
      • +
    + +
    numFavouriteRoomsNumber of joined rooms the user has favourited. + + integer + +
    numSpacesNumber of spaces (and sub-spaces) the user is joined to. + + integer + +
    recoveryStateDescribe the current session recovery state, that if 4S is setup, complete (all secrets cached) or not. + +
    • - ChangePermissionsKickMembers: Changed the power level required to kick room members. + Enabled: Secret storage is set up and we have all the secrets locally.
    • - ChangePermissionsBanMembers: Changed the power level required to ban room members. + Disabled: No default secret storage key exists or it is disabled explicitly using the account data event.
    • - ResetPermissions: Reset all of the room permissions back to their default values. + Incomplete: Secret storage is set up but we're missing some secrets.
      • @@ -3202,33 +3302,21 @@

      RoomModeration

    roleWhen the action sets a particular power level, this is the suggested role for that the power level.verificationStateDescribe the current session verification state, that is if the session is verified or not.
    • - Administrator: A power level of 100. - -
      • - -
    • - - Moderator: A power level of 50. - -
      • - -
    • - - User: A power level of 0. + Verified: The device is considered to be verified, it has been signed by its user identity.
    • - Other: Any other power level. + NotVerified: The device is unverified.
      • @@ -3242,8 +3330,8 @@

      RoomModeration

      -

      CallStarted

      -

      Triggered when a call is started.

      +

      CallEnded

      +

      Triggered when a call has ended.

      @@ -3254,6 +3342,16 @@

      CallStarted

      + + + + + + @@ -3289,8 +3387,8 @@

      CallStarted

      -

      SlashCommand

      -

      Triggered when the user runs a slash command in their composer.

      +

      CryptoSessionState

      +

      Describe the current session crypto state, that is if the session is verified or not, if recovery is correctly setup.
      durationMsThe duration of the call in milliseconds. + + integer + +
      isVideo Whether its a video call or not.
      @@ -3302,21 +3400,27 @@

      SlashCommand

      - - + + - -
      commandThe name of this command.recoveryState
      • - Part + Enabled: Secret storage is set up and we have all the secrets locally.
      • - Invite + Disabled: No default secret storage key exists or it is disabled explicitly using the account data event. + +
        • + +
      • + + Incomplete: Secret storage is set up but we're missing some secrets.
        • @@ -3325,76 +3429,26 @@

        SlashCommand
      -
      - -
      -

      CallError

      -

      Triggered when an error occurred in a call.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      isVideoWhether its a video call or not. - - boolean - -
      numParticipantsNumber of participants in the call. - - integer - -
      placedWhether this user placed it. - - boolean - -
      -
      - -
      -

      PollVote

      -

      Triggered when a poll vote has been cast.

      - - - - - - - - - - - - + +
      PropertyDescriptionType
      doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without properties other than the event name.verificationState - - boolean + +
        + +
      • + + Verified: The device is considered to be verified, it has been signed by its user identity. + +
        • + +
      • + + NotVerified: The device is unverified. + +
        • + +