Lobby Operators
The lobby operators are designed to allow users of multi-player games to create and join sessions of games in which they want to play. The commands are designed to allow predefined session types as well as allow game defined session types. Some session types include: Wager, N Player Session and N to M Player Session. If not enough sessions are available then the lobby code will automatically create sessions that people will be able to join.
| Command | Description | Reference |
| DELETE /Lobby/ServerSessions | Used to delete expired or completed server created sessions. | Delete Server Sessions |
| DELETE /Lobby/Session | Allows the user to leave a session that they joined. | Leave Session |
| DELETE /Lobby/SessionAccept | Clears all accept flags for all users in a session. | Delete Session Accept |
| DELETE /Lobby/SessionRemoveUser | Allows the session creator to remove users from their session. | Remove User |
| GET /Lobby/Sessions | Returns a list of available game sessions to join. | Get Sessions |
| GET /Lobby/SessionStart | Returns whether or not a particular session has started. | Get Session Start |
| GET /Lobby/SessionUsers | Returns an array of users who have joined a session. | Get Session Users |
| GET /Lobby/UserSession | Returns the sessionNo of the session the user is currently in if the user is in a session. | Get User Session |
| PUT /Lobby/AwardSessionWager | Awards the winner of a wager game session the wager for that session. | Award Session Wager |
| PUT /Lobby/EditSession | Allows the session creator to edit a session they created. | Edit Session |
| PUT /Lobby/JoinSession | Allows the user to try and join a session of a game. | Join Session |
| PUT /Lobby/LogJoinLobby | Used to create a log when a user logs on to the lobby. | Log Join Lobby |
| PUT /Lobby/NewSession | Allows the user to start a new game session. | New Session |
| PUT /Lobby/SessionAccept | Toggles the accept flag for a user in a session. | Put Session Accept |
| PUT /Lobby/SessionReset | Reset a started user created session to waiting. | Reset Session |
User Flow
Example of the user flow with the lobby commands.
Back to the
APIDraft
to top