Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions schemas/Screen.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@
"screenName": {
"type": "string",
"oneOf": [
{"const": "Welcome", "description": "The splash screen."},
{"const": "Login", "description": "The screen that displays the login flow (when the user already has an account)."},
{"const": "ForgotPassword", "description": "The form for the forgot password use case"},
{"const": "Register", "description": "The screen that displays the registration flow (when the user wants to create an account)"},

{"const": "Home", "description": "The Home tab on iOS | possibly the same on Android? | The Home space on Web?"},
{"const": "Room", "description": "The screen that displays the messages and events received in a room."},
{"const": "RoomDetails", "description": "The screen shown when tapping the name of a room from the Room screen."},
Expand All @@ -18,7 +23,8 @@
{"const": "RoomSettings", "description": "The settings screen shown from the Room Details screen."},
{"const": "RoomNotifications", "description": "The notifications settings screen shown from the Room Details screen."},
{"const": "RoomDirectory", "description": "The screen that lists public rooms for you to discover."},
{"const": "StartChat", "description": "The screen shown to create a new (non-direct) room."},
{"const": "RoomFilter", "description": "The screen that lists all the user's rooms and let them filter the rooms."},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure that this isn't the same view as MobileSearchRooms (which may be iOS only anyway) but pointing it out in case it is :)

I only ask as on iOS the rooms are filtered from the Home/MobileFavourites/MobilePeople/MobileRooms tabs so (I don't imagine) we wouldn't track this as a screen there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, on Android, rooms can be filtered using a dedicated screen (it will probably change in the future, IA is coming)

{"const": "StartChat", "description": "The screen shown to create a new direct room."},
{"const": "CreateRoom", "description": "The screen shown to create a new (non-direct) room."},
{"const": "Settings", "description": "The global settings screen shown in the app."},
{"const": "SettingsSecurity", "description": "The global security settings screen."},
Expand All @@ -32,18 +38,16 @@
{"const": "MobileFavourites", "description": "The Favourites tab on mobile that lists your favourite people/rooms."},
{"const": "MobilePeople", "description": "The People tab on mobile that lists all the DM rooms you have joined."},
{"const": "MobileRooms", "description": "The Rooms tab on mobile that lists all the (non-direct) rooms you've joined."},
{"const": "MobileDialpad", "description": "The tab on mobile that displays the dialpad."},
{"const": "MobileSearchRooms", "description": "The Rooms tab shown in the global search screen on Mobile."},
{"const": "MobileSearchMessages", "description": "The Messages tab shown in the global search screen on Mobile."},
{"const": "MobileSearchPeople", "description": "The People tab shown in the global search screen on Mobile."},
{"const": "MobileSearchFiles", "description": "The Files tab shown in the global search screen on Mobile."},
{"const": "MobileSwitchDirectory", "description": "The screen shown to select which room directory you'd like to use."},
{"const": "MobileInviteFriends", "description": "The screen shown to share a link to download the app."},
{"const": "MobileBreadcrumbs", "description": "The screen that displays the user's breadcrumbs."},

{"const": "WebLoading", "description": "?"},
{"const": "WebWelcome", "description": "?"},
{"const": "WebLogin", "description": "?"},
{"const": "WebRegister", "description": "?"},
{"const": "WebForgotPassword", "description": "?"},
{"const": "WebCompleteSecurity", "description": "?"},
{"const": "WebE2ESetup", "description": "?"},
{"const": "WebSoftLogout", "description": "?"}
Expand Down
51 changes: 33 additions & 18 deletions types/kotlin2/Screen.kt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ data class Screen(
*/
DeactivateAccount,

/**
* The form for the forgot password use case
*/
ForgotPassword,

/**
* Legacy: The screen that shows information about a specific group.
*/
Expand All @@ -53,6 +58,21 @@ data class Screen(
*/
Home,

/**
* The screen that displays the login flow (when the user already has an account).
*/
Login,

/**
* The screen that displays the user's breadcrumbs.
*/
MobileBreadcrumbs,

/**
* The tab on mobile that displays the dialpad.
*/
MobileDialpad,

/**
* The Favourites tab on mobile that lists your favourite people/rooms.
*/
Expand Down Expand Up @@ -108,6 +128,11 @@ data class Screen(
*/
MyGroups,

/**
* The screen that displays the registration flow (when the user wants to create an account)
*/
Register,

/**
* The screen that displays the messages and events received in a room.
*/
Expand All @@ -123,6 +148,11 @@ data class Screen(
*/
RoomDirectory,

/**
* The screen that lists all the user's rooms and let them filter the rooms.
*/
RoomFilter,

/**
* The screen that displays the list of members that are part of a room.
*/
Expand Down Expand Up @@ -169,7 +199,7 @@ data class Screen(
SettingsSecurity,

/**
* The screen shown to create a new (non-direct) room.
* The screen shown to create a new direct room.
*/
StartChat,

Expand All @@ -188,35 +218,20 @@ data class Screen(
*/
WebE2ESetup,

/**
* ?
*/
WebForgotPassword,

/**
* ?
*/
WebLoading,

/**
* ?
*/
WebLogin,

/**
* ?
*/
WebRegister,

/**
* ?
*/
WebSoftLogout,

/**
* ?
* The splash screen.
*/
WebWelcome,
Welcome,
}

override fun getName() = screenName.name
Expand Down
24 changes: 15 additions & 9 deletions types/swift/Screen.swift
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,18 @@ extension AnalyticsEvent {
case CreateRoom
/// The confirmation screen shown before deactivating an account.
case DeactivateAccount
/// The form for the forgot password use case
case ForgotPassword
/// Legacy: The screen that shows information about a specific group.
case Group
/// The Home tab on iOS | possibly the same on Android? | The Home space on Web?
case Home
/// The screen that displays the login flow (when the user already has an account).
case Login
/// The screen that displays the user's breadcrumbs.
case MobileBreadcrumbs
/// The tab on mobile that displays the dialpad.
case MobileDialpad
/// The Favourites tab on mobile that lists your favourite people/rooms.
case MobileFavourites
/// The screen shown to share a link to download the app.
Expand All @@ -63,12 +71,16 @@ extension AnalyticsEvent {
case MobileSwitchDirectory
/// Legacy: The screen that shows all groups/communities you have joined.
case MyGroups
/// The screen that displays the registration flow (when the user wants to create an account)
case Register
/// The screen that displays the messages and events received in a room.
case Room
/// The screen shown when tapping the name of a room from the Room screen.
case RoomDetails
/// The screen that lists public rooms for you to discover.
case RoomDirectory
/// The screen that lists all the user's rooms and let them filter the rooms.
case RoomFilter
/// The screen that displays the list of members that are part of a room.
case RoomMembers
/// The notifications settings screen shown from the Room Details screen.
Expand All @@ -87,7 +99,7 @@ extension AnalyticsEvent {
case SettingsMentionsAndKeywords
/// The global security settings screen.
case SettingsSecurity
/// The screen shown to create a new (non-direct) room.
/// The screen shown to create a new direct room.
case StartChat
/// A screen that shows information about a room member.
case User
Expand All @@ -96,17 +108,11 @@ extension AnalyticsEvent {
/// ?
case WebE2ESetup
/// ?
case WebForgotPassword
/// ?
case WebLoading
/// ?
case WebLogin
/// ?
case WebRegister
/// ?
case WebSoftLogout
/// ?
case WebWelcome
/// The splash screen.
case Welcome
}

public var properties: [String: Any] {
Expand Down
11 changes: 7 additions & 4 deletions types/typescript/Screen.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
export interface Screen {
eventName: "Screen";
screenName: (
| "Welcome"
| "Login"
| "ForgotPassword"
| "Register"
| "Home"
| "Room"
| "RoomDetails"
Expand All @@ -21,6 +25,7 @@ export interface Screen {
| "RoomSettings"
| "RoomNotifications"
| "RoomDirectory"
| "RoomFilter"
| "StartChat"
| "CreateRoom"
| "Settings"
Expand All @@ -34,17 +39,15 @@ export interface Screen {
| "MobileFavourites"
| "MobilePeople"
| "MobileRooms"
| "MobileDialpad"
| "MobileSearchRooms"
| "MobileSearchMessages"
| "MobileSearchPeople"
| "MobileSearchFiles"
| "MobileSwitchDirectory"
| "MobileInviteFriends"
| "MobileBreadcrumbs"
| "WebLoading"
| "WebWelcome"
| "WebLogin"
| "WebRegister"
| "WebForgotPassword"
| "WebCompleteSecurity"
| "WebE2ESetup"
| "WebSoftLogout"
Expand Down