From e6339c02c432f4cf409ce3b1587b3c02b9dbfabc Mon Sep 17 00:00:00 2001 From: BillCarsonFr Date: Wed, 23 Oct 2024 14:51:21 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20matrix-o?= =?UTF-8?q?rg/matrix-analytics-events@9bd3c57e84f87d56b69862369f3b9da714d1?= =?UTF-8?q?d151=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 2684 ++++++++++++++++++++++++++-------------------------- 1 file changed, 1348 insertions(+), 1336 deletions(-) diff --git a/index.html b/index.html index 7976f27..e457af0 100644 --- a/index.html +++ b/index.html @@ -33,8 +33,8 @@

Analytics events for Element clients

-

CallEnded

-

Triggered when a call has ended.

+

RoomModeration

+

Triggered when a moderation action is performed within a room.

@@ -46,41 +46,127 @@

CallEnded

- - - - - - - - - - - - - - + + - - + + @@ -90,8 +176,8 @@

CallEnded

-

SlashCommand

-

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

+

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).
durationMsThe duration of the call in milliseconds. - - integer - -
isVideoWhether its a video call or not. - - boolean - -
numParticipantsNumber of participants in the call.actionThe action that was performed. - - integer + +
    + +
  • + + ChangeMemberRole: Changed a room member's power level. + +
    • + +
  • + + KickMember: Kicked a room member. + +
    • + +
  • + + BanMember: Banned a room member. + +
    • + +
  • + + UnbanMember: Unbanned a room member. + +
    • + +
  • + + ChangePermissionsRoomName: Changed the power level required to set the room's name. + +
    • + +
  • + + ChangePermissionsRoomAvatar: Changed the power level required to set the room's avatar. + +
    • + +
  • + + ChangePermissionsRoomTopic: Changed the power level required to set the room's topic. + +
    • + +
  • + + ChangePermissionsSendMessages: Changed the power level required to send messages in the room. + +
    • + +
  • + + ChangePermissionsRedactMessages: Changed the power level required to redact messages in the room. + +
    • + +
  • + + ChangePermissionsInviteUsers: Changed the power level required to invite users to the room. + +
    • + +
  • + + ChangePermissionsKickMembers: Changed the power level required to kick room members. + +
    • + +
  • + + ChangePermissionsBanMembers: Changed the power level required to ban room members. + +
    • + +
  • + + ResetPermissions: Reset all of the room permissions back to their default values. + +
    • + +
placedWhether this user placed it.roleWhen the action sets a particular power level, this is the suggested role for that the power level. - - boolean + +
    + +
  • + + Administrator: A power level of 100. + +
    • + +
  • + + Moderator: A power level of 50. + +
    • + +
  • + + User: A power level of 0. + +
    • + +
  • + + Other: Any other power level. + +
    • + +
@@ -103,21 +189,27 @@

SlashCommand

- - + + + + + + + + + + + + + + + + + + + +
commandThe name of this command.errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver.
  • - Part + M_UNKNOWN
  • - Invite + M_FORBIDDEN + +
    • + +
  • + + M_UNKNOWN_TOKEN
    • @@ -126,6 +218,36 @@

    SlashCommand
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 + +
@@ -304,6 +426,18 @@

Error

