$listArticles_Request method
- @experimental
Returns a DynamiteRequest
backing the listArticles operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
type
Defaults to3
.id
Defaults to0
.getRead
Defaults to1
.batchSize
Defaults to-1
.offset
Defaults to0
.oldestFirst
Defaults to0
.
Status codes:
- 200
See:
- listArticles for a method executing this request and parsing the response.
- $listArticles_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $listArticles_Request({
int? type,
int? id,
int? getRead,
int? batchSize,
int? offset,
int? oldestFirst,
}) {
final _parameters = <String, Object?>{};
var $type = _$jsonSerializers.serialize(type, specifiedType: const FullType(int));
$type ??= 3;
_parameters['type'] = $type;
var $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
$id ??= 0;
_parameters['id'] = $id;
var $getRead = _$jsonSerializers.serialize(getRead, specifiedType: const FullType(int));
$getRead ??= 1;
_parameters['getRead'] = $getRead;
var $batchSize = _$jsonSerializers.serialize(batchSize, specifiedType: const FullType(int));
$batchSize ??= -1;
_parameters['batchSize'] = $batchSize;
var $offset = _$jsonSerializers.serialize(offset, specifiedType: const FullType(int));
$offset ??= 0;
_parameters['offset'] = $offset;
var $oldestFirst = _$jsonSerializers.serialize(oldestFirst, specifiedType: const FullType(int));
$oldestFirst ??= 0;
_parameters['oldestFirst'] = $oldestFirst;
final _path =
_i4.UriTemplate('/index.php/apps/news/api/v1-3/items{?type*,id*,getRead*,batchSize*,offset*,oldestFirst*}')
.expand(_parameters);
final _uri = Uri.parse('$baseURL$_path');
final _request = _i3.Request('get', _uri);
_request.headers['Accept'] = 'application/json';
// coverage:ignore-start
final authentication = 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;
}