API avanzada de ONLYOFFICE Docs: gestiona una fuente de comentarios en tus documentos en un solo lugar
En este artículo aprenderás a generar una fuente con comentarios de tus documentos utilizando la API para poder navegar por los comentarios, responder a los mismos y cerrarlos mediante tus propios botones/métodos en lugar de los botones del editor.
Una breve introducción
La nueva clase Connector API permite interactuar con documentos de texto, hojas de cálculo, presentaciones y formularios rellenables desde el exterior.
De este modo, puedes crear un conector especial que te permita enlazar tu interfaz personalizada directamente con el documento y realizar cualquier acción en él.
Los posibles escenarios y casos incluyen:
- gestión de una fuente de comentarios para todos los documentos en un solo lugar;
- relleno automático de formularios con los datos exportados de las bases de datos;
- gestión del proceso de revisión desde el exterior (aceptación/rechazo de los cambios sugeridos);
- y mucho más.
Cómo empezar
La clase Connector API está incluida en la API avanzada y está disponible para ONLYOFFICE Docs Developer Edition a partir de la versión 7.2.
En primer lugar, es necesario obtener una nueva licencia de ONLYOFFICE Docs Developer Edition con esta opción incluida (en la sección Acceso a la API selecciona la opción Avanzada).
En caso de que quieras probarlo primero, inicia un nuevo periodo de prueba de 30 días de ONLYOFFICE Docs Developer Edition o solicita una demostración contactando con nuestro equipo de ventas a través de sales@onlyoffice.com. También puedes ponerte en contacto directamente con tu responsable de ventas.
Lo que hay que hacer
Para implementar una fuente de comentarios y trabajar con los mismos mediante tus propios botones/métodos, necesitas crear el conector. Para ello, utiliza el método createConnector del objeto del editor de documentos:
var connector = docEditor.createConnector()
Entre los métodos más importantes disponibles para el conector se encuentran los siguientes:
- attachEvent permite añadir una escucha de eventos que antes sólo estaba disponible en los plugins. La lista completa está disponible aquí. Entre ellos, encontrarás eventos para cambiar los controles de contenido (
onChangeContentControl) o hacer clic en el elemento (onClick). - callCommand permite ejecutar el script del Document Builder para construir y modificar un documento. El script del Document Builder proporciona más de 1,5 mil métodos, y todos ellos están disponibles para ser ejecutados en el connector. La lista de métodos para documentos, hojas de cálculo y presentaciones está disponible aquí.
- executeMethod permite ejecutar ciertos métodos del editor utilizando el conector. Estos métodos ejecutan un conjunto de comandos complejos del Document Builder. Y a diferencia de los comandos puros del Document Builder, están conectados con la posición del foco en el editor. Por ejemplo, el método
GetSelectedTextpermite recuperar el contenido seleccionado, y el métodoMoveToCommentmueve el foco al comentario.
Implementación paso a paso
Sigue estas acciones y ejecuta los comandos especificados para gestionar los comentarios en un lugar fuera del documento.
Obtén todos los comentarios de tu documento:
connector.executeMethod("GetAllComments", null, function(comments) { /**/ })Añade un nuevo comentario al elemento resaltado por el cursor:
connector.executeMethod("AddComment",[{Text: comment, UserName: userName, Time: datetime}]);Modifica cualquier comentario existente:
connector.executeMethod("ChangeComment", [commentId, newData]);Elimina cualquier comentario existente:
connector.executeMethod("RemoveComments", [commentId]);Suscríbete al evento que cambia comentarios:
connector.attachEvent("onChangeCommentData", function (data) { /**/ })Suscríbete al evento que añade comentarios:
connector.attachEvent("onAddComment", function (comment) { /**/ })Suscríbete al evento que elimina comentarios:
connector.attachEvent("onRemoveComment", function (data) { /**/ })Este ejemplo muestra que la nueva API avanzada proporciona múltiples opciones para cambiar y controlar el documento a través del código de tu programa.
Vamos a ampliar constantemente la lista de métodos y eventos disponibles. Sin embargo, si tienes una tarea o solicitud específica pero no encuentras un método documentado adecuado para ella, por favor, háznoslo saber. Puedes ponerte en contacto directamente con tu gestor de soporte o de ventas, o utilizar la dirección de correo electrónico sales@onlyoffice.com.
Echa un vistazo a nuestro seminario web sobre las actualizaciones de la API para obtener más información sobre las últimas mejoras para los desarrolladores:
