Interface: TextEditorCommentsApi

Интерфейс для работы с коллекцией комментариев в текстовом документе.

Methods

getComments()

getComments(): Promise<DocumentComment[]>

Возвращает список комментариев текстового документа.

Returns

Promise<DocumentComment[]>

Промис, который:

• resolve в массив комментариев DocumentComment;
• reject с ошибкой GetCommentsError, если не удалось получить комментарии.

Remarks

• Метод доступен только для документов типа text.
• Порядок комментариев соответствует их расположению в документе.
• Если в документе нет комментариев, возвращается пустой массив.
• Каждый комментарий может содержать ответы CommentReply.

Example

async function loadComments() {
    if (editorApi.document.type !== 'text') {
        console.warn('Комментарии доступны только для текстовых документов');
        return;
    }

    try {
        const comments = await editorApi.document.comments.getComments();

        comments.forEach((comment) => {
            console.log('Комментарий:', comment.text);
            console.log('Автор:', comment.author?.name);

            comment.replies?.forEach((reply) => {
                console.log('  Ответ:', reply.text);
                console.log('  Автор ответа:', reply.author?.name);
            });
        });

        setComments(comments);
    } catch (error) {
        if (error instanceof GetCommentsError) {
            console.error('Ошибка получения комментариев:', error.message);
        } else {
            console.error('Неизвестная ошибка:', error);
        }
    }
}