Skip to content

Commit 297bbd8

Browse files
committed
Update docs
1 parent 4e0ab4b commit 297bbd8

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

backend/communication-service/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@
3030

3131
- Select the `Socket.IO` option and set URL to `http://localhost:3005`. Click `Connect`.
3232

33-
![image1.png](./docs/image1.png)
33+
![image1.png](./docs/images/postman-setup1.png)
3434

3535
- Add the following events in the `Events` tab and listen to them.
3636

37-
![image2.png](./docs/image2.png)
37+
![image2.png](./docs/images/postman-setup2.png)
3838

3939
- To send a message, go to the `Message` tab and ensure that your message is being parsed as `JSON`.
4040

41-
![image3.png](./docs/image3.png)
41+
![image3.png](./docs/images/postman-setup3.png)
4242

4343
- In the `Event name` input, input the correct event name. Click on `Send` to send a message.
4444

45-
![image4.png](./docs/image4.png)
45+
![image4.png](./docs/images/postman-setup4.png)
4646

4747
## Events Available
4848

4949
| Event Name | Description | Parameters | Response Event |
5050
| --------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
5151
| **join** | Joins a communication rooms | `roomId` (string): ID of the room. <br> `username` (string): Username of the user that joined. | **user_joined**: Notify the other user that a new user has joined the room. |
5252
| **send_text_message** | Sends a message to the other user | `roomId` (string): ID of the room. <br> `message` (string): Message to send. <br> `username` (string): User that sent the message. <br> `createdTime` (number): Time that the user sent the message. | **text_message_received**: Notify the user that a message is sent |
53-
| **leave** | Leaves the communication room. | `roomId` (string): ID of the room to leave. <br> `username` (string): User that wants to leave. | **user_left**: To notify the user when one user leaves. |
53+
| **user_disconnect** | User disconnection. | None | **user_left**: To notify the user when one user leaves. |
5454
| **disconnect** | Disconnects from the server. | None | **disconnected**: To notify the user when one user gets disconnected from the server. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)