• State management
  • Data models
    • Authentication
    • Account
    • Company
    • Workspace
    • Channel
    • Message
    • Globals
    • File
    • Notifications
    • SocketIO
    • Satellite models
  • Cubits
    • Authentication Cubit
    • Account Cubit
    • Companies Cubit
    • Workspaces Cubit
    • Channels Cubit
    • Messages Cubit
    • Badges Cubit
    • Mentions Cubit
    • File Cubit
  • Services
• Pages
• Widgets
• Miscellaneous

State management in Twake Mobile is handled via Cubits, which in itself is a subset of the BLoC pattern. The library used for this purpose is Flutter BLoC. For the insertion of the Cubits into the widget tree, the application makes use of the GetX library.

All the data the application works with is defined in data models, so everything is typed as much as possible, with minimal amount of dynamic data types. There are top level models (for describing entities) and also there's satellite models to represent nested data structures.

The model contains only JWToken pair and their expiration timestamps. It's used to hold the current (most recent JWToken pair), which in turn is used in Twake API requests.

Fields:

The model contains all the information about user (any user, not just the app user).

Fields:

The model contains all the information about a particular company, of which app user might have many.

Fields:

The model contains all the information about a particular workspace, there could be many workspaces in single company.

List of fields in Workspace model:

The model contains all the information about a channel (public/private/direct), public and private channels belong to particular workspace, while direct channels belong to particular company.

Fields

Getters:

The model contains all the information regarding a single message, message is agnostic of the fact where it was submitted: public, private, direct channel or in a thread. Thus the same model is used for messages everywhere.

Fields:

Note: either userId or appId should be present

Getters:

Another note: hash field is calulated as the sum of properties of the following fields:

• hashCode of id
• hashCode of content.originalStr
• sum of hashCodes of names of each reaction in reactions field
• sum of count of each reaction in reactions field

Example:

final hash = id.hashCode +
        content.originalStr.hashCode +
        reactions.fold(0, (acc, r) => r.name.hashCode + acc) +
        reactions.fold(0, (acc, r) => r.count + acc);

This class acts like big global variables storage, and keeps the following state.

List of getters/setters in Globals model:

Note: The model should be a globally accessable singleton. The class instance should be initialized before everything else, if the user has already logged into the app, in which case the previous state of the app should be available in local storage, otherwise the instance should be initialized before login by user with default data.

All the fields of the singleton instance should be kept up to date by other cubits, and the class itself is responsible for backing up all the changes to local storage

This model contains the information about files, either uploaded or the ones that can be downloaded.

Fields:

This model contains the information badge info: counters which are used to indicate the amount of unread messages on each level of hierarchy (company/workspace/channel)

Fields:

Methods:

Getters:

There two types of Notifications in Twake Mobile:

1. FirebaseNotification - received via Firebase Cloud Messaging service, used for notifications about new messages. In order to communicate with Firebase Cloud Messaging the application makes use of the official plugin.
2. LocalNotification - generated locally by the application itself. The plugin used for this purpose is Flutter local notification

Fields:

Fields:

Getters:

This section describes all the socketIO related data models which are received via socketIO channel, which is the primary way the application can be kept in realtime sync with the Twake server.

Fields:

{
    name: previous::channels/2982dc0a-65aa-47ae-a13c-082b2e3cc2a9/messages/updates, 
    data: {
        client_id: system, 
        action: update, 
        message_id: 5828c718-b49e-11eb-8ae0-0242ac120003, 
        thread_id: c920712e-b49d-11eb-8ed2-0242ac120003
    }
}

Fields:

Examples: Channel had some activity:

{
    action: updated, 
    room: /companies/ac1a0544-1dcc-11eb-bf9f-0242ac120004/workspaces/ae6e73e8-504e-11eb-9a9c-0242ac120004/channels?type=public, 
    type: channel_activity, 
    path: /companies/ac1a0544-1dcc-11eb-bf9f-0242ac120004/workspaces/ae6e73e8-504e-11eb-9a9c-0242ac120004/channels/2982dc0a-65aa-47ae-a13c-082b2e3cc2a9, 
    resource: {
        company_id: ac1a0544-1dcc-11eb-bf9f-0242ac120004, 
        workspace_id: ae6e73e8-504e-11eb-9a9c-0242ac120004, 
        id: 2982dc0a-65aa-47ae-a13c-082b2e3cc2a9, 
        last_activity: 1620987774000, 
        last_message: {
            date: 1620987774000, 
            sender: 46a68a02-1dcc-11eb-95bd-0242ac120004, 
            sender_name: First Last, 
            title: 📄 ch1 in TestCompany • WS1, text: Message 2
        }
    }
}

Channel was created in workspace:

