forcesave

Description

Forcibly saves the document being edited without closing it. The document editing might be continued after this command, so this will not be the final saved document version.

Request example

  1. {
  2.     "c": "forcesave",
  3.     "key": "Khirz6zTPdfd7",
  4.     "userdata": "sample userdata"
  5. }

Parameters

ParameterDescriptionTypePresence
cDefines the command type.stringrequired
keyDefines the document identifier used to unambiguously identify the document file.stringrequired
userdataDefines some custom identifier which will help distinguish the specific request in case there were more than one.stringoptional

Response example

  1. {
  2.     "error": 0,
  3.     "key": "Khirz6zTPdfd7"
  4. }

Parameters

ParameterDescriptionTypePresence
errorDefines an error code.integerrequired
keyDefines the document identifier used to unambiguously identify the document file.stringrequired