createCollectionOnResourceRaw method

  1. @experimental
DynamiteRawResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void> createCollectionOnResourceRaw({
  1. required String name,
  2. required String baseResourceType,
  3. required String baseResourceId,
  4. bool? oCSAPIRequest,
})

Create a collection for a resource.

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:

  • name Name of the collection.
  • baseResourceType Type of the base resource.
  • baseResourceId ID of the base resource.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Collection returned
  • 400: Creating collection is not possible
  • 404: Resource inaccessible
  • 500

See:

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>
    createCollectionOnResourceRaw({
  required String name,
  required String baseResourceType,
  required String baseResourceId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.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 $name = _$jsonSerializers.serialize(name, specifiedType: const FullType(String));
  _parameters['name'] = $name;

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

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

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

  final _path = _i3.UriTemplate('/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}{?name*}')
      .expand(_parameters);
  return _i1.DynamiteRawResponse<CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(CollaborationResourcesCreateCollectionOnResourceResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}