Get Joined Rooms — Reference
Read the application rooms joined by the current socket.
Read the application rooms joined by the current socket.
Before you begin
Section titled “Before you begin”- A Node.js project with Socket.IO configured and connected test clients. Socket-specific operations must run in a socket action.
Get Joined Rooms
Section titled “Get Joined Rooms”Read the application rooms joined by the current socket.
Settings
Section titled “Settings”| Setting | Meaning |
|---|---|
| Name | The step identifier used for results in the server action. Sending/joining steps do not return a delivery receipt merely because they have a name. |
Verification example
Section titled “Verification example”Join a disposable room, read Get Joined Rooms and confirm the room name appears. Leave and check again.
Context and delivery limits
Section titled “Context and delivery limits”The result is an array of room names; the module excludes the socket’s own private ID room. With no current socket it returns an empty array. It does not list all application users or permissions.
Connect to page behavior
Section titled “Connect to page behavior”Use client event handlers or the appropriate Server Connect subscription to update the page. Keep authorization, persistence and event delivery as explicit parts of the workflow.
Check your result
Section titled “Check your result”You can choose the intended recipients/context and verify the event or room behavior with test clients.