Skip to content

Added remarks about the room join endpoint #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codecat merged 3 commits into from
May 30, 2026
Merged

Added remarks about the room join endpoint #41

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
698f272
Added remarks about the room join endpoint
codecat May 30, 2026
73a597a
Added note about the starting bool
codecat May 30, 2026
7c78597
Remove link and replace with explanation for external apps
codecat May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/live/clubs/room-join-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ Gets a join link for a club room.

**Remarks**:

- If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready.
- If the requested room is inactive, using this endpoint will start it. `joinLink` will be an empty string while the room isn't ready, which is also reflected by `starting`.
- `starting` may still be `true` even though a `joinLink` has already been assigned, which means the server is still starting. At that point, Nadeo's code will stop calling this endpoint entirely and instead query the server directly with a maximum retry count. Querying like this can't really be replicated from external applications, so it should be fine to rely on `starting` instead.
- Nadeo's code retries the request every 2 seconds for club rooms and 5 seconds for the track of the day channel.
- You should stop retrying for a room to start when any error is returned.

---

Expand Down
Loading