getRoomsRaw method

  1. @experimental
DynamiteRawResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders> getRoomsRaw({
  1. RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  2. int? includeStatus,
  3. int? modifiedSince,
  4. RoomGetRoomsApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Get all currently existent rooms which the user has joined.

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:

  • 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.
  • apiVersion Defaults to v4.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Return list of rooms

See:

Implementation

@experimental
DynamiteRawResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders> getRoomsRaw({
  RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  int? includeStatus,
  int? modifiedSince,
  RoomGetRoomsApiVersion? 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
  var $noStatusUpdate =
      jsonSerializers.serialize(noStatusUpdate, specifiedType: const FullType(RoomGetRoomsNoStatusUpdate));
  $noStatusUpdate ??= 0;
  _parameters['noStatusUpdate'] = $noStatusUpdate;

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

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

  var $apiVersion = jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomGetRoomsApiVersion));
  $apiVersion ??= 'v4';
  _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}/room{?noStatusUpdate*,includeStatus*,modifiedSince*}')
          .expand(_parameters);
  return DynamiteRawResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(RoomGetRoomsResponseApplicationJson),
    headersType: const FullType(RoomRoomGetRoomsHeaders),
    serializers: jsonSerializers,
  );
}