listArticles method

Future<DynamiteResponse<ListArticles, void>> listArticles({
  1. int? type,
  2. int? id,
  3. int? getRead,
  4. int? batchSize,
  5. int? offset,
  6. int? oldestFirst,
})

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • type Defaults to 3.
  • id Defaults to 0.
  • getRead Defaults to 1.
  • batchSize Defaults to -1.
  • offset Defaults to 0.
  • oldestFirst Defaults to 0.

Status codes:

  • 200

See:

  • listArticlesRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<ListArticles, void>> listArticles({
  int? type,
  int? id,
  int? getRead,
  int? batchSize,
  int? offset,
  int? oldestFirst,
}) async {
  final rawResponse = listArticlesRaw(
    type: type,
    id: id,
    getRead: getRead,
    batchSize: batchSize,
    offset: offset,
    oldestFirst: oldestFirst,
  );

  return rawResponse.future;
}