API avançada do ONLYOFFICE Docs: gerencie um feed de comentários para documentos em um só lugar

Neste artigo, você aprenderá como gerar um feed com comentários de seus documentos usando a API para poder navegar pelos comentários, responder aos comentários e fechá-los usando seus próprios botões/métodos em vez dos botões do editor.

Uma breve introdução

A classe Connector API recém-adicionada permite interagir com documentos de texto, planilhas, apresentações e formulários preenchíveis de fora.

Dessa forma, você pode criar um Conector especial que permite vincular sua interface personalizada diretamente ao documento e realizar quaisquer ações nele.

Possíveis cenários e casos incluem:

• gerenciar um feed de comentários para todos os documentos em um só lugar;
• preenchimento automático de formulários com os dados exportados das bases de dados;
• gerenciar o processo de revisão externamente (aceitar/rejeitar as alterações sugeridas);
• e mais.

Como começar

A classe Connector API está incluída na API avançada e está disponível para novas compilações do ONLYOFFICE Docs Developer Edition a partir da versão 7.2.

Então, antes de tudo, você precisa obter uma nova licença para ONLYOFFICE Docs Developer Edition com esta opção incluída (na seção Acesso à API selecione a opção Avançado).

Adquira uma licença

Caso queira experimentá-lo primeiro, inicie um novo período de avaliação de 30 dias do ONLYOFFICE Docs Developer Edition ou solicite uma demonstração entrando em contato com nossa equipe de vendas em sales@onlyoffice.com. Você também pode entrar em contato diretamente com seu gerente de vendas dedicado.

Baixe Agora

O que você precisa fazer

Para implementar um feed de comentários e trabalhar com comentários usando seus próprios botões/métodos, você precisa criar o Conector.
Para fazê-lo, use o createConnector método do objeto do editor de documentos:

var connector = docEditor.createConnector()

Aqui estão os métodos mais importantes disponíveis para o Conector:

• attachEvent permite adicionar um ouvinte de eventos anteriormente disponível apenas em plugins. Uma lista completa está disponível aqui. Entre eles, você encontrará eventos como alterar o controle de conteúdo (onChangeContentControl) ou clicando no elemento (onClick).
• callCommand permite executar o script do Document Builder para construir e modificar um documento. Mais de 1,5 mil métodos são fornecidos pelo script do Document Builder, e todos ficam disponíveis para execução no Connector. Uma lista de métodos para documentos, planilhas e apresentações está disponível aqui.
• executeMethod permite executar certos métodos do editor usando o conector. Esses métodos executam um conjunto de comandos complexos do Document Builder. E, ao contrário dos comandos puros do Document Builder, eles são conectados à posição de foco no editor. Por exemplo, o GetSelectedText método permite recuperar o conteúdo selecionado, e o MoveToComment método move o foco para o comentário.

Implementação passo a passo

Siga essas ações e execute os comandos especificados para gerenciar comentários em um local fora do documento.

Obtenha todos os comentários em seu documento:

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

Adicionar um novo comentário ao elemento destacado pelo cursor:

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

Modifique qualquer comentário existente:

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

Excluir qualquer comentário existente:

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

Inscreva-se no evento de comentário de alteração:

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

Inscreva-se no evento adicionar comentário:

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

Inscreva-se no evento de exclusão de comentários:

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

Este exemplo mostra que a nova API avançada fornece várias habilidades para alterar e controlar o documento por meio do código do programa.

Vamos estender constantemente a lista de métodos e eventos disponíveis. No entanto, se você tiver uma tarefa ou solicitação específica, mas não conseguir encontrar um método documentado adequado para isso, informe-nos. Você pode entrar em contato diretamente com seu suporte dedicado ou gerente de vendas ou usar o endereço de email sales@onlyoffice.com .

Assista ao nosso webinar sobre atualizações da API para saber mais sobre as melhorias mais recentes para desenvolvedores: