updateShareRaw method

  1. @experimental
DynamiteRawResponse<ShareapiUpdateShareResponseApplicationJson, void> updateShareRaw({
  1. required String id,
  2. int? permissions,
  3. String? password,
  4. String? sendPasswordByTalk,
  5. String? publicUpload,
  6. String? expireDate,
  7. String? note,
  8. String? label,
  9. String? hideDownload,
  10. String? attributes,
  11. bool? oCSAPIRequest,
})

Update a share.

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:

  • 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 to true.

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:

Implementation

@experimental
DynamiteRawResponse<ShareapiUpdateShareResponseApplicationJson, void> updateShareRaw({
  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, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || 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 $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;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate(
    '/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}{?permissions*,password*,sendPasswordByTalk*,publicUpload*,expireDate*,note*,label*,hideDownload*,attributes*}',
  ).expand(_parameters);
  return DynamiteRawResponse<ShareapiUpdateShareResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'put',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(ShareapiUpdateShareResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}