Erweiterte API von ONLYOFFICE Docs: Verwalten Sie einen Kommentar-Feed für Dokumente zentralisiert

In diesem Artikel erfahren Sie, wie Sie mit der API einen Feed mit Kommentaren aus Ihren Dokumenten generieren können, um durch Kommentare zu navigieren, auf Kommentare zu antworten und sie zu schließen, indem Sie Ihre eigenen Schaltflächen/Methoden anstelle der Editor-Schaltflächen verwenden.

Kurze Einführung

Die neu hinzugefügte Connector API-Klasse ermöglicht die Interaktion mit Textdokumenten, Tabellenkalkulationen, Präsentationen und ausfüllbaren Formularen von außen.

So können Sie einen speziellen Konnektor erstellen, mit dem Sie Ihre benutzerdefinierte Schnittstelle direkt mit dem Dokument verknüpfen und beliebige Aktionen darin durchführen können.

Zu den möglichen Szenarien gehören:

• Verwaltung eines Kommentar-Feeds für alle Dokumente an einem Ort;
• automatisches Ausfüllen von Formularen mit den aus Datenbanken exportierten Daten;
• Verwaltung des Überprüfungsprozesses von außen (Annahme/Ablehnung von Änderungsvorschlägen);
• und mehr.

So funktioniert es

Die Connector API-Klasse ist in der Advanced API enthalten und ist für neue Builds der ONLYOFFICE Docs Developer Edition ab Version 7.2 verfügbar.

Sie müssen also zunächst eine neue Lizenz für ONLYOFFICE Docs Developer Edition erwerben, die diese Option enthält (wählen Sie im Abschnitt Zugang zur API die Option Erweitert aus).

Lizenz erwerben

Wenn Sie es zuerst ausprobieren möchten, starten Sie eine neue 30-tägige Testperiode der ONLYOFFICE Docs Developer Edition oder fordern Sie eine Demo an, indem Sie unser Vertriebsteam unter sales@onlyoffice.com kontaktieren. Sie können sich auch gerne direkt an Ihre/n zuständige/n VertriebsleiterIn wenden.

Herunterladen

Was Sie tun sollten

Um einen Kommentar-Feed zu implementieren und mit eigenen Schaltflächen/Methoden mit Kommentaren zu arbeiten, müssen Sie den Connector erstellen. Verwenden Sie dazu die Methode createConnector des Dokumenteditor-Objekts:

var connector = docEditor.createConnector()

Hier sind die wichtigsten Methoden, die für den Konnektor verfügbar sind:

• attachEvent erlaubt das Hinzufügen eines Ereignisses, was bisher nur von Plugins unterstützt wurde. Eine vollständige Liste ist hier verfügbar. Darunter finden sich Ereignisse wie das Ändern des Inhaltssteuerelements  (onChangeContentControl) oder das Klicken auf ein Element (onClick).
• callCommand erlaubt die Ausführung des Document Builder-Skripts zur Erstellung und Änderung eines Dokuments. Das Document Builder-Skript stellt mehr als 1,5 Tausend Methoden zur Verfügung, die alle über den Konnektor ausgeführt werden können. Eine Liste der Methoden für Dokumente, Tabellenkalkulationen und Präsentationen finden Sie hier.
• executeMethod erlaubt die Ausführung bestimmter Editor-Methoden über den Konnektor. Diese Methoden führen eine Reihe von komplexen Document Builder-Befehlen aus. Und im Gegensatz zu reinen Document Builder-Befehlen sind sie mit der Fokusposition im Editor verknüpft. Die Methode GetSelectedText ermöglicht beispielsweise das Abrufen des ausgewählten Inhalts, und die Methode MoveToComment verschiebt den Fokus auf den Kommentar.

Schrittweise Implementierung

Befolgen Sie diese Aktionen und führen Sie die angegebenen Befehle aus, um Kommentare an einem Ort außerhalb des Dokuments zu verwalten.

Alle Kommentare in Ihrem Dokument abrufen:

connector.executeMethod("GetAllComments", null, function(comments) { /**/ })

Hinzufügen eines neuen Kommentars zu dem mit dem Mauszeiger markierten Element:

connector.executeMethod("AddComment",[{Text: comment, UserName: userName, Time: datetime}]);

Vorhandenen Kommentar ändern:

connector.executeMethod("ChangeComment", [commentId, newData]);

Einen bestehenden Kommentar löschen:

connector.executeMethod("RemoveComments", [commentId]);

Anmeldung zum Ändern eines Kommentars:

connector.attachEvent("onChangeCommentData",  function (data) { /**/ })

Anmeldung zum Hinzufügen eines Kommentars:

connector.attachEvent("onAddComment",  function (comment) { /**/ })

Anmeldung zum Löschen eines Kommentars:

connector.attachEvent("onRemoveComment",  function (data) { /**/ })

Dieses Beispiel zeigt, dass die neue erweiterte API mehrere Möglichkeiten zur Änderung und Steuerung des Dokuments durch Ihren Programmcode bietet.

Wir werden die Liste der verfügbaren Methoden und Ereignisse ständig erweitern. Wenn Sie jedoch eine bestimmte Aufgabe oder Anfrage haben, aber keine geeignete dokumentierte Methode dafür finden können, lassen Sie es uns bitte wissen. Sie können sich direkt an Ihren zuständigen Support- oder Vertriebsleiter wenden oder die E-Mail-Adresse sales@onlyoffice.com verwenden.

Sehen Sie sich unser Webinar über API-Updates an, um mehr über die neuesten Verbesserungen für Entwickler zu erfahren: