The newly added Connector API class allows interacting with text documents, spreadsheets, presentations, and fillable forms from the outside.&nbsp;

ONLYOFFICE Docs Advanced API for developers | #site_title&nbsp;

In this article, you will learn how to generate a feed with comments from your documents using API to be able to navigate through comments, reply to comments and close them using your own buttons/methods instead of the editor buttons.
<img decoding="async" loading="lazy" class="alignnone wp-image-42843 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class.jpg" alt="ONLYOFFICE Docs Advanced API: Manage a comment feed for documents in one place" width="1472" height="742" srcset="https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class.jpg 1472w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class-300x151.jpg 300w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class-1024x516.jpg 1024w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class-768x387.jpg 768w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class-634x320.jpg 634w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/ONLYOFFICE-connector-class-353x178.jpg 353w" sizes="(max-width: 1472px) 100vw, 1472px" />

<h2>A brief intro</h2>
The newly added Connector API class allows interacting with text documents, spreadsheets, presentations, and fillable forms from the outside.
This way, you can create a special Connector which allows you to link your custom interface directly to the document and perform any actions in it.
<img decoding="async" loading="lazy" class="alignnone size-full wp-image-42143 img-popup" src="https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector.png" alt="ONLYOFFICE Docs Advanced API: How to manage a comment feed for all documents in one place" width="1205" height="744" srcset="https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector.png 1205w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector-300x185.png 300w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector-1024x632.png 1024w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector-768x474.png 768w, https://static-blog.onlyoffice.com/wp-content/uploads/2022/10/connector-288x178.png 288w" sizes="(max-width: 1205px) 100vw, 1205px" />
Possible scenarios and cases include:
<ul>
<li>managing a comment feed for all documents in one place;</li>
<li>automatic form filling with the data exported from databases;</li>
<li>managing review process from the outside (accepting/rejecting suggested changes);</li>
<li>and more.</li>
</ul>
<h2>How to start</h2>
The Connector API class is included in the Advanced API and is available for new builds of ONLYOFFICE Docs Developer Edition starting from version 7.2.
So, first of all, you need to get a new license for <a href="https://www.onlyoffice.com/developer-edition.aspx?utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">ONLYOFFICE Docs Developer Edition</a> with this option included (in the Access to API section select the Advanced option).
<a class="red button" href="https://www.onlyoffice.com/developer-edition-prices.aspx?utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">Purchase a license</a>
In case you want to try it first, start a new 30-day trial period of ONLYOFFICE Docs Developer Edition or request a demo by contacting our sales team at <a href="mailto:sales@onlyoffice.com" target="_blank" rel="noopener">sales@onlyoffice.com</a>. You are also welcome to reach your dedicated sales manager directly.
<a class="red button" href="https://www.onlyoffice.com/download-docs.aspx?utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class#docs-developer" target="_blank" rel="noopener">Download now</a>
<h2>What you need to do</h2>
To implement a comment feed and work with comments using your own buttons/methods, you need to create the Connector. To do it, use the createConnector method of the document editor object:
<code>var connector = docEditor.createConnector()</code>
Here are the most important methods available for the Connector:
<ul>
<li>attachEvent allows adding an event listener previously available only from plugins. A full list is available <a href="https://api.teamlab.info/plugin/events" target="_blank" rel="noopener">here</a>. Among them, you will find such events as changing the Content Control (<code>onChangeContentControl</code>) or clicking on the element (<code>onClick</code>).</li>
<li>callCommand allows executing the Document Builder script to build and modify a document. More than 1,5 thousand methods are provided by the Builder Document script, and they all become available for executing in the Connector. A list of methods for documents, spreadsheets and presentations is available <a href="https://api.onlyoffice.com/docbuilder/integrationapi" target="_blank" rel="noopener">here</a>.</li>
<li>executeMethod allows executing certain editor methods using the connector. These methods execute a set of complex Document Builder commands. And unlike pure Document Builder commands, they are connected with the focus position in the editor. For example, the <code>GetSelectedText</code> method allows retrieving the selected content, and the <code>MoveToComment</code> method moves the focus to the comment.</li>
</ul>
<h2>Step-by-step implementation</h2>
Follow these actions and run the specified commands to manage comments in one place outside of the document.
Get all comments in your document:
<pre class="theme:github font:monospace lang:default decode:true ">connector.executeMethod("GetAllComments", null, function(comments) { /**/ })</pre>
Add a new comment to the element highlighted by the cursor:
<pre class="theme:github font:monospace lang:default decode:true ">connector.executeMethod("AddComment",[{Text: comment, UserName: userName, Time: datetime}]);</pre>
Modify any existing comment:
<pre class="theme:github font:monospace lang:default decode:true ">connector.executeMethod("ChangeComment", [commentId, newData]);</pre>
Delete any existing comment:
<pre class="theme:github font:monospace lang:default decode:true ">connector.executeMethod("RemoveComments", [commentId]);</pre>
Subscribe to the change comment event:
<pre class="theme:github font:monospace lang:default decode:true ">connector.attachEvent("onChangeCommentData",  function (data) { /**/ })</pre>
Subscribe to the add comment event:
<pre class="theme:github font:monospace lang:default decode:true ">connector.attachEvent("onAddComment",  function (comment) { /**/ })</pre>
Subscribe to the delete comment event:
<pre class="theme:github font:monospace lang:default decode:true ">connector.attachEvent("onRemoveComment",  function (data) { /**/ })</pre>
This example shows that the new Advanced API provides multiple abilities for changing and controlling the document through your program code.
We are going to constantly extend the list of available methods and events. However, if you have a specific task or request but can’t find a suitable documented method for it, please let us know. You can contact your dedicated support or sales manager directly, or use the <a href="mailto:sales@onlyoffice.com" target="_blank" rel="noopener">sales@onlyoffice.com</a> email address.
Watch our webinar on API updates to learn more about the latest enhancements for developers:
<iframe loading="lazy" width="660" height="415" src="https://www.youtube.com/embed/OxXzQpy9vFw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="allowfullscreen">﻿</iframe>
<div class="useful-links">
<h3>Useful links</h3>
<a href="https://api.onlyoffice.com/editors/connector" target="_blank" rel="noopener">API documentation</a>
<a href="/blog/?p=39739&amp;utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">API updates in version 7.2</a>
<a href="/blog/?p=39721&amp;utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">Document Builder updates</a>
<a href="/blog/?p=41938&amp;utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">Deploy ONLYOFFICE Docs on React, Angular, Vue</a>
<a href="/blog/?p=41644&amp;utm_source=blog&amp;utm_medium=article&amp;utm_campaign=connector_class" target="_blank" rel="noopener">How to enable Live Viewer</a>
</div>

ONLYOFFICE Docs Advanced API: Manage a comment feed for documents in one place

Recent posts

Use ONLYOFFICE macro to analyze spreadsheet data

Back to school 2023 with ONLYOFFICE: discounts for education

Best AI writers 2023