+
  • + + ExpectedSentByInsecureDevice: E2EE domain error. Decryption failed for a message because it was sent by an insecure device + +
    • + +
  • + + ExpectedVerificationViolation: E2EE domain error. Decryption failed for a message because the sender's verified identity has changed. + +
    • +
  • RoomKeysWithheldForUnverifiedDevice: E2EE domain error. The sender withheld the keys for this message, due to the recipient device being unverified. @@ -386,8 +520,8 @@

    Error

    -

    JoinedRoom

    -

    Triggered when the user joins a room.

    +

    PollVote

    +

    Triggered when a poll vote has been cast.

    @@ -399,8 +533,8 @@

    JoinedRoom

    - - + + - - - - - + +
    isDMWhether the room is a DM.doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without properties other than the event name. boolean @@ -408,56 +542,45 @@

    JoinedRoom
    isSpaceWhether the room is a Space. - - boolean - -
    +
    + +
    +

    PinUnpinAction

    +

    Triggered when the users pin or unpins a message.

    + + + + + + + + + - - + + - - + +
    PropertyDescriptionType
    roomSizeThe size of the room.fromFrom where the action is triggered.
    • - One - -
      • - -
    • - - Two + Timeline: Action triggered from the timeline.
    • - ThreeToTen + MessagePinningList: Action triggered from the menu item in message pinning list.
    • - ElevenToOneHundred - -
      • - -
    • - - OneHundredAndOneToAThousand - -
      • - -
    • - - MoreThanAThousand + UnpinAll: Action triggered from the Unpin all button in message pinning list.
      • @@ -467,57 +590,21 @@

      JoinedRoom

    triggerThe trigger for a room being joined if known.kindIs pin or unpin.
    • - Invite: Room joined via an invite. - -
      • - -
    • - - RoomPreview: Room joined via its preview. - -
      • - -
    • - - SlashCommand: Room joined via the /join slash command. - -
      • - -
    • - - RoomDirectory: Room joined via the public rooms directory. - -
      • - -
    • - - SpaceHierarchy: Room joined via the space hierarchy view. - -
      • - -
    • - - Timeline: Room joined via a timeline pill or link in another room. - -
      • - -
    • - - Notification: Room joined via a push/desktop notification. + Pin: Pin a message.
    • - MobilePermalink: Room joined via link. + Unpin: Unpin a message.
      • @@ -531,8 +618,65 @@

      JoinedRoom

      -

      PollVote

      -

      Triggered when a poll vote has been cast.

      +

      CallEnded

      +

      Triggered when a call has ended.

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

      PollEnd

      +

      Triggered when a poll has been ended.

      @@ -558,8 +702,8 @@

      PollVote

      -

      WebPanelResize

      -

      Triggered when the user resizes a layout panel.

      +

      Composer

      +

      Triggered when the user sends a message via the composer.

      @@ -571,57 +715,69 @@

      WebPanelResize

      - - + + - - + + + + + + + + + + + + + + - - + + @@ -645,8 +801,8 @@

      WebPanelResize

      -

      PollCreation

      -

      Triggered when a poll is created or edited.

      +

      Signup

      +

      Triggered once onboarding has completed, but only if the user registered a new account.
      panelThe panel that was resized.inThreadWhether the user was using the composer inside of a thread. - -
        - -
      • - - right - -
        • - -
      + + boolean
      roomTypeThe type of room the user is viewing when resizing the panel.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.
      • - video_room + Text: A text message.
      • - maximised_widget + LocationPin: A pin drop location message.
      • - user_profile + LocationUser: A user current location message.
      • - space + Poll: A poll message.
      • - other_room + VoiceMessage: A voice message.
        • @@ -631,11 +787,11 @@

        WebPanelResize

      sizeThe size to which the user has resized the panel in pixels.startsThreadWhether this message begins a new thread or not. - integer + boolean
      @@ -658,94 +814,57 @@

      PollCreation

      - - + + - - - - - - - - - - - - - - - -
      actionWhether this poll has been created or edited.authenticationTypeThe type of authentication that was used to sign up.
      • - Create: Newly created poll. + Password: Registration with a username and password.
      • - Edit: Edit of an existing poll. + Apple: Social login using Apple.
        • -
      - -
      isUndisclosedWhether this poll is undisclosed. - - boolean - -
      numberOfAnswersNumber of answers in the poll. - - integer - -
      -
      - -
      -

      ViewRoom

      -

      Triggered when the user changes rooms.

      - - - - - - - - - - - - - - - - - + +
      PropertyDescriptionType
      activeSpaceactive space when user navigated to the room. - -
        +
      • + + Facebook: Social login using Facebook. + +
      • - Home: Active space is Home. + GitHub: Social login using GitHub.
      • - Private: Active space is a private space. + GitLab: Social login using GitLab.
      • - Public: Active space is a public space. + Google: Social login using Google.
      • - Meta: Active space is a meta space. + SSO: Registration using another SSO provider. + +
        • + +
      • + + Other: Registration using some other mechanism such as fallback.
        • @@ -754,790 +873,628 @@

        ViewRoom
      isDMWhether the room is a DM.
      +
      + +
      +

      PerformanceTimer

      +

      Triggered after timing an operation in the app.

      + + + + + + + + + + + + + - - + + - - + + + + + + + + + + + +
      PropertyDescriptionType
      contextClient defined, can be used for debugging. - boolean + string
      isSpaceWhether the room is a Space.itemCountClient defined, an optional value to indicate how many items were handled during the operation. - boolean + integer
      triggerThe reason for the room change if known.nameThe timer that is being reported.
      • - Created: Room accessed due to being just created. + 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.
      • - RoomList: Room accessed via the room list. + 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.
      • - RoomDirectory: Room accessed via the public rooms directory. + StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store.
      • - SpaceHierarchy: Room accessed via the space hierarchy view. + 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
      • - Timeline: Room accessed via a timeline pill or link in another room. + StartupLaunchScreen: How long the app launch screen is displayed for.
      • - Notification: Room accessed via a push/desktop notification. + InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
      • - Tombstone: Room accessed via a tombstone at the bottom of a predecessor room. + InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
      • - Predecessor: Room accessed via the predecessor link at the top of the upgraded room. + NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification.
        • +
      + +
      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 + +
      +
      + +
      +

      CryptoSessionState

      +

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

      + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      recoveryState + +
        +
      • - Widget: Room switched due to widget interaction. + Enabled: Secret storage is set up and we have all the secrets locally.
      • - MessageSearch: Room switched due to user interacting with a message search result. + Disabled: No default secret storage key exists or it is disabled explicitly using the account data event.
      • - MessageUser: Room switched due to user selecting a user to go to a DM with. + Incomplete: Secret storage is set up but we're missing some secrets.
        • +
      + +
      verificationState + +
        +
      • - VerificationRequest: Room switched due to user interacting with incoming verification request. + Verified: The device is considered to be verified, it has been signed by its user identity.
      • - SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto. + NotVerified: The device is unverified.
        • +
      + +
      +
      + +
      +

      $screen

      +

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

      + + + + + + + + + + + + + + + + + + + + - - - - - - - - - -
      PropertyDescriptionType
      durationMsHow long the screen was displayed for in milliseconds. + + integer + +
      screenName + +
        +
      • - Shortcut: Room accessed via a shortcut. + Home: The Home tab on iOS | possibly the same on Android?
      • - WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel. + Welcome: The splash screen.
      • - WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages. + Login: The screen that displays the login flow (when the user already has an account).
      • - WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list. + ForgotPassword: The form for the forgot password use case.
      • - WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu. + Register: The screen that displays the registration flow (when the user wants to create an account).
      • - WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop. + Room: The screen that displays the messages and events received in a room.
      • - WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop. + RoomDetails: The screen shown when tapping the name of a room from the Room screen.
      • - WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal. + RoomMembers: The screen that displays the list of members that are part of a room.
      • - WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal. + User: A screen that shows information about a room member.
      • - WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop. + RoomSearch: The screen that allows you to search for messages/files in a specific room.
      • - WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop. + RoomUploads: The screen that allows you to see all of the files sent in a specific room.
      • - WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop. + RoomSettings: The settings screen shown from the Room Details screen.
      • - WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
      • - WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop. + RoomAddresses: The room addresses screen shown from the Room Details screen.
      • - WebThreadsActivityCentre: Room accessed via interacting with the Threads Activity Centre in Element Web/Desktop. + RoomPermissions: The roles permissions screen shown from the Room Details screen.
      • - MobileFileSearch: Room switched due to user interacting with a file search result. + RoomDirectory: The screen that lists public rooms for you to discover.
      • - MobileRoomSearch: Room switched due to user interacting with a room search result. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
      • - MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen. + StartChat: The screen shown to create a new direct room.
      • - MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen. + CreateRoom: The screen shown to create a new (non-direct) room.
      • - MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen. + DeactivateAccount: The confirmation screen shown before deactivating an account.
      • - MobileInCall: Room accessed via interacting with the incall screen. + Group: Legacy: The screen that shows information about a specific group.
      • - MobileSpaceMenu: Space accessed via interacting with the space menu. + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
      • - MobileSpaceSettings: Space accessed via interacting with a space settings menu item. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space.
      • - MobileRoomPreview: Room accessed via preview. + Sidebar: The sidebar shown on mobile with spaces, settings etc.
      • - MobilePermalink: Room accessed via link. + Favourites: The Favourites tab on mobile that lists your favourite people/rooms.
      • - MobileLinkShare: Room accessed during external sharing. + People: The People tab on mobile that lists all the DM rooms you have joined.
      • - MobileExploreRooms: Room accessed via space explore. + Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined.
      • - MobileSpaceMembers: Room accessed via space members list. + Dialpad: The tab on mobile that displays the dialpad.
      • - MobileSpaceBottomSheet: Room accessed via space bottom sheet list. + SearchRooms: The Rooms tab shown in the global search screen on Mobile.
        • -
      - -
      viaKeyboardWhether the interaction was performed via the keyboard input. - - boolean - -
      -
      - -
      -

      NotificationTroubleshoot

      -

      Triggered when the user runs the troubleshoot notification test suite.

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

      PinUnpinAction

      -

      Triggered when the users pin or unpins a message.

      - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      fromFrom where the action is triggered. - -
        -
      • - Timeline: Action triggered from the timeline. + SearchMessages: The Messages tab shown in the global search screen on Mobile.
      • - MessagePinningList: Action triggered from the menu item in message pinning list. + SearchPeople: The People tab shown in the global search screen on Mobile.
      • - UnpinAll: Action triggered from the Unpin all button in message pinning list. + SearchFiles: The Files tab shown in the global search screen on Mobile.
        • -
      - -
      kindIs pin or unpin. - -
        -
      • - Pin: Pin a message. + SwitchDirectory: The screen shown to select which room directory you'd like to use.
      • - Unpin: Unpin a message. + InviteFriends: The screen shown to share a link to download the app.
        • -
      - -
      -
      - -
      -

      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 - -
      -
      - -
      -

      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 - -
      -
      - -
      -

      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. + Breadcrumbs: The screen that displays the user's breadcrumbs.
      • - Bubble: Bubble layout. + Settings: The global settings screen shown in the app.
      • - Group: Modern layout. + SettingsSecurity: The global security settings screen.
      • - Compact: Modern layout with compact option enabled. + SettingsDefaultNotifications: The settings screen to change the default notification options.
        • -
      - -
      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. + SettingsGeneral: The settings screen with general profile settings.
      • - Unreads: Filters are activated and Unreads is selected. + NotificationTroubleshoot: The screen containing tests to help user to fix issues around notifications.
      • - Favourites: Filters are activated and Favourites is selected. + SettingsNotifications: The notifications settings screen.
      • - People: Filters are activated and People is selected. + SettingsPreferences: The preferences screen (theme, language, editor preferences, etc.
        • -
      - -
      ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. - -
        -
      • - PersonalMessaging: The first option, Friends and family. + SettingsVoiceVideo: The calls settings screen.
      • - WorkMessaging: The second option, Teams. + SettingsIgnoredUsers: The settings screen with list of the ignored users.
      • - CommunityMessaging: The third option, Communities. + SettingsLabs: The experimental features settings screen.
      • - Skip: The footer option to skip the question. + SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules).
        • -
      - -
      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. - -
        -
      • - Enabled: Secret storage is set up and we have all the secrets locally. + SettingsHelp: The Help and About screen.
      • - Disabled: No default secret storage key exists or it is disabled explicitly using the account data event. + SettingsLegals: The settings screen with legals information.
      • - Incomplete: Secret storage is set up but we're missing some secrets. + SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords.
        • -
      - -
      verificationStateDescribe the current session verification state, that is if the session is verified or not. - -
        +
      • + + SpaceMenu: The bottom sheet that list all space options. + +
      • - Verified: The device is considered to be verified, it has been signed by its user identity. + SpaceMembers: Screen that displays the list of members of a space.
      • - NotVerified: The device is unverified. + RoomPreview: Screen that displays room preview if user hasn't joined yet.
        • -
      - -
      -
      - -
      -

      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. - -
        +
      • + + ThreadList: Screen that displays list of threads for a room. + +
      • - Password: Registration with a username and password. + SpaceBottomSheet: Room accessed via space bottom sheet list.
      • - Apple: Social login using Apple. + Invites: Room accessed via space bottom sheet list.
      • - Facebook: Social login using Facebook. + CreateSpace: The screen shown to create a new space.
      • - GitHub: Social login using GitHub. + LocationSend: The screen shown to share location.
      • - GitLab: Social login using GitLab. + LocationView: The screen shown to view a shared location.
      • - Google: Social login using Google. + CreatePollView: The screen shown to create a poll.
      • - SSO: Registration using another SSO provider. + EditPollView: The screen shown to edit a poll.
      • - Other: Registration using some other mechanism such as fallback. + RoomCall: The user has started or joined a call in a room.
        • @@ -1551,8 +1508,8 @@

        Signup

        -

        PermissionChanged

        -

        Triggered when the user changes a permission status.

        +

        WebSearch

        +

        Triggered when the user searches rooms.

        @@ -1564,29 +1521,31 @@

        PermissionChanged

        - - + + - - + + + + + + + + @@ -1596,8 +1555,8 @@

        PermissionChanged

        -

        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.

        +

        WebPanelResize

        +

        Triggered when the user resizes a layout panel.
        grantedWhether the permission has been granted by the user.numResultsHow many results the user got to their query. - boolean + integer
        permissionThe name of the permission.queryLengthThe length of the user's query. - -
          - -
        • - - Notification: Permissions related to sending notifications have changed. - -
          • - -
        + + integer + +
        viaSpotlightWhether the user is using the new search experience beta. + + boolean
        @@ -1609,75 +1568,57 @@

        SuperProperties

        - - + + + + + + + + - - - - - - - - + + @@ -1701,8 +1642,8 @@

        SuperProperties

        -

        Composer

        -

        Triggered when the user sends a message via the composer.

        +

        CreatedRoom

        +

        Triggered when the user creates a room.
        appPlatformUsed as a discriminant to breakdown usage per client.panelThe panel that was resized.
        • - Web Platform: Element Web platform. - -
          • - -
        • - - Electron Platform: Element Desktop platform. - -
          • - -
        • - - EI: Element iOS platform. + right
          • -
        • - - EXI: Element-X iOS platform. - -
          • +
        + +
        roomTypeThe type of room the user is viewing when resizing the panel. + +
        • - EA: Element Android platform. + video_room
        • - EXA: Element-X Android platform. + maximised_widget
        • - Other: Other Platform. + user_profile
          • -
        - -
        cryptoSDKWhich crypto backend is the client currently using. - -
          -
        • - Legacy: Legacy crypto backend specific to each platform. + space
        • - Rust: Cross-platform crypto backend written in Rust. + other_room
          • @@ -1687,11 +1628,11 @@

          SuperProperties

        cryptoSDKVersionVersion of the crypto backend.sizeThe size to which the user has resized the panel in pixels. - string + integer
        @@ -1714,18 +1655,8 @@

        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.isDMWhether the room is a DM. boolean @@ -1733,663 +1664,721 @@

        Composer
        isReplyWhether the user's composer interaction was a reply to a previously sent event. - - boolean - -
        +
        + +
        +

        $pageview

        +

        Triggered when the user changed screen on Element Web/Desktop

        + + + + + + + + + - - + + - - - - - - - - - -
        PropertyDescriptionType
        messageTypeThe type of the message.$current_url
        • - Text: A text message. - -
          • - -
        • - - LocationPin: A pin drop location message. + Home: Home page.
        • - LocationUser: A user current location message. + Welcome: The splash screen.
        • - Poll: A poll message. + Login: The screen that displays the login flow (when the user already has an account).
        • - VoiceMessage: A voice message. + ForgotPassword: The form for the forgot password use case
          • -
        - -
        startsThreadWhether this message begins a new thread or not. - - 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 + Register: The screen that displays the registration flow (when the user wants to create an account)
        • - Keyboard + UseCaseSelection: The screen where users choose their expected use case for Element.
        • - Touch + Room: The screen that displays the messages and events received in a room.
          • -
        - -
        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. + RoomDetails: The screen shown when tapping the name of a room from the Room screen.
        • - WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop. + RoomMembers: The screen that displays the list of members that are part of a room.
        • - WebSettingsNotificationsShowBoldToggle: User toggled the 'Notifications.showbold' in Element Web/Desktop. + User: A screen that shows information about a room member.
        • - WebSettingsNotificationsTACOnlyNotificationsToggle: User toggled the 'Notifications.tac_only_notifications' in Element Web/Desktop. + RoomSearch: The screen that allows you to search for messages/files in a specific room.
        • - WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via 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.
        • - WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
        • - WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop. + RoomDirectory: The screen that lists public rooms for you to discover.
        • - WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
        • - WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop. + StartChat: The screen shown to create a new direct room.
        • - WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop. + CreateRoom: The screen shown to create a new (non-direct) room.
        • - WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop. + DeactivateAccount: The confirmation screen shown before deactivating an account.
        • - WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop. + Group: Legacy: The screen that shows information about a specific group.
        • - WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop. + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
        • - WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space
        • - WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of Element Web/Desktop. + Loading: Screen showing loading spinner.
        • - WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop. + CompleteSecurity: Screen showing flow to trust this new device with cross-signing.
        • - WebRoomListRoomTileContextMenuMarkRead: User marked a message as read using the context menu on a room tile in the room list in Element Web/Desktop. + E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account.
        • - WebRoomListRoomTileContextMenuMarkUnread: User marked a room as unread using the context menu on a room tile in the room list in Element Web/Desktop. + SoftLogout: Screen showing device has been soft logged out by the server.
        • - WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop. + UserSettings: Screen showing User Settings (unknown tab).
        • - 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. + UserSettingsGeneral: Screen showing User Settings General Tab.
        • - WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop. + UserSettingsAppearance: Screen showing User Settings Appearance Tab.
        • - WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop. + UserSettingsNotifications: Screen showing User Settings Notifications Tab.
        • - WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop. + UserSettingsPreferences: Screen showing User Settings Preferences Tab.
        • - WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop. + UserSettingsKeyboard: Screen showing User Settings Keyboard Tab.
        • - WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop. + UserSettingsSidebar: Screen showing User Settings Sidebar Tab.
        • - WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop. + UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab.
        • - WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop. + UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab.
        • - WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop. + UserSettingsLabs: Screen showing User Settings Labs Tab.
        • - WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop. + UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab.
        • - WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop. + UserSettingsHelpAbout: Screen showing User Settings Help & About Tab.
        • - WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop. + UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab.
        • - WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop. + UserSettingFlair: Legacy: screen showing User Settings Flair Tab.
        • - WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop. + RoomSettings: Screen showing Room Settings (unknown tab).
        • - WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop. + RoomSettingsGeneral: Screen showing Room Settings General Tab.
        • - WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop. + RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab.
        • - WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop. + RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab.
        • - WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop. + RoomSettingsNotifications: Screen showing Room Settings Notifications Tab.
        • - WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop. + RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab.
        • - WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop. + RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab.
        • - WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop. + UnifiedSearch: Screen showing the new unified search modal (Project Spotlight).
        • - WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop. + FavouriteMessages: Screen showing all messages that have been added to favourites.
        • - WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop. + ConfirmStartup: Screen showing that the app is already running in another window.
        • - WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop. + SessionLockStolen: Screen showing that the app has been started in another window.
          • +
        + +
        durationMsHow long the screen took to load, if applicable. + + integer + +
        +
        + +
        +

        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 + +
        +
        + +
        +

        ViewRoom

        +

        Triggered when the user changes rooms.

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
        PropertyDescriptionType
        activeSpaceactive space when user navigated to the room. + +
          +
        • - WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the room list header in Element Web/Desktop. + Home: Active space is Home.
        • - WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop. + Private: Active space is a private space.
        • - WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop. + Public: Active space is a public space.
        • - WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop. + Meta: Active space is a meta space.
          • +
        + +
        isDMWhether the room is a DM. + + boolean + +
        isSpaceWhether the room is a Space. + + boolean + +
        triggerThe reason for the room change if known. + +
          +
        • - WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop. + Created: Room accessed due to being just created.
        • - WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop. + RoomList: Room accessed via the room list.
        • - WebThreadsActivityCentreButton: User clicked on the Threads Activity Centre button of Element Web/Desktop. + RoomDirectory: Room accessed via the public rooms directory.
        • - WebThreadsActivityCentreRoomItem: User clicked on a room in the Threads Activity Centre of Element Web/Desktop. + SpaceHierarchy: Room accessed via the space hierarchy view.
        • - WebThreadsMarkAllReadButton: User clicked on the button to mark all threads in a room as read in Element Web/Desktop. + Timeline: Room accessed via a timeline pill or link in another room.
        • - WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop. + Notification: Room accessed via a push/desktop notification.
        • - WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop. + Tombstone: Room accessed via a tombstone at the bottom of a predecessor room.
        • - WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop. + Predecessor: Room accessed via the predecessor link at the top of the upgraded room.
        • - WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop. + Widget: Room switched due to widget interaction.
        • - WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop. + MessageSearch: Room switched due to user interacting with a message search result.
        • - WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop. + MessageUser: Room switched due to user selecting a user to go to a DM with.
        • - WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop. + VerificationRequest: Room switched due to user interacting with incoming verification request.
        • - WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop. + SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto.
        • - PinnedMessageBannerClick: User clicked on the pinned message banner on Mobile and Element Web/Desktop. + Shortcut: Room accessed via a shortcut.
        • - PinnedMessageBannerViewAllButton: User clicked on the View all button in the pinned message banner on Mobile and Element Web/Desktop. + WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel.
        • - PinnedMessageBannerCloseListButton: User clicked on the Close list button in the pinned message banner on Mobile and Element Web/Desktop. + WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages.
        • - PinnedMessageListViewTimeline: User clicked on the View in timeline button in the pinned message list on Mobile and Element Web/Desktop. + WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list.
        • - PinnedMessageRoomInfoButton: User clicked on the Pinned messages menu item from the Room Info on Mobile and Element Web/Desktop. + WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu.
        • - PinnedMessageStateEventClick: User clicked on the Pinned messages state event in the timeline on Mobile and Element Web/Desktop. + WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop.
        • - SpacePanelSelectedSpace: User tapped the already selected space from the space list. + WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop.
        • - SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur. + WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal.
        • - SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur. + WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal.
        • - MobileRoomLeave: User tapped on Leave Room button on Room Details screen. + WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop.
        • - MobileRoomAddHome: User tapped on Add to Home button on Room Details screen. + WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop.
        • - MobileRoomFavouriteToggle: User switched the favourite toggle on Room Details screen. + WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop.
        • - MobileRoomThreadListButton: User tapped on Threads button on Room screen. + WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop.
        • - MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen. + WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop.
        • - MobileRoomComposerFormattingEnabled: The user enabled the formatting options on the message composer. + WebThreadsActivityCentre: Room accessed via interacting with the Threads Activity Centre in Element Web/Desktop.
        • - MobileRoomCallButton: The user tapped the room's call button. + MobileFileSearch: Room switched due to user interacting with a file search result.
        • - MobileThreadListThreadItem: User selected a thread on ThreadList screen. + MobileRoomSearch: Room switched due to user interacting with a room search result.
        • - MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen. + MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen.
        • - MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings. + MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen.
        • - MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings. + MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen.
        • - MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings. + MobileInCall: Room accessed via interacting with the incall screen.
        • - MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings. + MobileSpaceMenu: Space accessed via interacting with the space menu.
        • - MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab. + MobileSpaceSettings: Space accessed via interacting with a space settings menu item.
        • - MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab. + MobileRoomPreview: Room accessed via preview.
        • - MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab. + MobilePermalink: Room accessed via link.
        • - MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab. + MobileLinkShare: Room accessed during external sharing.
        • - MobileSpaceCreationValidated: User validated the creation of a new space. + MobileExploreRooms: Room accessed via space explore.
        • - MobileRoomListRoomContextMenuUnreadToggle: User adjusted their unread rooms using the context menu on a room in the room list. + MobileSpaceMembers: Room accessed via space members list.
        • - MobileRoomListRoomContextMenuFavouriteToggle: User adjusted their favourite rooms using the context menu on a room in the room list. + MobileSpaceBottomSheet: Room accessed via space bottom sheet list.
          • @@ -2398,26 +2387,9 @@

          Interaction
        -
        - -
        -

        CreatedRoom

        -

        Triggered when the user creates a room.

        - - - - - - - - - - - - + +
        PropertyDescriptionType
        isDMWhether the room is a DM.viaKeyboardWhether the interaction was performed via the keyboard input. boolean @@ -2430,8 +2402,8 @@

        CreatedRoom

        -

        $pageview

        -

        Triggered when the user changed screen on Element Web/Desktop

        +

        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.

        @@ -2443,309 +2415,450 @@

        $pageview

        - - + + + + + + + + + + + + + + + + + +
        $current_urlappPlatformUsed as a discriminant to breakdown usage per client.
        • - Home: Home page. - -
          • - -
        • - - Welcome: The splash screen. - -
          • - -
        • - - Login: The screen that displays the login flow (when the user already has an account). - -
          • - -
        • - - ForgotPassword: The form for the forgot password use case - -
          • - -
        • - - Register: The screen that displays the registration flow (when the user wants to create an account) - -
          • - -
        • - - UseCaseSelection: The screen where users choose their expected use case for Element. - -
          • - -
        • - - Room: The screen that displays the messages and events received in a room. - -
          • - -
        • - - RoomDetails: The screen shown when tapping the name of a room from the Room screen. - -
          • - -
        • - - RoomMembers: The screen that displays the list of members that are part of a room. - -
          • - -
        • - - User: A screen that shows information about a room member. - -
          • - -
        • - - RoomSearch: The screen that allows you to search for messages/files in a specific room. - -
          • - -
        • - - RoomUploads: The screen that allows you to see all of the files sent in a specific room. + Web Platform: Element Web platform.
        • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + Electron Platform: Element Desktop platform.
        • - RoomDirectory: The screen that lists public rooms for you to discover. + EI: Element iOS platform.
        • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + EXI: Element-X iOS platform.
        • - StartChat: The screen shown to create a new direct room. + EA: Element Android platform.
        • - CreateRoom: The screen shown to create a new (non-direct) room. + EXA: Element-X Android platform.
        • - DeactivateAccount: The confirmation screen shown before deactivating an account. + Other: Other Platform.
          • -
        • - - Group: Legacy: The screen that shows information about a specific group. - -
          • +
        + +
        cryptoSDKWhich crypto backend is the client currently using. + +
        • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + Legacy: Legacy crypto backend specific to each platform.
        • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space + Rust: Cross-platform crypto backend written in Rust.
          • -
        • - - Loading: Screen showing loading spinner. - -
          • +
        + +
        cryptoSDKVersionVersion of the crypto backend. + + string + +
        +
        + +
        +

        JoinedRoom

        +

        Triggered when the user joins a room.

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        PropertyDescriptionType
        isDMWhether the room is a DM. + + boolean + +
        isSpaceWhether the room is a Space. + + boolean + +
        roomSizeThe size of the room. + +
        • - CompleteSecurity: Screen showing flow to trust this new device with cross-signing. + One
        • - E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account. + Two
        • - SoftLogout: Screen showing device has been soft logged out by the server. + ThreeToTen
        • - UserSettings: Screen showing User Settings (unknown tab). + ElevenToOneHundred
        • - UserSettingsGeneral: Screen showing User Settings General Tab. + OneHundredAndOneToAThousand
        • - UserSettingsAppearance: Screen showing User Settings Appearance Tab. + MoreThanAThousand
          • -
        • - - UserSettingsNotifications: Screen showing User Settings Notifications Tab. - -
          • +
        + +
        triggerThe trigger for a room being joined if known. + +
        • - UserSettingsPreferences: Screen showing User Settings Preferences Tab. + Invite: Room joined via an invite.
        • - UserSettingsKeyboard: Screen showing User Settings Keyboard Tab. + RoomPreview: Room joined via its preview.
        • - UserSettingsSidebar: Screen showing User Settings Sidebar Tab. + SlashCommand: Room joined via the /join slash command.
        • - UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab. + RoomDirectory: Room joined via the public rooms directory.
        • - UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab. + SpaceHierarchy: Room joined via the space hierarchy view.
        • - UserSettingsLabs: Screen showing User Settings Labs Tab. + Timeline: Room joined via a timeline pill or link in another room.
        • - UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab. + Notification: Room joined via a push/desktop notification.
        • - UserSettingsHelpAbout: Screen showing User Settings Help & About Tab. + MobilePermalink: Room joined via link.
          • +
        + +
        +
        + +
        +

        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. + +
          +
        • - UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab. + Notification: Permissions related to sending notifications have changed.
          • +
        + +
        +
        + +
        +

        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. + +
          +
        • - UserSettingFlair: Legacy: screen showing User Settings Flair Tab. + IRC: IRC layout.
        • - RoomSettings: Screen showing Room Settings (unknown tab). + Bubble: Bubble layout.
        • - RoomSettingsGeneral: Screen showing Room Settings General Tab. + Group: Modern layout.
        • - RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab. + 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 + +
        WebMetaSpacePeopleEnabledWhether the user has the people space enabled. + + boolean + +
        allChatsActiveFilterThe active filter in the All Chats screen. + +
          +
        • - RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab. + All: Filters are activated and All is selected.
        • - RoomSettingsNotifications: Screen showing Room Settings Notifications Tab. + Unreads: Filters are activated and Unreads is selected.
        • - RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab. + Favourites: Filters are activated and Favourites is selected.
        • - RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab. + People: Filters are activated and People is selected.
          • +
        + +
        ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. + +
          +
        • - UnifiedSearch: Screen showing the new unified search modal (Project Spotlight). + PersonalMessaging: The first option, Friends and family.
        • - FavouriteMessages: Screen showing all messages that have been added to favourites. + WorkMessaging: The second option, Teams.
        • - ConfirmStartup: Screen showing that the app is already running in another window. + CommunityMessaging: The third option, Communities.
        • - SessionLockStolen: Screen showing that the app has been started in another window. + Skip: The footer option to skip the question.
          • @@ -2755,8 +2868,8 @@

          $pageview

        durationMsHow long the screen took to load, if applicable.numFavouriteRoomsNumber of joined rooms the user has favourited. integer @@ -2764,49 +2877,66 @@

        $pageview
        -
        - -
        -

        CallError

        -

        Triggered when an error occurred in a call.

        - - - - - - - - - - - - + + - - + + - - + + @@ -2816,8 +2946,8 @@

        CallError

        -

        RoomModeration

        -

        Triggered when a moderation action is performed within a room.

        +

        Interaction

        +

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

        PropertyDescriptionType
        isVideoWhether its a video call or not.numSpacesNumber of spaces (and sub-spaces) the user is joined to. - boolean + integer
        numParticipantsNumber of participants in the call.recoveryStateDescribe the current session recovery state, that if 4S is setup, complete (all secrets cached) or not. - - integer + +
          + +
        • + + Enabled: Secret storage is set up and we have all the secrets locally. + +
          • + +
        • + + 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. + +
          • + +
        placedWhether this user placed it.verificationStateDescribe the current session verification state, that is if the session is verified or not. - - boolean + +
          + +
        • + + Verified: The device is considered to be verified, it has been signed by its user identity. + +
          • + +
        • + + NotVerified: The device is unverified. + +
          • + +
        @@ -2829,599 +2959,583 @@

        RoomModeration

        - - + + + + + + + + + + + + + + - - - - - - - - - -
        actionThe action that was performed.indexThe index of the element, if its in a list of elements. + + integer + +
        interactionTypeThe manner with which the user activated the UI element.
        • - ChangeMemberRole: Changed a room member's power level. + Pointer
        • - KickMember: Kicked a room member. + Keyboard
        • - BanMember: Banned a room member. + Touch
          • +
        + +
        nameThe unique name of this element. + +
          +
        • - UnbanMember: Unbanned a room member. + WebRoomListRoomTileContextMenuFavouriteToggle: User adjusted their favourites using the context menu on a room tile in the room list in Element Web/Desktop.
        • - ChangePermissionsRoomName: Changed the power level required to set the room's name. + WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop.
        • - ChangePermissionsRoomAvatar: Changed the power level required to set the room's avatar. + WebSettingsNotificationsShowBoldToggle: User toggled the 'Notifications.showbold' in Element Web/Desktop.
        • - ChangePermissionsRoomTopic: Changed the power level required to set the room's topic. + WebSettingsNotificationsTACOnlyNotificationsToggle: User toggled the 'Notifications.tac_only_notifications' in Element Web/Desktop.
        • - ChangePermissionsSendMessages: Changed the power level required to send messages in the room. + WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via the context menu on a room tile in the room list in Element Web/Desktop.
        • - ChangePermissionsRedactMessages: Changed the power level required to redact messages in the room. + WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop.
        • - ChangePermissionsInviteUsers: Changed the power level required to invite users to the room. + WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop.
        • - ChangePermissionsKickMembers: Changed the power level required to kick room members. + WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop.
        • - ChangePermissionsBanMembers: Changed the power level required to ban room members. + WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop.
        • - ResetPermissions: Reset all of the room permissions back to their default values. + WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop.
          • -
        - -
        roleWhen the action sets a particular power level, this is the suggested role for that the power level. - -
          +
        • + + WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop. + +
        • - Administrator: A power level of 100. + WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop.
        • - Moderator: A power level of 50. + WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop.
        • - User: A power level of 0. + WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop.
        • - Other: Any other power level. + WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of 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 - -
          +
        • + + WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop. + +
        • - Home: The Home tab on iOS | possibly the same on Android? + WebRoomListRoomTileContextMenuMarkRead: User marked a message as read using the context menu on a room tile in the room list in Element Web/Desktop.
        • - Welcome: The splash screen. + WebRoomListRoomTileContextMenuMarkUnread: User marked a room as unread using 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). + WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop.
        • - ForgotPassword: The form for the forgot password use case. + 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.
        • - Register: The screen that displays the registration flow (when the user wants to create an account). + WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop.
        • - Room: The screen that displays the messages and events received in a room. + WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop.
        • - RoomDetails: The screen shown when tapping the name of a room from the Room screen. + WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop.
        • - RoomMembers: The screen that displays the list of members that are part of a room. + WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop.
        • - User: A screen that shows information about a room member. + WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop.
        • - RoomSearch: The screen that allows you to search for messages/files in a specific room. + WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop.
        • - RoomUploads: The screen that allows you to see all of the files sent in a specific room. + WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop.
        • - RoomSettings: The settings screen shown from the Room Details screen. + WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop.
        • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop.
        • - RoomAddresses: The room addresses screen shown from the Room Details screen. + WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop.
        • - RoomPermissions: The roles permissions screen shown from the Room Details screen. + WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop.
        • - RoomDirectory: The screen that lists public rooms for you to discover. + WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop.
        • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop.
        • - StartChat: The screen shown to create a new direct room. + WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop.
        • - CreateRoom: The screen shown to create a new (non-direct) room. + WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop.
        • - DeactivateAccount: The confirmation screen shown before deactivating an account. + WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop.
        • - Group: Legacy: The screen that shows information about a specific group. + WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop.
        • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop.
        • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space. + WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop.
        • - Sidebar: The sidebar shown on mobile with spaces, settings etc. + WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop.
        • - Favourites: The Favourites tab on mobile that lists your favourite people/rooms. + WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop.
        • - People: The People tab on mobile that lists all the DM rooms you have joined. + WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop.
        • - Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined. + WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop.
        • - Dialpad: The tab on mobile that displays the dialpad. + WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms 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. + WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop.
        • - SearchMessages: The Messages tab shown in the global search screen on Mobile. + WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop.
        • - SearchPeople: The People tab shown in the global search screen on Mobile. + WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop.
        • - SearchFiles: The Files tab shown in the global search screen on Mobile. + WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop.
        • - SwitchDirectory: The screen shown to select which room directory you'd like to use. + WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop.
        • - InviteFriends: The screen shown to share a link to download the app. + WebThreadsActivityCentreButton: User clicked on the Threads Activity Centre button of Element Web/Desktop.
        • - Breadcrumbs: The screen that displays the user's breadcrumbs. + WebThreadsActivityCentreRoomItem: User clicked on a room in the Threads Activity Centre of Element Web/Desktop.
        • - Settings: The global settings screen shown in the app. + WebThreadsMarkAllReadButton: User clicked on the button to mark all threads in a room as read in Element Web/Desktop.
        • - SettingsSecurity: The global security settings screen. + WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop.
        • - SettingsDefaultNotifications: The settings screen to change the default notification options. + WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop.
        • - SettingsGeneral: The settings screen with general profile settings. + WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop.
        • - NotificationTroubleshoot: The screen containing tests to help user to fix issues around notifications. + WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop.
        • - SettingsNotifications: The notifications settings screen. + WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop.
        • - SettingsPreferences: The preferences screen (theme, language, editor preferences, etc. + WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop.
        • - SettingsVoiceVideo: The calls settings screen. + WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop.
        • - SettingsIgnoredUsers: The settings screen with list of the ignored users. + WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop.
        • - SettingsLabs: The experimental features settings screen. + PinnedMessageBannerClick: User clicked on the pinned message banner on Mobile and Element Web/Desktop.
        • - SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules). + PinnedMessageBannerViewAllButton: User clicked on the View all button in the pinned message banner on Mobile and Element Web/Desktop.
        • - SettingsHelp: The Help and About screen. + PinnedMessageBannerCloseListButton: User clicked on the Close list button in the pinned message banner on Mobile and Element Web/Desktop. + +
          • + +
        • + + PinnedMessageListViewTimeline: User clicked on the View in timeline button in the pinned message list on Mobile and Element Web/Desktop. + +
          • + +
        • + + PinnedMessageRoomInfoButton: User clicked on the Pinned messages menu item from the Room Info on Mobile and Element Web/Desktop. + +
          • + +
        • + + PinnedMessageStateEventClick: User clicked on the Pinned messages state event in the timeline on Mobile and Element Web/Desktop. + +
          • + +
        • + + SpacePanelSelectedSpace: User tapped the already selected space from the space list. + +
          • + +
        • + + SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur. + +
          • + +
        • + + SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur. + +
          • + +
        • + + MobileRoomLeave: User tapped on Leave Room button on Room Details screen.
        • - SettingsLegals: The settings screen with legals information. + MobileRoomAddHome: User tapped on Add to Home button on Room Details screen.
        • - SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords. + MobileRoomFavouriteToggle: User switched the favourite toggle on Room Details screen.
        • - SpaceMenu: The bottom sheet that list all space options. + MobileRoomThreadListButton: User tapped on Threads button on Room screen.
        • - SpaceMembers: Screen that displays the list of members of a space. + MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen.
        • - RoomPreview: Screen that displays room preview if user hasn't joined yet. + MobileRoomComposerFormattingEnabled: The user enabled the formatting options on the message composer.
        • - ThreadList: Screen that displays list of threads for a room. + MobileRoomCallButton: The user tapped the room's call button.
        • - SpaceBottomSheet: Room accessed via space bottom sheet list. + MobileThreadListThreadItem: User selected a thread on ThreadList screen.
        • - Invites: Room accessed via space bottom sheet list. + MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen.
        • - CreateSpace: The screen shown to create a new space. + MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings.
        • - LocationSend: The screen shown to share location. + MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings.
        • - LocationView: The screen shown to view a shared location. + MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings.
        • - CreatePollView: The screen shown to create a poll. + MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings.
        • - EditPollView: The screen shown to edit a poll. + MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab.
        • - RoomCall: The user has started or joined a call in a room. + MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab.
          • -
        - -
        -
        - -
        -

        CryptoSessionState

        -

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

        - - - - - - - - - - - - - - - - - - - -
        PropertyDescriptionType
        recoveryState - -
          -
        • - Enabled: Secret storage is set up and we have all the secrets locally. + MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab.
        • - Disabled: No default secret storage key exists or it is disabled explicitly using the account data event. + MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab.
        • - Incomplete: Secret storage is set up but we're missing some secrets. + MobileSpaceCreationValidated: User validated the creation of a new space.
          • -
        - -
        verificationState - -
          -
        • - Verified: The device is considered to be verified, it has been signed by its user identity. + MobileRoomListRoomContextMenuUnreadToggle: User adjusted their unread rooms using the context menu on a room in the room list.
        • - NotVerified: The device is unverified. + MobileRoomListRoomContextMenuFavouriteToggle: User adjusted their favourite rooms using the context menu on a room in the room list.
          • @@ -3435,55 +3549,8 @@

          CryptoSessionState

          -

          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 - -
          -
          - -
          -

          PerformanceTimer

          -

          Triggered after timing an operation in the app.

          +

          SlashCommand

          +

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

          @@ -3495,77 +3562,21 @@

          PerformanceTimer

          - - - - - - - - - - - - - - + + - - - - - -
          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.commandThe name of this command.
          • - 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. - -
            • - -
          • - - 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. - -
            • - -
          • - - StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store. - -
            • - -
          • - - 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 - -
            • - -
          • - - StartupLaunchScreen: How long the app launch screen is displayed for. - -
            • - -
          • - - InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. - -
            • - -
          • - - InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. + Part
          • - NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification. + Invite
            • @@ -3574,23 +3585,13 @@

            PerformanceTimer
          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).

          +

          PollCreation

          +

          Triggered when a poll is created or edited.

          @@ -3602,27 +3603,21 @@

          UnauthenticatedError

          - - + + - - + + - - + + + +
          errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver.actionWhether this poll has been created or edited.
          • - M_UNKNOWN - -
            • - -
          • - - M_FORBIDDEN + Create: Newly created poll.
          • - M_UNKNOWN_TOKEN + Edit: Edit of an existing poll.
            • @@ -3632,28 +3627,45 @@

            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.isUndisclosedWhether this poll is undisclosed. - string + boolean
          refreshTokenAuthWhether the auth mechanism is refresh-token-based.numberOfAnswersNumber of answers in the poll. - boolean + integer
          +
          + +
          +

          NotificationTroubleshoot

          +

          Triggered when the user runs the troubleshoot notification test suite.

          + + + + + + + + + + - - + +
          PropertyDescriptionType
          softLogoutWhether a soft logout or hard logout was triggered.hasErrorWhether one or more tests are in error. boolean