Application Messages between Client and Server

Description 📜

In this page we will describe all the messages that the client send to the Server and viceversa.

Client to Server 📨

When the client connects to the server, it sends a message indicating its running version to track the number of clients for each version connected simultaneously.

Connection Message Examples:

• Desktop App: {"type":"connection", "version": "desktop"} 🖥️
• Mobile App: {"type":"connection", "version": "app"} 📱
  
  

Login Message:

{"type":"login", "user":"userName", "password":"userPassword"} 🪪

When the client wants to display a message on the screen, it sends the following JSON, replacing "value" with the actual message:

Show Message Example:

{"type": "show", "value": "Hello World", "user": "userName"} 💬

Show Image Example:

{'type':'image', 'value': 'Base64image'} 🖼

Ask for active users:

{'type': 'usersList'} 👨‍👩‍👧‍👦❓

Server to Client 📨

Private

Message on connect:

{"type": "conexion"} 🌐

Login confirm/reject:

{"type":"login", "value":"true/false"} ✅/❌

Response To Active Users:

{'type': 'usersOnline', 'value': [{'id':{'plataforma': 'app', 'usuario': 'Ronald'}]👨‍👩‍👧‍👦

Broadcast

When Some User Connects:

{'type': 'connection', 'value': totalConnectionsNumber} ✅

When Some User Disconnects:

{'type': 'disconnection', 'value': totalConnectionsNumber} ❌

When Some User Sends A Message:

{'type': 'sendMessage', 'value': userName} 📨

Note: The program is under development, and its features may change in future updates. 🔧