$getBreakoutRoomParticipants_Request method

@experimental Request $getBreakoutRoomParticipants_Request({ required String token, RoomGetBreakoutRoomParticipantsApiVersion? apiVersion, RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus, bool? oCSAPIRequest, })

Get the breakout room participants for a room.

Returns a DynamiteRequest backing the getBreakoutRoomParticipants operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• apiVersion Defaults to "v4".
• token
• includeStatus Include the user statuses. Defaults to 0.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Breakout room participants returned
• 400: Getting breakout room participants is not possible
• 403: Missing permissions to get breakout room participants

See:

• getBreakoutRoomParticipants for a method executing this request and parsing the response.
• $getBreakoutRoomParticipants_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getBreakoutRoomParticipants_Request({
  required String token,
  RoomGetBreakoutRoomParticipantsApiVersion? apiVersion,
  RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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 __apiVersion = _$jsonSerializers.serialize(
    apiVersion,
    specifiedType: const FullType(RoomGetBreakoutRoomParticipantsApiVersion),
  );
  __apiVersion ??= 'v4';
  _parameters['apiVersion'] = __apiVersion;

  var __includeStatus = _$jsonSerializers.serialize(
    includeStatus,
    specifiedType: const FullType(RoomGetBreakoutRoomParticipantsIncludeStatus),
  );
  __includeStatus ??= 0;
  _parameters['includeStatus'] = __includeStatus;

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

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// 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;
}