$updateShare_Request method
- @experimental
Update a share.
Returns a DynamiteRequest
backing the updateShare operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
permissions
New permissions.password
New password.sendPasswordByTalk
New condition if the password should be send over Talk.publicUpload
New condition if public uploading is allowed.expireDate
New expiry date.note
New note.label
New label.hideDownload
New condition if the download should be hidden.attributes
New additional attributes.id
ID of the share.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Share updated successfully
- 400: Share could not be updated because the requested changes are invalid
- 403: Missing permissions to update the share
- 404: Share not found
See:
- updateShare for a method executing this request and parsing the response.
- $updateShare_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $updateShare_Request({
required String id,
int? permissions,
String? password,
String? sendPasswordByTalk,
String? publicUpload,
String? expireDate,
String? note,
String? label,
String? hideDownload,
String? attributes,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(String));
_parameters['id'] = $id;
final $permissions = _$jsonSerializers.serialize(permissions, specifiedType: const FullType(int));
_parameters['permissions'] = $permissions;
final $password = _$jsonSerializers.serialize(password, specifiedType: const FullType(String));
_parameters['password'] = $password;
final $sendPasswordByTalk = _$jsonSerializers.serialize(sendPasswordByTalk, specifiedType: const FullType(String));
_parameters['sendPasswordByTalk'] = $sendPasswordByTalk;
final $publicUpload = _$jsonSerializers.serialize(publicUpload, specifiedType: const FullType(String));
_parameters['publicUpload'] = $publicUpload;
final $expireDate = _$jsonSerializers.serialize(expireDate, specifiedType: const FullType(String));
_parameters['expireDate'] = $expireDate;
final $note = _$jsonSerializers.serialize(note, specifiedType: const FullType(String));
_parameters['note'] = $note;
final $label = _$jsonSerializers.serialize(label, specifiedType: const FullType(String));
_parameters['label'] = $label;
final $hideDownload = _$jsonSerializers.serialize(hideDownload, specifiedType: const FullType(String));
_parameters['hideDownload'] = $hideDownload;
final $attributes = _$jsonSerializers.serialize(attributes, specifiedType: const FullType(String));
_parameters['attributes'] = $attributes;
final _path = _i5.UriTemplate(
'/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}{?permissions*,password*,sendPasswordByTalk*,publicUpload*,expireDate*,note*,label*,hideDownload*,attributes*}',
).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 = _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;
}