Changelog

The list of changes of ONLYOFFICE Docs API.

Version 9.4

• Added the plugin command logging feature for enabling debug output of plugin commands in the browser console.
• Added the editorConfig.plugins.disable parameter to block specific plugins on load.
• Added Croatian (hr) to the list of supported interface languages.
• Removed the deprecated editorConfig.customization.commentAuthorOnly field.
• Added the roles parameter to the onStartFilling event with role and user information.
• Fixed a memory leak in the destroyEditor method that prevented full cleanup.

Version 9.1

• The document is opened in viewer mode with an error message if it cannot be locked in WOPI.
• Added the UserCanOnlyComment property to the CheckFileInfo WOPI operation.
• The editorConfig.customization.uitheme parameter is now available for the mobile editors.
• Added opening for hml format.
• Added conversion from pptx format to txt.
• Changed the editorConfig.customization.logo.image size requirement to 300x20.

Version 9.0

• Added the editorConfig.customization.suggestFeature parameter.
• Changed editorConfig.customization.macros: in version 9.0.3, this parameter completely disables running, adding, and editing macros (not just automatic startup).
• The editorConfig.customization.toolbarHideFileName parameter is now available for the mobile editors.
• Added the theme-white and theme-night theme ids to the editorConfig.customization.uiTheme parameter.
• Added opening for odg format.
• Added opening for md format.
• Added the ability to preload the editor static resources.
• Added the editorConfig.customization.forceWesternFontSize parameter for the Chinese (Simplified) UI.
• Added the editorConfig.customization.layout.header.user parameter.
• Added conversion from vsdm, vsdx, vssm, vssx, vstm, vstx formats.
• Added the diagram document type to the documentType parameter.

Version 8.3

• Added the editorConfig.customization.features.featuresTips parameter.
• Added the editorConfig.customization.showHorizontalScroll and editorConfig.customization.showVerticalScroll parameters.
• Added the editorConfig.customization.slidePlayerBackground parameter.
• Added the editorConfig.customization.wordHeadingsColor parameter.
• Added the editorConfig.customization.mobile.info parameter.
• Added opening for pages, key, numbers, hwp, hwpx formats.
• Added the events.onUserActionRequired event.
• Added the refreshFile method.
• Added the events.onRequestRefreshFile event.
• Added the events.onStartFilling event.
• Added the roles parameter to the events.onRequestStartFilling event.
• Added the events.onRequestFillingStatus event.
• Added the editorConfig.customization.startFillingForm parameter.
• Added the roles field to the editorConfig.user.
• Added the editorConfig.customization.mobile.disableForceDesktop parameter.
• The document editing will be prohibited for all users editing the document with the specified key, if the users parameter is not specified for the drop command.
• The editorConfig.customization.submitForm parameter can now be used as an object.
• The editorConfig.customization.compactToolbar parameter is now available for the viewer.
• Added the editorConfig.customization.pointerMode parameter.
• The editorConfig.customization.layout.toolbar.insert parameter can now be used as an object with the file and field fields.
• The editorConfig.customization.layout.toolbar.layout parameter can now be used as an object with the pagecolor field.

Version 8.2

• The editorConfig.customization.mobileForceView parameter is deprecated, please use the editorConfig.customization.mobile parameter instead.
• Added the Password and PasswordToOpen request parameters to the WOPI conversion API.
• The editorConfig.region field is now used to define the default measurement units in all editor types.
• The editorConfig.location field is deprecated, please use the editorConfig.region field instead.
• Added the insert-text type of document selection to the c parameter of the setRequestedDocument method.
• The https://documentserver/coauthoring/CommandService.ashx address of the command service is replaced with https://documentserver/command.
• Added the users parameter to the response of the info command.
• Added the tabBackground field to the editorConfig.customization.features parameter.
• Added the tabStyle field to the editorConfig.customization.features parameter.
• Added the imageLight field to the editorConfig.customization.logo parameter.
• The editorConfig.customization.toolbarNoTabs field is deprecated, please use the editorConfig.customization.features.tabStyle and editorConfig.customization.features.tabBackground fields instead.

Version 8.1

