ONLYOFFICE Docs Advanced API: gestisci un feed di commenti per i documenti in un unico posto
In questo articolo imparerai come generare un feed con i commenti dai tuoi documenti utilizzando l’API per poter navigare tra i commenti, rispondere ai commenti e chiuderli utilizzando i tuoi pulsanti/metodi anziché i pulsanti dell’editor.
Una breve introduzione
La nuova classe Connector API consente di interagire con documenti di testo, fogli di calcolo, presentazioni e moduli compilabili dall’esterno.
In questo modo, puoi creare un connettore speciale che ti consente di collegare la tua interfaccia personalizzata direttamente al documento ed eseguire qualsiasi azione al suo interno.
Possibili scenari e casi includono:
- gestire un feed di commenti per tutti i documenti in un unico posto;
- compilazione automatica dei moduli con i dati esportati dalle banche dati;
- gestire il processo di revisione dall’esterno (accettare/rifiutare le modifiche suggerite);
- e altro ancora.
Come iniziare
La classe Connector API è inclusa nell’API avanzata ed è disponibile per le nuove build di ONLYOFFICE Docs Developer Edition a partire dalla versione 7.2.
Quindi, prima di tutto, devi ottenere una nuova licenza per ONLYOFFICE Docs Developer Edition con questa opzione inclusa (nella sezione Accesso alle API seleziona l’opzione Avanzate).
Se vuoi provarlo prima, inizia un nuovo periodo di prova di 30 giorni di ONLYOFFICE Docs Developer Edition o richiedi una demo contattando il nostro team di vendita all’indirizzo sales@onlyoffice.com. Puoi anche contattare direttamente il tuo responsabile vendite dedicato.
Cosa devi fare
Per implementare un feed di commenti e lavorare con i commenti utilizzando i propri pulsanti/metodi, è necessario creare il connettore. Per farlo, usa il metodo createConnector dell’oggetto editor di documenti:
var connector = docEditor.createConnector()
Di seguito sono riportati i metodi più importanti disponibili per il Connector:
- attachEvent consente di aggiungere un listener di eventi precedentemente disponibile solo dai plug-in. Un elenco completo è disponibile qui. Tra questi, troverai eventi come la modifica del controllo del contenuto (
onChangeContentControl) o cliccando sull’elemento (onClick). - callCommand consente di eseguire lo script Document Builder per creare e modificare un documento. Più di 1,5 mila metodi sono forniti dallo script Builder Document e diventano tutti disponibili per l’esecuzione nel Connector. Un elenco di metodi per documenti, fogli di calcolo e presentazioni è disponibile qui.
- executeMethod consente di eseguire determinati metodi dell’editor utilizzando il connettore. Questi metodi eseguono una serie di comandi complessi di Document Builder. E a differenza dei puri comandi di Document Builder, sono collegati alla posizione focus nell’editor. Ad esempio, il metodo
GetSelectedTextconsente di recuperare il contenuto selezionato e il metodoMoveToCommentsposta lo stato attivo sul commento.
Implementazione passo dopo passo
Segui queste azioni ed esegui i comandi specificati per gestire i commenti in un punto esterno al documento. Ottieni tutti i commenti nel tuo documento:
connector.executeMethod("GetAllComments", null, function(comments) { /**/ })Aggiungi un nuovo commento all’elemento evidenziato dal cursore:
connector.executeMethod("AddComment",[{Text: comment, UserName: userName, Time: datetime}]);Modifica qualsiasi commento esistente:
connector.executeMethod("ChangeComment", [commentId, newData]);Elimina qualsiasi commento esistente:
connector.executeMethod("RemoveComments", [commentId]);Iscriviti all’evento del commento di modifica:
connector.attachEvent("onChangeCommentData", function (data) { /**/ })Iscriviti all’evento di aggiungere commento:
connector.attachEvent("onAddComment", function (comment) { /**/ })Iscriviti all’evento di eliminare i commenti:
connector.attachEvent("onRemoveComment", function (data) { /**/ })Questo esempio mostra che la nuova API avanzata fornisce più capacità per modificare e controllare il documento tramite il codice del programma.
Estenderemo costantemente l’elenco dei metodi e degli eventi disponibili. Tuttavia, se hai un’attività o una richiesta specifica ma non riesci a trovare un metodo documentato adatto, faccelo sapere. Puoi contattare direttamente il tuo supporto dedicato o il responsabile vendite oppure utilizzare l’indirizzo email sales@onlyoffice.com.
Guarda il nostro webinar sugli aggiornamenti delle API per saperne di più sugli ultimi miglioramenti per gli sviluppatori:
