Como adicionar, excluir e gerenciar comentários de forma eficaz usando a API REST do .NET

visualização de comentários em arquivo ms word

No reino dinâmico da criação e colaboração de documentos, a capacidade de adicionar e gerenciar comentários no Microsoft Word é indispensável. Os comentários servem como um quadro de discussão virtual, permitindo que os colaboradores troquem ideias, sugiram melhorias e forneçam feedback sem alterar o conteúdo original. Esse recurso não apenas facilita a comunicação eficaz, mas também aprimora o processo de edição colaborativa, tornando-o mais simplificado e eficiente. Portanto, neste guia, vamos nos aprofundar nos aspectos essenciais da adição e exclusão de comentários, revelando o potencial e os benefícios desse recurso vital no MS Word usando a API REST .NET.

Gerenciar comentários usando a API REST do .NET
Obter comentários de arquivos DOCX
Inserir comentários em documento do Word
Atualizar comentários no arquivo Word
Excluir comentários do documento do Word

Gerenciar comentários usando a API REST do .NET

Manipular e adicionar comentários usando Aspose.Words Cloud SDK para .NET traz uma riqueza de benefícios e uma ampla gama de recursos além do gerenciamento de comentários. Além disso, o SDK também oferece uma ampla gama de recursos, incluindo geração de documentos do Word, conversão de Word para JPG, Word para PDF, Word para ODT etc., manipulação de texto e formatação, processamento de imagens e uma ampla gama de recursos, permitindo que você aprimore seus recursos de processamento de documentos para uma variedade de cenários.

Obter comentários de arquivos DOCX

Você pode aproveitar para ler todos ou comentários específicos do documento. O método GetComments fornece os recursos para ler os comentários do usuário do arquivo DOCX. Especificado abaixo está um comando cURL que você pode usar para ler os comentários no prompt de comando.

comando cURL

Observe que, para ler comentários, você precisa fornecer os detalhes sobre os documentos armazenados no armazenamento em nuvem, bem como apenas usuários autorizados, obter as permissões para acessar as APIs. Portanto, você precisa primeiro recuperar o token de autenticação JWT e usá-lo no comando, conforme mencionado acima.

curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=xxxxxxx-1c8e-4ea4-a948-3857547232fa&client_secret=xxxxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accpet: application/json"

Depois que o token JWT for gerado, execute o seguinte comando para obter todos os comentários no documento do Word.

curl -v "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments" \
-X GET \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>"

URL da solicitação

https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments

C#.NET

Para ler um comentário específico do documento, siga as etapas especificadas abaixo:

Inicializa uma instância da classe WordsApi.
Crie um objeto da classe GetCommentRequest onde fornecemos o nome do arquivo de entrada Volume 1.docx e o valor do índice de comentário como argumentos de entrada.
Por fim, inicialize um objeto de CommentResponse enquanto passa o valor retornado do método GetComment(..).

const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// inicializar e objeto de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nome do arquivo de entrada
String filename= "Volume 1.docx";
// índice de comentários
int commentIndex = 0;
// create an object of GetCommentRequest where we pass nome do arquivo de entrada and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.GetCommentRequest request = new Aspose.Words.Cloud.Sdk.Model.Requests.GetCommentRequest(filename, commentIndex, null, null, null, null);
// crie uma instância de CommentResponse e leia o comentário do documento
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.GetComment(request);
// exibir o comentário no console
Console.Write(response.Comment);

Obter todos os comentários

A API também oferece o recurso de obter todos os comentários do documento (caso não queiramos atravessar entre indivíduos).Para esse requisito, você precisa criar uma instância das classes GetCommentsRequest, CommentsResponse e chamar o método GetComments(..) do objeto WordsApi.

Inserir comentários em documento do Word

A API também é capaz de adicionar/inserir novos objetos de comentário em um documento do Word.

comando cURL

