markFolderAsReadRaw method

  1. @experimental
DynamiteRawResponse<void, void> markFolderAsReadRaw({
  1. required int folderId,
  2. required int newestItemId,
})

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:

  • newestItemId The newest read item.

Status codes:

  • 200

See:

Implementation

@experimental
DynamiteRawResponse<void, void> markFolderAsReadRaw({
  required int folderId,
  required int newestItemId,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{};

// coverage:ignore-start
  final authentication = authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for basic_auth');
  }

// coverage:ignore-end
  final $folderId = jsonSerializers.serialize(folderId, specifiedType: const FullType(int));
  _parameters['folderId'] = $folderId;

  final $newestItemId = jsonSerializers.serialize(newestItemId, specifiedType: const FullType(int));
  _parameters['newestItemId'] = $newestItemId;

  final _path =
      UriTemplate('/index.php/apps/news/api/v1-3/folders/{folderId}/read{?newestItemId*}').expand(_parameters);
  return DynamiteRawResponse<void, void>(
    response: executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: null,
    headersType: null,
    serializers: jsonSerializers,
  );
}