configureBreakoutRoomsRaw method
- @experimental
- required BreakoutRoomConfigureBreakoutRoomsMode mode,
- required int amount,
- required String token,
- String? attendeeMap,
- BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion,
- bool? oCSAPIRequest,
Configure the breakout rooms.
This method and the response it returns is experimental. The API might change without a major version bump.
Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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 tov1
.token
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Breakout rooms configured successfully
- 400: Configuring breakout rooms errored
See:
- configureBreakoutRooms for an operation that returns a DynamiteResponse with a stable API.
Implementation
@experimental
DynamiteRawResponse<BreakoutRoomConfigureBreakoutRoomsResponseApplicationJson, void> configureBreakoutRoomsRaw({
required BreakoutRoomConfigureBreakoutRoomsMode mode,
required int amount,
required String token,
String? attendeeMap,
BreakoutRoomConfigureBreakoutRoomsApiVersion? apiVersion,
bool? oCSAPIRequest,
}) {
final _parameters = <String, dynamic>{};
final _headers = <String, String>{
'Accept': 'application/json',
};
// coverage:ignore-start
final authentication = _rootClient.authentications.firstWhereOrNull(
(auth) => switch (auth) {
DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_headers.addAll(
authentication.headers,
);
} else {
throw Exception('Missing authentication for bearer_auth or basic_auth');
}
// coverage:ignore-end
final $mode =
jsonSerializers.serialize(mode, specifiedType: const FullType(BreakoutRoomConfigureBreakoutRoomsMode));
_parameters['mode'] = $mode;
final $amount = jsonSerializers.serialize(amount, specifiedType: const FullType(int));
_parameters['amount'] = $amount;
final $token = jsonSerializers.serialize(token, specifiedType: const FullType(String));
dynamite_utils.checkPattern($token as String?, RegExp(r'^[a-z0-9]{4,30}$'), 'token');
_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;
var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
$oCSAPIRequest ??= true;
_headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);
final _path =
UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}{?mode*,amount*,attendeeMap*}')
.expand(_parameters);
return DynamiteRawResponse<BreakoutRoomConfigureBreakoutRoomsResponseApplicationJson, void>(
response: _rootClient.executeRequest(
'post',
_path,
_headers,
null,
const {200},
),
bodyType: const FullType(BreakoutRoomConfigureBreakoutRoomsResponseApplicationJson),
headersType: null,
serializers: jsonSerializers,
);
}