$markFolderAsRead_Request method
- @experimental
Returns a DynamiteRequest
backing the markFolderAsRead operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
newestItemId
The newest read item.
Status codes:
- 200
See:
- markFolderAsRead for a method executing this request and parsing the response.
- $markFolderAsRead_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $markFolderAsRead_Request({
required int folderId,
required int newestItemId,
}) {
final _parameters = <String, Object?>{};
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 =
_i5.UriTemplate('/index.php/apps/news/api/v1-3/folders/{folderId}/read{?newestItemId*}').expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('post', _uri);
// coverage:ignore-start
final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_request.headers.addAll(
authentication.headers,
);
} else {
throw Exception('Missing authentication for basic_auth');
}
// coverage:ignore-end
return _request;
}