$updateNote_Request method
- @experimental
Returns a DynamiteRequest
backing the updateNote operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
content
modified
title
category
favorite
ifMatch
Status codes:
- 200
See:
- updateNote for a method executing this request and parsing the response.
- $updateNote_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $updateNote_Request({
required int id,
String? content,
int? modified,
String? title,
String? category,
int? favorite,
String? ifMatch,
}) {
final _parameters = <String, Object?>{};
final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
_parameters['id'] = $id;
final $content = _$jsonSerializers.serialize(content, specifiedType: const FullType(String));
_parameters['content'] = $content;
final $modified = _$jsonSerializers.serialize(modified, specifiedType: const FullType(int));
_parameters['modified'] = $modified;
final $title = _$jsonSerializers.serialize(title, specifiedType: const FullType(String));
_parameters['title'] = $title;
final $category = _$jsonSerializers.serialize(category, specifiedType: const FullType(String));
_parameters['category'] = $category;
final $favorite = _$jsonSerializers.serialize(favorite, specifiedType: const FullType(int));
_parameters['favorite'] = $favorite;
final _path =
_i4.UriTemplate('/index.php/apps/notes/api/v1/notes/{id}{?content*,modified*,title*,category*,favorite*}')
.expand(_parameters);
final _uri = Uri.parse('$baseURL$_path');
final _request = _i3.Request('put', _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
final $ifMatch = _$jsonSerializers.serialize(ifMatch, specifiedType: const FullType(String));
if ($ifMatch != null) {
_request.headers['If-Match'] = const _i5.HeaderEncoder().convert($ifMatch);
}
return _request;
}