$getListedRooms_Request method

@experimental Request $getListedRooms_Request({ String? searchTerm, RoomGetListedRoomsApiVersion? apiVersion, bool? oCSAPIRequest, })

Get listed rooms with optional search term.

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

Parameters:

• searchTerm search term. Defaults to "".
• apiVersion Defaults to "v4".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Return list of matching rooms

See:

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

Implementation

@_i2.experimental
_i3.Request $getListedRooms_Request({
  String? searchTerm,
  RoomGetListedRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var $searchTerm = _$jsonSerializers.serialize(searchTerm, specifiedType: const FullType(String));
  $searchTerm ??= '';
  _parameters['searchTerm'] = $searchTerm;

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

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/listed-room{?searchTerm*}').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 = _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;
}