Упоминания

Рисунок и приведенные ниже шаги объясняют процесс упоминания пользователей в комментариях в Р7 Document Server.

1. Пользователь отправляет запрос на получение списка пользователей для упоминания, набрав знак + в поле комментария в редакторе документа.
2. Редактор документа информирует менеджера документа о запросе.
3. Менеджер документов отправляет список пользователей в редактор документов, где этот список будет отображаться под полем комментария.
4. Пользователь вводит комментарий в поле комментария в редакторе документа, и комментарий добавляется в документ.
5. Редактор документов отправляет сообщение, список электронных писем и действий ссылки в документе менеджеру документов.

Как это можно сделать на практике

1. Создайте пустой HTML-файл, чтобы открыть документ.
2. Укажите обработчик события, чтобы подсказка об упоминании пользователей в комментариях отображалась в скрипте конфигурации для инициализации Редактора документов. Когда пользователь набирает знак +, вызывается событие onRequestUsers, и комментатор может выбрать других пользователей для упоминания в комментариях.

   var onRequestUsers = function(){
       ...
   };
   
   var docEditor = new DocsAPI.DocEditor("placeholder", {
       "events": {
           "onRequestUsers": onRequestUsers,
           ...
       },
       ...
   });

3. Чтобы установить список пользователей под полем комментария, необходимо вызвать метод setUsers:

   docEditor.setUsers({
       "users": [
           {
               "email": "john@example.com",
               "name": "John Smith"
           },
           {
               "email": "kate@example.com",
               "name": "Kate Cage"
           },
           ...
       ]
   });
   

   Где example.com — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе как это работает

   Параметр	Описание	Тип	Наличие
   users	Определяет список пользователей.	массив строк	необязательно
   users.email	Определяет адрес электронной почты пользователя.	строковый	обязательно
   users.name	Определяет полное имя пользователя.	строковый	обязательно

Открытие комментария

var onRequestSendNotify = function(event) {
    var ACTION_DATA = event.data.actionLink;
    var comment = event.data.message;
    var emails = event.data.emails;
    ...
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestSendNotify": onRequestSendNotify,
        ...
    },
    ...
});

Настройки общего доступа

При вызове события onRequestSendNotify интеграторы ПО предоставляют доступ к файлу, отправляют уведомления указанным пользователям со ссылкой действия, позволяющей прокрутить документ до позиции комментария.

В случае, когда при инициализации документа используется поле document.info.sharingSettings, но список пользователей из события onRequestSendNotify другой, необходимо вызвать метод setSharingSettings.

docEditor.setSharingSettings({
    "sharingSettings": [
        {
            "permissions": "Full Access",
            "user": "John Smith"
        },
        {
            "isLink": true,
            "permissions": "Read Only",
            "user": "External link"
        }
    ]
});