startBreakoutRooms method

Future<DynamiteResponse<BreakoutRoomStartBreakoutRoomsResponseApplicationJson, void>> startBreakoutRooms({
  1. required String token,
  2. BreakoutRoomStartBreakoutRoomsApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Start the breakout rooms.

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:

  • apiVersion Defaults to "v1".
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Breakout rooms started successfully
  • 400: Starting breakout rooms is not possible

See:

Implementation

Future<_i1.DynamiteResponse<BreakoutRoomStartBreakoutRoomsResponseApplicationJson, void>> startBreakoutRooms({
  required String token,
  BreakoutRoomStartBreakoutRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $startBreakoutRooms_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $startBreakoutRooms_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<BreakoutRoomStartBreakoutRoomsResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}