Справочный центр
Сервер документов Р7-Офис

Методы

После инициализации редактора документов вы получите объект, который можно использовать для вызова методов.

var docEditor = new DocsAPI.DocEditor("placeholder", config);
  • denyEditingRights - запретить редактирование. Данный метод может быть вызван, когда вы хотите сделать невозможным редактирование документа.

    docEditor.denyEditingRights(message);
    
    Параметр Описание Тип Наличие
    message Определяет тексты сообщений для диалогов. строка необязательный
  • destroyEditor - уничтожить объект docEditor. Данный метод может быть вызван, если вы хотите заново инициализировать редактор документов с иной конфигурацией. Данный метод не используется.

    docEditor.destroyEditor();
    
  • downloadAs - скачать отредактированный файл. Этот метод может быть вызван только при существовании события onDownloadAs. Сервис редактирования документов асинхронно создаёт документ и вызывает событие onDownloadAs со ссылкой в параметре.

    docEditor.downloadAs();
    
  • insertImage - Вставить изображение в файл. Этот метод может быть вызван после событий onRequestInsertImage.

    docEditor.insertImage({
        "fileType": "png",
        "url": "https://example.com/url-to-example-image.png"
    });
    

    Где example.com - это имя, где установлены менеджер документов и сервис хранения документов. Перейдите в раздел Как это работает, чтобы узнать больше о взаимодействии службы Сервера документов с клиентским сервером.

    Параметр Описание Тип Наличие
    fileType Определяет тип изображения, который будет помещен в файл. Может быть: bmp, gif, jpeg, jpg, png строка обязательный
    токен Определяет зашифрованную подпись, добавленную в параметры Сервера документов в виде токена. строка необязательный
    url Определяет абсолютный URL-адрес, где находится изображение. строка необязательный
  • refreshHistory - показывает историю версий документа. Данный метод необходимо вызывать после событий onRequestHistory.

    docEditor.refreshHistory({
        "currentVersion": 2,
        "history": [
            {
                "changes": changes, // changes от объекта истории возвращаются после сохранения документа
                "created": "2010-07-06 10:13 AM",
                "key": "af86C7e71Ca8",
                "serverVersion": serverVersion, // serverVersion возвращается объектом истории после сохранения документа
                "user": {
                    "id": "F89d8069ba2b",
                    "name": "Елена Иванова"
                },
                "version": 1
            },
            {
                "changes": changes,
                "created": "07.07.2010 15:46 AM",
                "key": "Khirz6zTPdfd7",
                "serverVersion": serverVersion,
                "user": {
                    "id": "78e1e841",
                    "name": "Иван Петров"
                },
                "version": 2
            },
            ...
        ],
    });
    

    Показ сообщения об ошибке, поясняющей, почему история версий документа не может быть отображена.

    docEditor.refreshHistory({
        "error": "Exception",
    });
    
    Параметр Описание Тип Наличие
    currentVersion Определяет текущий номер версии документа. целочисленный обязательный
    error Определяет текст сообщения об ошибке. строка необязательный
    history Определяет массив с версиями документа. массив обязательный
    history.changes Определяет изменения, которые возвращаются от объекта истории после сохранения документа. объект необязательный
    history.created Определяет дату создания версии документа. строка обязательный
    history.key Определяет уникальный идентификатор, используемый для распознавания документа сервисом. строка обязательный
    history.user Определяет пользователя, который является автором версии документа. объект необязательный
    history.user.id Определяет идентификатор пользователя, который является автором версии документа. строка необязательный
    history.user.name Определяет имя пользователя, который является автором версии документа. строка необязательный
    history.version Определяет номер версии документа. целочисленный обязательный
  • setActionLink - устанавливает ссылку на документ, содержащий закладку. Данный метод необходимо вызвать после события onMakeActionLink. Чтобы установить ссылку, интегратор должен обработать ACTION_DATA, полученную от службы редактирования документов.

    docEditor.setActionLink(link);
    
    Параметр Описание Тип Наличие
    ссылка Определяет ссылку, позволяющую перейти к положению закладки в документе. строка обязательный
  • setHistoryData - отправляет ссылку на документ для просмотра истории версий. Данный метод необходимо вызывать после событий onRequestHistoryData.

    docEditor.setHistoryData({
        "key": "Khirz6zTPdfd7",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3giLCJ2ZXJzaW9uIjoyfQ.N9N9IMwX5e6kdfx4wssAPrGMnzPAZCd4PwDf2D8mJ8s",
        "url": "https://example.com/url-to-example-document.docx",
        "version": 2
    });
    

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

    Если после редактирования и сохранения документа, возвращается ссылка changesurl на документ, в котором были произведены изменения, загрузите файл, используя эту ссылку и отправьте ссылку на файл в параметре changesUrl. Абсолютная ссылка на документ предыдущей версии должна быть передан в параметре previous.url.

    docEditor.setHistoryData({
        "changesUrl": "https://example.com/url-to-changes.zip",
        "key": "Khirz6zTPdfd7",
        "previous": {
            "key": "af86C7e71Ca8",
            "url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaGFuZ2VzVXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1jaGFuZ2VzLnppcCIsImtleSI6IktoaXJ6NnpUUGRmZDciLCJwcmV2aW91cyI6eyJrZXkiOiJhZjg2QzdlNzFDYTgiLCJ1cmwiOiJodHRwOi8vZXhhbXBsZS5jb20vdXJsLXRvLXRoZS1wcmV2aW91cy12ZXJzaW9uLW9mLXRoZS1kb2N1bWVudC5kb2N4In0sInVybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.9dgDsaVLFQ6RtoX_1s2pBVJHGnyMjxDXKC2TpC2nXb4",
        "url": "https://example.com/url-to-example-document.docx",
        "version": 2
    });
    

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

    Отправка сообщения об ошибке, поясняющей, почему версия документа не может быть отображена.

    docEditor.setHistoryData({
        "error": "Exception",
        "version": 2
    });
    
    Параметр Описание Тип Наличие
    changesUrl Определяет ссылку на файл с данными об изменениях в документе, который может быть загружен, используя ссылку changesurl из JSON объекта, который возвращается после сохранения документа. строка необязательный
    error Определяет текст сообщения об ошибке. строка необязательный
    key Определяет идентификатор документа, используемый, чтобы однозначно идентифицировать файл документа. строка обязательный
    previous Определяет объект документа предыдущей версии, если ссылка changesUrl была возвращена после сохранения документа. объект необязательный
    previous.key Определяет идентификатор документа предыдущей версии. строка обязательный
    previous.url Определяет ссылку на документ предыдущей версии. строка обязательный
    token Определяет закодированную подпись, добавляемую к параметру в виде токена. строка необязательный
    url Определяет ссылку на документ текущей версии. Может быть загружен, используя ссылку url из JSON объекта, который возвращается после сохранения документа. строка обязательный
    version Определяет номер версии документа. целочисленный обязательный
  • setMailMergeRecipients - вставить данные получателя для слияния почты в файл. Данный метод необходимо вызвать после событий onRequestMailMergeRecipients.

    docEditor.setMailMergeRecipients({
        "fileType": "xlsx",
        "url": "https://example.com/url-to-example-recipients.xlsx"
    });
    

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

    Параметр Описание Тип Наличие
    fileType Определяет тип электронной таблицы для слияния почты в файле. Может быть: xlsx. строка обязательный
    token Определяет зашифрованную подпись, добавляемую к параметру в виде токена. строка необязательный
    url Определяет абсолютный URL-адрес, по которому хранятся исходные данные. строка обязательный
  • setRevisedFile - выбрать документ для сравнения. Данный метод необходимо вызвать после событий onRequestCompareFile.

    docEditor.setRevisedFile({
        "fileType": "docx",
        "url": "https://example.com/url-to-example-document.docx"
    });
    

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

    Параметр Описание Тип Наличие
    fileType Определяет тип изображения для вставки в файл. строка обязательный
    token Определяет зашифрованную подпись, добавляемую к параметру в виде токена. строка необязательный
    url Определяет абсолютный URL-адрес, по которому хранится исходное изображение. строка обязательный
  • setSharingSettings - Обновляет информацию о настройках, которые позволяют делиться документом с другими пользователями. Данный метод необходимо вызвать после событий onRequestSharingSettings.

    docEditor.setSharingSettings({
        "sharingSettings": [
            {
                "permissions": "Full Access",
                "user": "Кирилл Иванов"
            },
            {
                "permissions": "Read Only",
                "user": "Елена Петрова"
            }
        ]
    });
    
    Параметр Описание Тип Наличие
    sharingSettings Определяет настройки, которые позволяют поделиться документом с другими пользователями. массив объекта необязательный
    sharingSettings.permissions Определяет права доступа для пользователя с указанным выше именем. строка необязательный
    sharingSettings.user Определяет имя пользователя, которому будет предоставлен доступ к документу. строка необязательный
  • setUsers - устанавить список пользователей, которых следует упомянуть в комментариях. Данный метод необходимо вызвать после событий onRequestUsers.

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

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

    Параметр Описание Тип Наличие
    users Определяет список пользователей. массив строк необязательный
    users.email Определяет адрес электронной почты пользователя. строка обязательный
    users.name Определяет полное имя пользователя. строка обязательный
  • showMessage - отобразить подсказку с сообщением. Данный метод может быть вызван только после событий onAppReady.

    docEditor.showMessage(message);
    
    Параметр Описание Тип Наличие
    message Определяет текст сообщения. строка обязательный