$open_Request method

@experimental Request $open_Request({ required String path, String? editorId, int? fileId, bool? oCSAPIRequest, })

Open a file for direct editing.

Returns a DynamiteRequest backing the open operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• path Path of the file.
• editorId ID of the editor.
• fileId ID of the file.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: URL for direct editing returned
• 403: Opening file is not allowed
• 500

See:

• open for a method executing this request and parsing the response.
• $open_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $open_Request({
  required String path,
  String? editorId,
  int? fileId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $path = _$jsonSerializers.serialize(path, specifiedType: const FullType(String));
  _parameters['path'] = $path;

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

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/directEditing/open{?path*,editorId*,fileId*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _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;
}