transfer method
Transfer the ownership to another user.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
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 totrue
.
Status codes:
- 200: Ownership transferred successfully
- 400: Transferring ownership is not possible
- 403: Transferring ownership is not allowed
See:
- $transfer_Request for the request send by this method.
- $transfer_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<TransferOwnershipTransferResponseApplicationJson, void>> transfer({
required String recipient,
required String path,
bool? oCSAPIRequest,
}) async {
final _request = $transfer_Request(
recipient: recipient,
path: path,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $transfer_Serializer();
final _rawResponse =
await _i1.ResponseConverter<TransferOwnershipTransferResponseApplicationJson, void>(_serializer)
.convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}