$configureBreakoutRooms_Request method

@experimental Request $configureBreakoutRooms_Request({ required BreakoutRoomConfigureBreakoutRoomsMode mode, required int amount, required String token, String? attendeeMap, BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion, bool? oCSAPIRequest, })

Configure the breakout rooms.

Returns a DynamiteRequest backing the configureBreakoutRooms operation. 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 for a method executing this request and parsing the response.
• $configureBreakoutRooms_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $configureBreakoutRooms_Request({
  required BreakoutRoomConfigureBreakoutRoomsMode mode,
  required int amount,
  required String token,
  String? attendeeMap,
  BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $mode =
      _$jsonSerializers.serialize(mode, specifiedType: const FullType(BreakoutRoomConfigureBreakoutRoomsMode));
  _parameters['mode'] = $mode;

  final $amount = _$jsonSerializers.serialize(amount, specifiedType: const FullType(int));
  _i4.checkNumber(
    $amount,
    'amount',
    maximum: 20,
    minimum: 1,
  );
  _parameters['amount'] = $amount;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

  var $attendeeMap = _$jsonSerializers.serialize(attendeeMap, specifiedType: const FullType(String));
  $attendeeMap ??= '[]';
  _parameters['attendeeMap'] = $attendeeMap;

  var $apiVersion = _$jsonSerializers.serialize(
    apiVersion,
    specifiedType: const FullType(BreakoutRoomConfigureBreakoutRoomsApiVersion),
  );
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}{?mode*,amount*,attendeeMap*}')
          .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}