$getRooms_Request method

@experimental Request $getRooms_Request({ RoomGetRoomsApiVersion? apiVersion, RoomGetRoomsNoStatusUpdate? noStatusUpdate, RoomGetRoomsIncludeStatus? includeStatus, int? modifiedSince, bool? oCSAPIRequest, })

Get all currently existent rooms which the user has joined.

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

Parameters:

• apiVersion Defaults to "v4".
• noStatusUpdate When the user status should not be automatically set to online set to 1 (default 0). Defaults to 0.
• includeStatus Include the user status. Defaults to 0.
• modifiedSince Filter rooms modified after a timestamp. Defaults to 0.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Return list of rooms

See:

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

Implementation

@_i2.experimental
_i3.Request $getRooms_Request({
  RoomGetRoomsApiVersion? apiVersion,
  RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  RoomGetRoomsIncludeStatus? includeStatus,
  int? modifiedSince,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var __apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomGetRoomsApiVersion));
  __apiVersion ??= 'v4';
  _parameters['apiVersion'] = __apiVersion;

  var __noStatusUpdate =
      _$jsonSerializers.serialize(noStatusUpdate, specifiedType: const FullType(RoomGetRoomsNoStatusUpdate));
  __noStatusUpdate ??= 0;
  _parameters['noStatusUpdate'] = __noStatusUpdate;

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

  var __modifiedSince = _$jsonSerializers.serialize(modifiedSince, specifiedType: const FullType(int));
  __modifiedSince ??= 0;
  _i4.checkNumber(
    __modifiedSince,
    'modifiedSince',
    minimum: 0,
  );
  _parameters['modifiedSince'] = __modifiedSince;

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