• Added the editorConfig.plugins.options parameter.
• Added the possibility to insert the tif / tiff image type into the file.
• Added the startFilling method.
• Added the events.onRequestStartFilling event.
• Added the docs_api_config parameter to the form element of the WOPI host page.
• Added the pdf field to the conversion request.
• Added the events.onSubmit event.
• Added the events.onSaveDocument event.
• Added the roles field to the editorConfig.customization.features parameter.
• Added the shardkey parameter to the URL query string when sending requests to the ONLYOFFICE Docs API, document command service, document conversion service, or document builder service.
• Added the addContextMenuItem, addToolbarMenuItem and updateContextMenuItem methods to the Automation API.
• Added the -10 error code to the Conversion API.
• The editorConfig.customization.logo parameter is now available for the mobile editors.
• Added the visible field to the editorConfig.customization.logo parameter.
• Added the formsubmit action to the WOPI discovery.
• The editorConfig.customization.goback.requestClose field is deprecated, please use the editorConfig.customization.close field instead.
• Added the Save Copy As functionality to WOPI.
• Change the default value of the editorConfig.customization.hideRightMenu parameter to true.

Version 8.0

• Added the document.isForm parameter.
• Added the WOPISrc query parameter to the requests from the browser to the server.
• Added the watermark field to the conversion request.
• Added the pdf document type to the documentType parameter.
• Added the formsdataurl parameter to the Callback handler.
• Added the data.id parameter to the events.onRequestUsers event.
• Added the users.image field to the setUsers method.
• Added the info operation type to the setUsers method and events.onRequestUsers event.
• Added the image field to the editorConfig.user parameter.
• Added the editorConfig.customization.mobileForceView parameter.
• Added the link field to the data object which is sent to the events.onRequestReferenceData event.

Version 7.5

• Added the 3 type for the forcesavetype parameter of the callback handler.
• Added the editorConfig.customization.submitForm parameter.
• The events.onRequestMailMergeRecipients event is deprecated, please use the events.onRequestSelectSpreadsheet event instead.
• The setMailMergeRecipients method is deprecated, please use the setRequestedSpreadsheet method instead.
• Added the setReferenceSource method.
• Added the events.onRequestReferenceSource event.
• Added the -9 error code to the Conversion API.
• Added the key field to the setReferenceData method.
• The events.onRequestCompareFile event is deprecated, please use the events.onRequestSelectDocument event instead.
• The setRevisedFile method is deprecated, please use the setRequestedDocument method instead.
• Added the events.onRequestOpen event.
• Added the deleteForgotten, getForgotten, and getForgottenList commands.

Version 7.4

• Added the mobileView and mobileEdit actions to the WOPI discovery.
• Added opening for dps, dpt, et, ett, mhtml, stw, sxc, sxi, sxw, wps, wpt formats.
• Added the users.id field to the setUsers method.
• Added the c parameter to the setUsers method and events.onRequestUsers event.

Version 7.3

• Added the WOPI Conversion API.
• Added the setReferenceData method.
• Added the events.onRequestReferenceData event.
• Added the document.referenceData parameter.
• Added the UserCanNotWriteRelative property to the CheckFileInfo WOPI operation.
• Added a scheme for editing binary document formats.
• Added the convert action to the WOPI discovery.
• Added the PutRelativeFile WOPI operation.

Version 7.2

• Added the title parameter.
• Added the editorConfig.customization.integrationMode parameter.
• Added the Connector class to interact with documents, spreadsheets, presentations, PDFs, and fillable forms from the outside.
• Added the theme-contrast-dark theme id to the editorConfig.customization.uiTheme parameter.
• Added the phone field to the editorConfig.customization.customer parameter.
• Added the connections_view, users_view_count and users_view parameters to the license response.
• Added the live viewer mode to the document, spreadsheet and presentation editors.
• Added the embedview action to the WOPI discovery.
• The services.CoAuthoring.secret.browser.string parameter is deprecated, please use the services.CoAuthoring.secret.inbox.string parameter instead.

Version 7.1

• The services.CoAuthoring.token.inbox.inBody and services.CoAuthoring.token.outbox.inBody parameters for enabling token in body are deprecated.
• Added the X-LOOL-WOPI-IsModifiedByUser, X-LOOL-WOPI-IsAutosave and X-LOOL-WOPI-IsExitSave request headers to the PutFile WOPI operation to distinguish between the type of document saving.
• The editorConfig.customization.chat parameter is deprecated, please use the document.permissions.chat parameter instead.
• Added conversion from dps, dpt, et, ett, htm, mhtml, stw, sxc, sxi, sxw, wps, wpt, xlsb, xml format.
• Added opening for xlsb format.
• The parameter list in the initialization config signature has become strictly regulated.
• The editorConfig.customization.spellcheck field is deprecated, please use the editorConfig.customization.features.spellcheck field instead.
• Added the editorConfig.customization.features parameter section.
• Added the documentLayout parameter to the conversion request.
• Added the documentRenderer parameter to the conversion request.
• Added conversion from pdf/xps/oxps formats to docx.
• Added the document.permissions.userInfoGroups parameter.
• Added conversion from djvu format to pdf.
• Added conversion to ppsm, ppsx formats.

