removeRaw method
Remove a reminder.
This method and the response it returns is experimental. The API might change without a major version bump.
Returns a Future containing a DynamiteRawResponse
with the raw HttpClientResponse
and serialization helpers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
version
fileId
ID of the file.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Reminder deleted successfully
- 401: User not found
- 404: Reminder not found
See:
- remove for an operation that returns a
DynamiteResponse
with a stable API.
Implementation
@_i4.experimental
_i1.DynamiteRawResponse<ApiRemoveResponseApplicationJson, void> removeRaw({
required String version,
required int fileId,
bool? oCSAPIRequest,
}) {
final _parameters = <String, dynamic>{};
final _headers = <String, String>{'Accept': 'application/json'};
// coverage:ignore-start
final authentication = _rootClient.authentications?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_headers.addAll(
authentication.headers,
);
} else {
throw Exception('Missing authentication for bearer_auth or basic_auth');
}
// coverage:ignore-end
final $version = _$jsonSerializers.serialize(version, specifiedType: const FullType(String));
_i2.checkPattern(
$version as String?,
RegExp(r'^1$'),
'version',
);
_parameters['version'] = $version;
final $fileId = _$jsonSerializers.serialize(fileId, specifiedType: const FullType(int));
_parameters['fileId'] = $fileId;
var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
$oCSAPIRequest ??= true;
_headers['OCS-APIRequest'] = const _i2.HeaderEncoder().convert($oCSAPIRequest);
final _path = _i3.UriTemplate('/ocs/v2.php/apps/files_reminders/api/v{version}/{fileId}').expand(_parameters);
return _i1.DynamiteRawResponse<ApiRemoveResponseApplicationJson, void>(
response: _rootClient.executeRequest(
'delete',
_path,
headers: _headers,
validStatuses: const {
200,
401,
404,
},
),
bodyType: const FullType(ApiRemoveResponseApplicationJson),
headersType: null,
serializers: _$jsonSerializers,
);
}