avallef commited on
Commit
ba51620
·
1 Parent(s): a55cf78

Added get_rooms docs

Browse files
Files changed (1) hide show
  1. server/README.md +22 -2
server/README.md CHANGED
@@ -94,6 +94,26 @@ Room messages are sent to everyone in a room
94
  }
95
  ```
96
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
97
  ### Room Update
98
 
99
  **Type:** `server -> client <room>`
@@ -104,12 +124,12 @@ Room messages are sent to everyone in a room
104
  {
105
  "message": "room_update",
106
  "roomId": string,
107
- "users": []{
108
  username: string,
109
  id: string,
110
  online: boolean,
111
  lastOnline: number, // ms epoch time
112
- },
113
  }
114
  ```
115
 
 
94
  }
95
  ```
96
 
97
+ ### Get Rooms
98
+
99
+ **Type:** `client -> server`
100
+ **Description:** Used to get list of joined rooms
101
+ **Payload:**
102
+ ```typescript
103
+ {
104
+ "route": "get_rooms"
105
+ }
106
+ ```
107
+
108
+ **Type:** `server -> client <private>`
109
+ **Payload:**
110
+ ```typescript
111
+ {
112
+ "message": "get_rooms_response",
113
+ "rooms": [{id: string, userCount: number}]
114
+ }
115
+ ```
116
+
117
  ### Room Update
118
 
119
  **Type:** `server -> client <room>`
 
124
  {
125
  "message": "room_update",
126
  "roomId": string,
127
+ "users": [{
128
  username: string,
129
  id: string,
130
  online: boolean,
131
  lastOnline: number, // ms epoch time
132
+ }],
133
  }
134
  ```
135