open method

Future<DynamiteResponse<DirectEditingOpenResponseApplicationJson, void>> open({
  1. required String path,
  2. String? editorId,
  3. int? fileId,
  4. 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:

Implementation

Future<DynamiteResponse<DirectEditingOpenResponseApplicationJson, void>> open({
  required String path,
  String? editorId,
  int? fileId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = openRaw(
    path: path,
    editorId: editorId,
    fileId: fileId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}