ONLYOFFICE Docs API avancée : Gérez un flux de commentaires pour les documents en un seul endroit

Dans cet article, vous apprendrez comment générer un flux de commentaires à partir de vos documents en utilisant l’API pour pouvoir naviguer dans les commentaires, répondre aux commentaires et les fermer en utilisant vos propres boutons/méthodes au lieu des boutons de l’éditeur.

Brève introduction

La nouvelle classe Connector API permet d’interagir avec des documents texte, des feuilles de calcul, des présentations et des formulaires à remplir depuis l’extérieur.

De cette façon, vous pouvez créer un connecteur spécial qui vous permet de lier votre interface personnalisée directement au document et d’y effectuer n’importe quelle action.

Les scénarios et les cas possibles sont les suivants :

• gérer un flux de commentaires pour tous les documents en un seul endroit ;
• remplir automatiquement des formulaires avec les données exportées des bases de données ;
• gérer le processus de révision de l’extérieur (accepter/rejeter les modifications suggérées) ;
• et autres.

Comment commencer

La classe Connector API est incluse dans l’API avancée et est disponible pour les nouvelles versions de ONLYOFFICE Docs Developer Edition à partir de la version 7.2.

Donc, tout d’abord, vous devez obtenir une nouvelle licence pour ONLYOFFICE Docs Developer Edition avec cette option incluse (dans la section Accès à l’API, sélectionnez l’option Avancée).

Acheter une licence

Si vous voulez l’essayer d’abord, commencez une nouvelle période d’essai de 30 jours de ONLYOFFICE Docs Developer Edition ou demandez une démonstration en contactant notre équipe de vente à sales@onlyoffice.com. Vous pouvez également contacter directement votre responsable commercial.

Télécharger maintenant

Ce qu’il faut faire

Pour mettre en œuvre un flux de commentaires et travailler avec les commentaires à l’aide de vos propres boutons/méthodes, vous devez créer le Connecteur. Pour ce faire, utilisez la méthode createConnector de l’objet éditeur de document :

var connector = docEditor.createConnector()

Voici les principales méthodes disponibles pour le connecteur :

• attachEvent permet d’ajouter un écouteur d’événements qui n’était auparavant disponible que dans les plugins. La liste complète est disponible ici. Parmi eux, vous trouverez des événements tels que la modification du Content Control (onChangeContentControl) ou le clic sur l’élément (onClick).
• callCommand permet d’exécuter le script Document Builder pour construire et modifier un document. Plus de 1,5 mille méthodes sont fournies par le script Document Builder, et elles sont toutes disponibles pour être exécutées dans le Connecteur. Une liste des méthodes pour les documents, les feuilles de calcul et les présentations est disponible ici.
• executeMethod permet d’exécuter certaines méthodes de l’éditeur en utilisant le connecteur. Ces méthodes exécutent un ensemble de commandes complexes de Document Builder. Et contrairement aux commandes pures de Document Builder, elles sont liées à la position du focus dans l’éditeur. Par exemple, la méthode GetSelectedText permet de récupérer le contenu sélectionné, et la méthode MoveToComment déplace le focus sur le commentaire.

Implémentation étape par étape

Suivez ces actions et exécutez les commandes spécifiées pour gérer les commentaires en un seul endroit, en dehors du document.

Obtenir tous les commentaires dans votre document :

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

Ajouter un nouveau commentaire à l’élément mis en évidence par le curseur :

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

Modifier tout commentaire existant :

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

Supprimer tout commentaire existant :

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

S’abonner à l’événement de commentaire de modification :

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

S’abonner à l’événement d’ajout de commentaire :

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

S’abonner à l’événement de suppression de commentaire :

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

Cet exemple montre que la nouvelle API avancée offre de multiples possibilités pour modifier et contrôler le document par le biais de votre code de programme.

Nous allons constamment étendre la liste des méthodes et événements disponibles. Toutefois, si vous avez une tâche ou une demande spécifique pour laquelle vous ne trouvez pas de méthode documentée appropriée, faites-le nous savoir. Vous pouvez contacter directement votre responsable du support ou des ventes, ou utiliser l’adresse sales@onlyoffice.com.

Regardez notre webinaire sur les mises à jour des API pour en savoir plus sur les dernières améliorations apportées aux développeurs :