$$set_Request method

  1. @experimental
Request $$set_Request({
  1. required String version,
  2. required int fileId,
  3. required ApiSetRequestApplicationJson $body,
  4. bool? oCSAPIRequest,
})

Set a reminder.

Returns a DynamiteRequest backing the $set operation. 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 to true.

Status codes:

  • 200: Reminder updated
  • 201: Reminder created successfully
  • 400: Creating reminder is not possible
  • 401: Account not found
  • 404: File not found

See:

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

Implementation

@_i2.experimental
_i3.Request $$set_Request({
  required String version,
  required int fileId,
  required ApiSetRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __version = _$jsonSerializers.serialize(version, specifiedType: const FullType(String));
  _i4.checkString(
    __version,
    'version',
    pattern: RegExp(r'^1$'),
  );
  _parameters['version'] = __version;

  final __fileId = _$jsonSerializers.serialize(fileId, specifiedType: const FullType(int));
  _parameters['fileId'] = __fileId;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/files_reminders/api/v{version}/{fileId}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body =
      json.encode(_$jsonSerializers.serialize($body, specifiedType: const FullType(ApiSetRequestApplicationJson)));
  return _request;
}