startBreakoutRooms method

Future<DynamiteResponse<BreakoutRoomStartBreakoutRoomsResponseApplicationJson, void>> startBreakoutRooms({ required String token, BreakoutRoomStartBreakoutRoomsApiVersion? apiVersion, 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:

• $startBreakoutRooms_Request for the request send by this method.
• $startBreakoutRooms_Serializer for a converter to parse the Response from an executed request.

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 _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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