curl -v "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments" \
-X POST \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>" \
-H "Content-Type: application/json" \
-d "{\"RangeStart\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 2\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"RangeEnd\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/5/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 2\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"Author\":\"Nayyer Shahbaz\",\"Initial\":\"MOU\",\"DateTime\":\"2020-12-07T04:10:03.942Z\",\"Text\":\"Comments Inserted using Aspose.Words Cloud API\"}"

C#.NET

const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// inicializar e objeto de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nome do arquivo de entrada
String filename = "Volume 1.docx";
// índice de comentários
int commentIndex = 0;

Aspose.Words.Cloud.Sdk.Model.NodeLink link = new Aspose.Words.Cloud.Sdk.Model.NodeLink()
{
    NodeId = "0.1.0.1.1.1.1"
};
Aspose.Words.Cloud.Sdk.Model.DocumentPosition documentPosition = new Aspose.Words.Cloud.Sdk.Model.DocumentPosition()
{
    Node = link,
    Offset = 0
};
Aspose.Words.Cloud.Sdk.Model.CommentInsert commentInsert = new Aspose.Words.Cloud.Sdk.Model.CommentInsert()
{
    Initial = "Aspose",
    Author = "Nayyer Shahbaz",
    RangeStart = documentPosition,
    RangeEnd = documentPosition,
    Text = "Comment added through API"
};


// create an object of GetCommentRequest where we pass nome do arquivo de entrada and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.InsertCommentRequest request = 
  new Aspose.Words.Cloud.Sdk.Model.Requests.InsertCommentRequest(filename, commentInsert, null, null, null);
// crie uma instância de CommentResponse e leia o comentário do documento
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.InsertComment(request);

Inserir pré-visualização de comentários. — Imagem 1:- pré-visualização do comentário recém-inserido

Atualizar comentários no arquivo Word

Além da análise e adição de comentários, a API também oferece suporte ao recurso de atualização dos comentários existentes dentro do documento do Word.

comando cURL

curl -X PUT "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments/1" \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>" \
-H "Content-Type: application/json" \
-d "{\"RangeStart\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 1\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"RangeEnd\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"string\",\"Type\":\"string\",\"Title\":\"Heading 1\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"Author\":\"Nayyer Shahbaz\",\"Initial\":\"Aspose.Words\",\"DateTime\":\"2020-12-07T06:18:31.348Z\",\"Text\":\"Comments updated using Aspose.Words Cloud API\"}"

C#.NET

Para atualizar programaticamente os comentários no documento do Word, siga as instruções especificadas abaixo.

Crie uma instância da classe WordsApi.
Crie um objeto de NodeLink que defina o comentário NodeID.
Um novo objeto da classe DocumentPosition é criado e define os valores RangeStart e RangeEnd.
Crie um objeto de CommentUpdate que defina as iniciais do comentário, o nome do autor, os detalhes do RangeStart e do RangeEnd atribuindo o valor da instância DocumentPosition e o texto a ser atualizado no comentário.

const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// inicializar e objeto de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nome do arquivo de entrada
String filename = "Volume 1.docx";
// índice de comentários
int commentIndex = 1;

Aspose.Words.Cloud.Sdk.Model.NodeLink link = new Aspose.Words.Cloud.Sdk.Model.NodeLink()
{
    NodeId = "0.1.0.1.1.1.1"
};
Aspose.Words.Cloud.Sdk.Model.DocumentPosition documentPosition = new Aspose.Words.Cloud.Sdk.Model.DocumentPosition()
{
    Node = link,
    Offset = 0
};
Aspose.Words.Cloud.Sdk.Model.CommentUpdate commentUpdate = new Aspose.Words.Cloud.Sdk.Model.CommentUpdate()
{
    Initial = "Aspose",
    Author = "Nayyer Shahbaz",
    RangeStart = documentPosition,
    RangeEnd = documentPosition,
    Text = "Comments updated using Aspose.Words Cloud API"
};

// create an object of GetCommentRequest where we pass nome do arquivo de entrada and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.UpdateCommentRequest request =
                    new Aspose.Words.Cloud.Sdk.Model.Requests.UpdateCommentRequest(filename, commentIndex, commentUpdate, null, null, null);
// crie uma instância de CommentResponse e leia o comentário do documento
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.UpdateComment(request);

Atualizar visualização de comentários — Imagem 2:- pré-visualização dos comentários atualizados

O documento resultante Volume 1 - updated.docx também está anexado.

Excluir comentários do documento do Word

Você também pode remover/excluir os comentários do arquivo Word usando a API REST na nuvem.

comando cURL

curl -X DELETE "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments/0" \
-H "accept: /" \
-H "Authorization: Bearer <JWT Token>"

C#.NET

Crie um objeto da classe WordsApi.
Crie uma instância da classe DeleteCommentRequest que recebe um arquivo de entrada e um índice de comentário como argumento.
Finalmente o método DeleteComment(…) tendo o objeto DeleteCommentRequest como argumento.

const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// inicializar e objeto de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nome do arquivo de entrada
String filename = "Volume 1.docx";
// índice de comentários
int commentIndex = 0;


Aspose.Words.Cloud.Sdk.Model.Requests.DeleteCommentRequest request = 
  new Aspose.Words.Cloud.Sdk.Model.Requests.DeleteCommentRequest(filename, commentIndex, null, null, null, null, null, null, null);
wordsApi.DeleteComment(request);

Visualização de comentários excluídos — Imagem 3:- pré-visualização de comentários excluídos

Gerenciar comentários usando a API REST do .NET#

Obter comentários de arquivos DOCX#

comando cURL#

C#.NET#

Inserir comentários em documento do Word#

comando cURL#

C#.NET#

Atualizar comentários no arquivo Word#

comando cURL#

C#.NET#

Excluir comentários do documento do Word#

comando cURL#

C#.NET#

Gerenciar comentários usando a API REST do .NET

Obter comentários de arquivos DOCX

comando cURL

C#.NET

Inserir comentários em documento do Word

comando cURL

C#.NET

Atualizar comentários no arquivo Word

comando cURL

C#.NET

Excluir comentários do documento do Word

comando cURL

C#.NET