Join Room — Reference
Add the current socket to a named room.
Add the current socket to a named room.
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.
Join Room
Section titled “Join Room”Add the current socket to a named room.
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. |
| Room | The application room to target, join or leave. Use a server-approved room name. A room is a routing group, not an authentication permission. |
Verification example
Section titled “Verification example”In an authorized test socket action, join room project-1. Read the joined rooms and send a room-limited test event to confirm membership. Verify that another client outside the room receives nothing.
Context and delivery limits
Section titled “Context and delivery limits”Joining a room is not an access-control check. Check that the authenticated user may join the requested project/room before this step. It requires current socket context; it does not join every connection belonging to a user automatically.
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.