Version 7.0

• The callbackUrl is used from the last tab of the same user.
• Added the logoDark field to the editorConfig.customization.customer parameter.
• Added the imageDark field to the editorConfig.customization.logo parameter.
• The imageEmbedded field of the editorConfig.customization.logo parameter is deprecated, please use the image field instead.
• Added a signature to the request for file changes specified with the changesUrl parameter of the setHistoryData method.
• Added the document.permissions.protect field.
• Added the fileType parameter to the onDownloadAs, onRequestRestore and onRequestSaveAs events.
• Added the possibility to insert several images via the insertImage method.
• The assemblyFormatAsOrigin server setting is enabled by default.
• Added the ooxml and odf values to the outputtype parameter of the conversion request.
• Added the fileType and previous.fileType parameters to the setHistoryData method.
• Added the filetype parameter to the Callback handler.
• Added the fileType field to the conversion response.
• Added conversion to docm, dotm, xlsm, xltm, pptm, potm formats.
• The editorConfig.customization.reviewDisplay, editorConfig.customization.showReviewChanges, editorConfig.customization.trackChanges parameters are deprecated, please use the editorConfig.customization.review parameter instead.
• Added the editorConfig.customization.review.hideReviewDisplay field.
• Added the editorConfig.customization.review.hoverMode field.
• Added the possibility to view the document history of the spreadsheet files.
• Added the UI_InsertGraphic message for the PostMessage WOPI protocol.

Version 6.4

• Added opening for oxps format.
• Added support for WOPI protocol.
• Added the editorConfig.wopi section.
• Added the simple value to the editorConfig.customization.reviewDisplay parameter.
• Added the threaded comments saving in the spreadsheet files.
• Added the editorConfig.customization.uiTheme field.
• Added the possibility to view the document history for the presentation files.
• Added the editorConfig.customization.hideNotes field.
• Added the editorConfig.coEditing field.
• Added the requestClose method.
• Added the document.permissions.commentGroups field.
• Added the events.onPluginsReady event.

Version 6.3

• Added the license command.
• Added the editorConfig.customization.hideRulers field.
• Added the editorConfig.customization.anonymous field.
• The editorConfig.customization.commentAuthorOnly field is deprecated, please use the document.permissions.editCommentAuthorOnly and document.permissions.deleteCommentAuthorOnly fields.
• Added the setFavorite method.
• Added the data.favorite parameter to the events.onMetaChange event.
• Added the document.info.favorite field.
• Added the document.permissions.reviewGroups field.
• Added conversion to epub, fb2, html formats.
• Added conversion from xml format.
• Removed the deprecated document.info.author parameter.
• Removed the deprecated document.info.created parameter.

Version 6.2

• Added a new actions.type field value (actions.type = 2).
• Added the editorConfig.customization.trackChanges field.
• Added the editorConfig.customization.toolbarHideFileName field.
• The callbackUrl for status 6 is selected based on forcesavetype.
• Added opening for fb2 format.

Version 6.1

• The text, spreadsheet and presentation values for documentType parameter is deprecated, please use word, cell and slide values instead.
• Added the group field to the editorConfig.user.
• Added the editorConfig.customization.reviewPermissions parameter.
• Added conversion from fb2 format.
• Removed the deprecated document.permissions.changeHistory parameter.
• Removed the deprecated document.permissions.rename parameter.

Version 6.0

• Added the type of insertion in events.onRequestInsertImage event.
• Added the editorConfig.templates field.
• Added the editorConfig.customization.plugins field.
• Added the editorConfig.customization.macros field.
• Added the editorConfig.customization.macrosMode field.
• Added the events.onRequestCreateNew event.
• Added the document.permissions.copy field.
• The document.permissions.rename field is deprecated, please add the events.onRequestRename field instead.

Version 5.5

