open method

Future<DynamiteResponse<DirectEditingOpenResponseApplicationJson, void>> open({ required String path, String? editorId, int? fileId, bool? oCSAPIRequest, })

Open a file for direct editing.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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_Request for the request send by this method.
• $open_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<DirectEditingOpenResponseApplicationJson, void>> open({
  required String path,
  String? editorId,
  int? fileId,
  bool? oCSAPIRequest,
}) async {
  final _request = $open_Request(
    path: path,
    editorId: editorId,
    fileId: fileId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $open_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<DirectEditingOpenResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}