configureBreakoutRooms method

Future<DynamiteResponse<BreakoutRoomConfigureBreakoutRoomsResponseApplicationJson, void>> configureBreakoutRooms({ required BreakoutRoomConfigureBreakoutRoomsMode mode, required int amount, required String token, String? attendeeMap, BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion, bool? oCSAPIRequest, })

Configure 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:

• mode Mode of the breakout rooms.
• amount Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}.
• attendeeMap Mapping of the attendees to breakout rooms. Defaults to "[]".
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Breakout rooms configured successfully
• 400: Configuring breakout rooms errored

See:

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

Implementation

Future<_i1.DynamiteResponse<BreakoutRoomConfigureBreakoutRoomsResponseApplicationJson, void>> configureBreakoutRooms({
  required BreakoutRoomConfigureBreakoutRoomsMode mode,
  required int amount,
  required String token,
  String? attendeeMap,
  BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $configureBreakoutRooms_Request(
    mode: mode,
    amount: amount,
    token: token,
    attendeeMap: attendeeMap,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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