User
====

.. _DataroomAccessType:
    
DataroomAccessType
------------------

Describes the access to a data room

.. code-block:: json

 enum DataroomAccessType {
  DATAROOM_ACCESS_TYPE_UNSPECIFIED = 0;
  // The user accepts the data room invitation
  DATAROOM_ACCESS_TYPE_ACCEPT = 1;

  // The user declines the data room invitation
  DATAROOM_ACCESS_TYPE_DECLINE = 2;

  // The user leaves the data room
  DATAROOM_ACCESS_TYPE_TERMINATE = 3;

  // The user accepted the data room invitation, but it is pending
  // admin final approval. This is only in E2EE data rooms where the invitee
  // didn't have a key pair during the invitation, then created the key pair
  // and is now waiting for the data room E2EE key to enter it.
  DATAROOM_ACCESS_TYPE_ACCEPT_PENDING_ADMIN_CONFIRMATION = 4;
 }

+------------------------------------------------------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Value                                                      | Tag   | Description                                                                                                                                                                                                                                                                    |
+============================================================+=======+================================================================================================================================================================================================================================================================================+
| ``DATAROOM_ACCESS_TYPE_UNSPECIFIED``                       | ``0`` | The user accepts the data room invitation.                                                                                                                                                                                                                                     |
+------------------------------------------------------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``DATAROOM_ACCESS_TYPE_DECLINE``                           | ``1`` | The user declines the data room invitation.                                                                                                                                                                                                                                    |
+------------------------------------------------------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``DATAROOM_ACCESS_TYPE_TERMINATE``                         | ``2`` | The user leaves the data room.                                                                                                                                                                                                                                                 |
+------------------------------------------------------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``DATAROOM_ACCESS_TYPE_ACCEPT_PENDING_ADMIN_CONFIRMATION`` | ``3`` | The user accepted the data room invitation, but the final admin approval is pending. This only happens in E2EE data rooms where the invitee didn't have a key pair during the invitation, then created the key pair and is now waiting for the data room E2EE key to enter it. |
+------------------------------------------------------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. _DisclaimerState:

DisclaimerState
---------------

Defines the state of the disclaimer for the user

.. code-block:: json

 enum DisclaimerState {
  DISCLAIMER_STATE_UNSPECIFIED = 0;
  DISCLAIMER_STATE_ACCEPTED = 1;
  DISCLAIMER_STATE_DECLINED = 2;
 }

+----------------------------------+-------+-------------------------+
| Value                            | Tag   | Description             |
+==================================+=======+=========================+
| ``DISCLAIMER_STATE_UNSPECIFIED`` | ``0`` | Default.                |
+----------------------------------+-------+-------------------------+
| ``DISCLAIMER_STATE_ACCEPTED``    | ``1`` | Disclaimer is accepted. |
+----------------------------------+-------+-------------------------+
| ``DISCLAIMER_STATE_DECLINED``    | ``2`` | Disclaimer is declined. |
+----------------------------------+-------+-------------------------+

.. _UserSocketEvent:

UserSocketEvent
---------------

Used internally for client-server communication

.. code-block:: json

 enum UserSocketEvent {
  USER_SOCKET_EVENT_UNSPECIFIED = 0;
  USER_SOCKET_EVENT_SETTINGS_UPDATED = 1;
  USER_SOCKET_EVENT_DATAROOM_ADDED = 2;
  USER_SOCKET_EVENT_DATAROOM_REMOVED = 3;
  USER_SOCKET_EVENT_LOGOUT = 4;
  USER_SOCKET_EVENT_GROUP_ADDED = 5;
  USER_SOCKET_EVENT_GROUP_REMOVED = 6;
  USER_SOCKET_EVENT_DATAROOM_ADMIN_CHANGED = 7;
  USER_SOCKET_EVENT_DATAROOM_EXPORT_FINISHED = 8;
  USER_SOCKET_EVENT_FILES_AUTO_DELETED = 9;
 }

+------------------------------------------------+-------+-------------+
| Value                                          | Tag   | Description |
+================================================+=======+=============+
| ``USER_SOCKET_EVENT_UNSPECIFIED``              | ``0`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_SETTINGS_UPDATED``         | ``1`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_DATAROOM_ADDED``           | ``2`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_DATAROOM_REMOVED``         | ``3`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_LOGOUT``                   | ``4`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_GROUP_ADDED``              | ``5`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_GROUP_REMOVED``            | ``6`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_DATAROOM_ADMIN_CHANGED``   | ``7`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_DATAROOM_EXPORT_FINISHED`` | ``8`` |             |
+------------------------------------------------+-------+-------------+
| ``USER_SOCKET_EVENT_FILES_AUTO_DELETED``       | ``9`` |             |
+------------------------------------------------+-------+-------------+