renameCollectionRaw method

  1. @experimental
DynamiteRawResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void> renameCollectionRaw({
  1. required String collectionName,
  2. required int collectionId,
  3. bool? oCSAPIRequest,
})

Rename a collection.

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:

  • collectionName New name.
  • collectionId ID of the collection.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Collection returned
  • 404: Collection not found
  • 500

See:

Implementation

@experimental
DynamiteRawResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void> renameCollectionRaw({
  required String collectionName,
  required int collectionId,
  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 $collectionName = jsonSerializers.serialize(collectionName, specifiedType: const FullType(String));
  _parameters['collectionName'] = $collectionName;

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

  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/collaboration/resources/collections/{collectionId}{?collectionName*}')
      .expand(_parameters);
  return DynamiteRawResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'put',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(CollaborationResourcesRenameCollectionResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}