{
    action: saved, 
    room: /companies/ac1a0544-1dcc-11eb-bf9f-0242ac120004/workspaces/ae6e73e8-504e-11eb-9a9c-0242ac120004/channels?type=public, 
    type: channel, 
    path: /companies/ac1a0544-1dcc-11eb-bf9f-0242ac120004/workspaces/ae6e73e8-504e-11eb-9a9c-0242ac120004/channels/2982dc0a-65aa-47ae-a13c-082b2e3cc2a9, 
    resource: {
        is_default: false, 
        archived: false, 
        members: [], 
        connectors: [], 
        last_activity: 1620987956000, 
        company_id: ac1a0544-1dcc-11eb-bf9f-0242ac120004, 
        workspace_id: ae6e73e8-504e-11eb-9a9c-0242ac120004, 
        id: 2982dc0a-65aa-47ae-a13c-082b2e3cc2a9, 
        archivation_date: 0, 
        channel_group: , 
        description: , 
        icon: 📄, 
        name: Primary channel, 
        owner: 46a68a02-1dcc-11eb-95bd-0242ac120004, 
        visibility: public
    }
}

Fields:

This enum describes all the possible values of that the visibility property of channel can take. Each field of this enum is JSON serializable/deserializable.

Possible values:

• public (JSON value 'public')
• private (JSON value 'private')
• direct (JSON value 'direct')

This a complementary model which is used to hold information about last message in a given channel. Also used to hold push notification data.

Fields:

Example JSON:

{
    "date": 1621233242000,
    "sender": "46a68a02-1dcc-11eb-95bd-0242ac120004",
    "sender_name": "Firstname Lastname",
    "title": "General in TestCompany • Analytics",
    "text": "some text"
}

This is a complementary model used to hold the content of the message which is composed of 2 parts:

1. The string input by the user
2. Parsed structure of the input + some additional elements (e.g. attachments)

Fields:

Note: prepared field should be parsed by special parser which understands the syntax used by twake, in order to convert it to list of WidgetSpans, for later rendering.

Complementary model to hold reaction to a particular message.

Fields:

This enum describes the current tab, that is selected on main screen. Each tab lists different types of channels: either directs or public/private (commons) Each field of this enum is JSON serializable/deserializable.

Possible values:

• commons (JSON value 'commons')
• directs (JSON value 'directs')

This enum describes the level at which the given badge counter holds the information about

Possible values:

• company (JSON value 'company')
• workspace (JSON value 'workspace')
• channel (JSON value 'channel')

Complementary model to hold the information, which is shown on notification area

Fields:

Complementary model to hold the data regarding the new unread message

Fields:

Getters:

This enum describes all the possible types that the local notification can be of. Each field of this enum is JSON serializable/deserializable. As the application evolves, new types might be added.

Possible values:

• message (JSON value 'message')
• file (JSON value 'file')

Complementary model to hold the data regarding the updated message, which is sent over socketIO channel.

Fields:

Enum, which describes all the possible actions which can be performed over the message (socketIO channel specific)

Possible values:

• remove (JSON value 'remove')
• update (JSON value 'update')

Enum, which describes all the possible actions which can be performed over the resource (socketIO channel specific)

Possible values:

• updated (JSON value 'updated')
• saved (JSON value 'saved')
• deleted (JSON value 'deleted')

Enum, which describes all the possible resources that can be updated over the socketIO channel

Possible values:

• channel (JSON value 'channel')
• channelMember (JSON value 'channel_member')
• channelActivity (JSON value 'channel_activity')

For the purposes of building a reactive UI, the application makes use of various cubits, each of which is responsible for updating particular subset of data.

This cubit is pretty straightforward and has the following tasks to perform:

• authenticate user
• keep the JWTokens fresh
• keep the JWToken in Globals updated
• logout user from system, cleaning up entire local storage

Methods:

States:

This cubit is responsible for 2 main features:

1. Retrieve and save user information for the Profile screen.
2. Fetching other users' available data for different purposes like search.

Methods:

States:

For now company management happens on console side, so this cubit is pretty simple. What it does:

• Fetch the list of available companies
• Manage companies selection
• Update Globals instance after selection

Methods:

States:

Task that are handled by this cubit:

• Fetching corresponding workspaces upon company selection
• Changing current workspace
• Update Globals accordingly
• Adding new workspaces (provided user has necessary permissions)
• Editing workspaces (including collaborators management)
• Removing workspace (provided user has necessary permissions)

It should be possible to switch workspace programmatically, most common case being user click on notification.

Methods:

States:

This cubit should manage everything related to channels, both public and private.

Task performed by this cubit:

• Fetching the list of channels after workspace selection
• Channel selection, to open the list of messages in it
• Channel creation (public/private)
• Channel edition
• Channels deletion

Methods:

States:

Same as Channels Cubit

Note: the socketIO streams in both cubits differ.

This cubit is one the most used ones, because it's responsible for managing messages.

Task performed by Messages Cubit:

• Loading the list of top levele messages in channel (public/private) or direct chats.
• Sending new messages
• Fetching messages on notification or socketIO event
• Editing the message
• Reacting to message
• Deleting message

Methods:

States: