$getNotes_Request method

  1. @experimental
Request $getNotes_Request({
  1. String? category,
  2. String? exclude,
  3. int? pruneBefore,
  4. int? chunkSize,
  5. String? chunkCursor,
  6. String? ifNoneMatch,
})

Returns a DynamiteRequest backing the getNotes operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • category
  • exclude Defaults to "".
  • pruneBefore Defaults to 0.
  • chunkSize Defaults to 0.
  • chunkCursor
  • ifNoneMatch

Status codes:

  • 200

See:

  • getNotes for a method executing this request and parsing the response.
  • $getNotes_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getNotes_Request({
  String? category,
  String? exclude,
  int? pruneBefore,
  int? chunkSize,
  String? chunkCursor,
  String? ifNoneMatch,
}) {
  final _parameters = <String, Object?>{};
  final __category = _$jsonSerializers.serialize(category, specifiedType: const FullType(String));
  _parameters['category'] = __category;

  var __exclude = _$jsonSerializers.serialize(exclude, specifiedType: const FullType(String));
  __exclude ??= '';
  _parameters['exclude'] = __exclude;

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

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

  final __chunkCursor = _$jsonSerializers.serialize(chunkCursor, specifiedType: const FullType(String));
  _parameters['chunkCursor'] = __chunkCursor;

  final _path =
      _i4.UriTemplate('/index.php/apps/notes/api/v1/notes{?category*,exclude*,pruneBefore*,chunkSize*,chunkCursor*}')
          .expand(_parameters);
  final _uri = Uri.parse('$baseURL$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i5.IterableExtension(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
  final __ifNoneMatch = _$jsonSerializers.serialize(ifNoneMatch, specifiedType: const FullType(String));
  if (__ifNoneMatch != null) {
    _request.headers['If-None-Match'] = const _i6.HeaderEncoder().convert(__ifNoneMatch);
  }

  return _request;
}