getListedRooms method
Future<DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void> >
getListedRooms({
- RoomGetListedRoomsApiVersion? apiVersion,
- String? searchTerm,
- bool? oCSAPIRequest,
Get listed rooms with optional search term.
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:
apiVersion
Defaults to"v4"
.searchTerm
search term. Defaults to""
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Return list of matching rooms
See:
- $getListedRooms_Request for the request send by this method.
- $getListedRooms_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>> getListedRooms({
RoomGetListedRoomsApiVersion? apiVersion,
String? searchTerm,
bool? oCSAPIRequest,
}) async {
final _request = $getListedRooms_Request(
apiVersion: apiVersion,
searchTerm: searchTerm,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $getListedRooms_Serializer();
return _i1.ResponseConverter<RoomGetListedRoomsResponseApplicationJson, void>(_serializer).convert(_response);
}