$transfer_Request method

@experimental Request $transfer_Request({ required String recipient, required String path, bool? oCSAPIRequest, })

Transfer the ownership to another user.

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

Parameters:

• recipient Username of the recipient.
• path Path of the file.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Ownership transferred successfully
• 400: Transferring ownership is not possible
• 403: Transferring ownership is not allowed

See:

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

Implementation

@_i2.experimental
_i3.Request $transfer_Request({
  required String recipient,
  required String path,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $recipient = _$jsonSerializers.serialize(recipient, specifiedType: const FullType(String));
  _parameters['recipient'] = $recipient;

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

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/transferownership{?recipient*,path*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _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);

  return _request;
}