• The https://documentserver/ConvertService.ashx address of the conversion service is replaced with https://documentserver/converter.
• Added the editorConfig.customization.spellcheck field.
• Added conversion to pdfa format.
• Added the events.onRequestCompareFile event.
• Added the setRevisedFile method.
• Token in methods parameters.
• The document.permissions.changeHistory field is deprecated, please add the events.onRequestRestore field instead.
• Added the editorConfig.customization.goback.requestClose field.
• Added the events.onRequestSharingSettings event.
• Added the editorConfig.customization.unit field.
• Added the region field.
• Added the spreadsheetLayout field.
• Added input error for conversion.
• The events.onRequestSendNotify event and the events.onRequestUsers event can be set independently.
• Added the editorConfig.customization.mentionShare field.
• The callbackUrl is selected based on status.
• Added the editorConfig.customization.compatibleFeatures field.

Version 5.4

• Added the editorConfig.region field.
• The document.info.created field is deprecated, please use the document.info.uploaded field instead.
• The document.info.author field is deprecated, please use the document.info.owner field instead.
• The events.onReady event is removed.
• The firstname and lastname fields in the editorConfig.user object are removed.
• Added the events.onRequestSaveAs event.
• Added the events.onRequestInsertImage event.
• Added the insertImage method.
• Added the events.onRequestMailMergeRecipients event.
• Added the setMailMergeRecipients method.
• Added the setSharingSettings method.
• Added the events.onRequestUsers event.
• Added the setUsers method.
• Added the events.onRequestSendNotify event.

Version 5.3

• Added conversion to the OOXML (dotx, xltx, potx) and ODF (ott, ots, otp) templates.
• Added the editorConfig.customization.reviewDisplay field.
• The editorConfig.customization.commentAuthorOnly field is now used to restrict comment deletion as well.
• Added the editorConfig.customization.compactHeader field.
• Added the editorConfig.customization.hideRightMenu field.
• Added the editorConfig.customization.toolbarNoTabs field.
• Added conversion error for password protected documents.
• Added the editorConfig.actionLink field.
• Added the setActionLink method.
• Added the events.onMakeActionLink event.

Version 5.2

• Token in request body parameters.
• document.permissions.comment is available in all types of editors.
• Added the document.permissions.fillForms field.
• Added the editorConfig.customization.help field.
• Added the possibility to make the editorConfig.customization.logo not clickable.
• Added for the aspect field value 2 for the conversion.

Version 5.1

• Added the format parameter to the downloadAs method.
• Added the document.permissions.modifyContentControl field.
• Added conversion for OpenDocument Template formats.
• Added the events.onRequestClose event.
• Added the editorConfig.customization.goback.blank field.

Version 5.0

• Added the document.permissions.modifyFilter field.
• Added conversion for macro-enabled document, document template and flat document formats.
• The events.onReady event is deprecated, please use the events.onAppReady event instead.
• Added the events.onDocumentReady event.
• Added the editorConfig.plugins.autostart field.
• Added the events.onWarning event.
• Added the Document Builder service.

Version 4.4

• Changed the showMessage method.
• Added conversion to odp format.
• Added the document.permissions.comment field.
• Added the document.permissions.changeHistory field.
• Added the events.onRequestRestore event.
• Added the document.permissions.rename field.
• Added the events.onRequestRename event.
• Added the meta command.
• Added the events.onMetaChange event.
• Changed the use of callbackUrl from the last user who joined the co-editing.
• Added the editorConfig.location field.
• Added the editorConfig.embedded.autostart field.

Version 4.3

• Added the destroyEditor method.
• Removed the editorConfig.plugins.url field from the plugin connection pattern.
• Added the editorConfig.customization.commentAuthorOnly field.
• Added the editorConfig.customization.forcesave field.
• Added the editorConfig.customization.showReviewChanges field.
• Added the forcesavetype field in the callback handler request when force saving the file.
• Added the JSON format for response from document conversion service.

Version 4.2

• The firstname and lastname fields are deprecated, please use the name field instead.
• Added the possibility to specify the values for the editorConfig.customization.chat and editorConfig.customization.comments in the Open Source version.
• Added the editorConfig.customization.compactToolbar field.
• Added the editorConfig.customization.zoom field.
• Added the editorConfig.customization.autosave field.
• The changeshistory field is removed, please use the history field instead.
• Changed the setHistoryData method.
• Added the possibility to convert files to thumbnail in the document conversion service.
• The POST requests are now used for the interaction with the document command service and the document conversion service.
• Added the version command.
• Added the signature for the editor opening and for the incoming and outgoing requests.