setLobby method

Future<DynamiteResponse<RoomSetLobbyResponseApplicationJson, void>> setLobby({
  1. required int state,
  2. required String token,
  3. int? timer,
  4. RoomSetLobbyApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Update the lobby state for a room.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • state New state.
  • timer Timer when the lobby will be removed.
  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Lobby state updated successfully
  • 400: Updating lobby state is not possible

See:

Implementation

Future<DynamiteResponse<RoomSetLobbyResponseApplicationJson, void>> setLobby({
  required int state,
  required String token,
  int? timer,
  RoomSetLobbyApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setLobbyRaw(
    state: state,
    token: token,
    timer: timer,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}