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

• denyEditingRights — запретить редактирование;
• destroyEditor —уничтожить объект docEditor;
• downloadAs — скачать отредактированный файл;
• insertImage — вставьте изображение в файл;
• refreshHistory — показать историю версий документа;
• requestClose — запрос на закрытие редактора;
• setActionLink — установить ссылку на документ, содержащий закладку;
• setFavorite — изменить состояние «Избранного» значка;
• setHistoryData — отправить ссылку на документ для просмотра истории версий;
• setMailMergeRecipients — вставить данные получателя для слияния в файл;
• setReferenceData — обновить данные по ссылке на файл, указанный в параметрах referenceData или path. Этот метод необходимо вызывать после события onRequestReferenceData;
• setRevisedFile — выбрать документ для сравнения;
• setSharingSettings — обновить информацию о настройках, позволяющих поделиться документом с другими пользователями;
• setUsers — установить список пользователей для упоминания в комментариях;
• showMessage — отображать всплывающую подсказку с сообщением.

Методы и их описание

var docEditor = new DocsAPI.DocEditor("placeholder", config);

denyEditingRights

Запретить редактирование. Данный метод может быть вызван, когда вы хотите сделать невозможным редактирование документа:

docEditor.denyEditingRights(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 — это имя, где установлены менеджер документов и сервис хранения документов. Перейдите в раздел Как это работает, чтобы узнать больше о взаимодействии службы Сервера документов с клиентским сервером.

До версии 7.0 этот метод позволял вставлять только одно изображение и имел следующие параметры:

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

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

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
        },
        ...
    ],
});

Если после редактирования и сохранения документа возвращается история с изменениями объекта и serverVersion, отправьте изменения объекта в разделе изменения и serverVersion в параметре serverVersion:

docEditor.refreshHistory({
    "currentVersion": 2,
    "history": [
        {
            "changes": changes,
            "created": "2010-07-06 10:13 AM",
            "key": "af86C7e71Ca8",
            "serverVersion": serverVersion,
            "user": {
                "id": "F89d8069ba2b",
                "name": "Kate Cage"
            },
            "version": 1
        },
        {
            "changes": changes,
            "created": "2010-07-07 3:46 PM",
            "key": "Khirz6zTPdfd7",
            "serverVersion": serverVersion,
            "user": {
                "id": "78e1e841",
                "name": "John Smith"
            },
            "version": 2
        },
        ...
    ],
});

Где:

• Изменения — это изменения из объекта истории, возвращенные после сохранения документа.
• ServerVersion — это serverVersion из объекта истории, возвращенного после сохранения документа.

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

requestClose

Запрос на закрытие редактора. Рекомендуется вызывать этот метод перед методом destroyEditor чтобы проверить, есть ли какие-то несохраненные данные в редакторе или нет. Если несохраненные данные существуют, то отобразится диалоговое окно с запросом пользователя, хочет ли он продолжить редактирование или закрыть редактор, потеряв все несохраненные данные. Если будет выбран вариант Закрытия, то будет вызвано событие onRequestClose:

docEditor.requestClose();

setActionLink

Устанавливает ссылку на документ, содержащий закладку. Данный метод необходимо вызвать после события onMakeActionLink. Чтобы установить ссылку, интегратор должен обработать ACTION_DATA, полученную от службы редактирования документов. Ссылка создана программными интеграторами, которые используют Р7 Document Server в своем менеджере документов:

docEditor.setActionLink(link);

setFavorite

Изменить состояние значка избранного. Этот метод нужно вызывать после события onMetaChange:

docEditor.setFavorite(favorite);

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
});

setMailMergeRecipients

Вставить данные получателя для слияния почты в файл. Данный метод необходимо вызвать после событий onRequestMailMergeRecipients:

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

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

setReferenceData

Обновить данные по ссылке на файл, указанный в параметрах referenceData или path. Этот метод необходимо вызывать после события onRequestReferenceData ↗.Обратите внимание, что этот метод выполняется только тогда, когда у пользователя есть права доступа к файлу, из которого берутся данные:

docEditor.setReferenceData({
    "fileType": "xlsx",
    "path": "sample.xlsx",
    "referenceData": {
        "fileKey": "BCFA2CED",
        "instanceId": "https://example.com"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6Inhsc3giLCJwYXRoIjoic2FtcGxlLnhsc3giLCJyZWZlcmVuY2VEYXRhIjp7ImZpbGVLZXkiOiJCQ0ZBMkNFRCIsImluc3RhbmNlSWQiOiJodHRwczovL2V4YW1wbGUuY29tIn0sInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQueGxzeCJ9.UXosmM-E_Cu9j9QGSlcj9FEoSu5m-zCS4b6FxO_2k7w",
    "url": "https://example.com/url-to-example-document.xlsx"
});

Где example.com — это имя сервера, на котором установлен менеджер документов и служба хранения документов.

Покажите сообщение об ошибке, объясняющее, произошла ли какая-либо ошибка:

docEditor.setReferenceData({
    "error": "Exception",
});

setRevisedFile

Выбрать документ для сравнения. Данный метод необходимо вызвать после событий onRequestCompareFile:

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

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

setSharingSettings

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

docEditor.setSharingSettings({
    "sharingSettings": [
        {
            "permissions": "Full Access",
            "user": "Кирилл Иванов"
        },
        {
            "permissions": "Read Only",
            "user": "Елена Петрова"
        }
    ]
});

setUsers

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

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

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

showMessage

Отобразить подсказку с сообщением. Данный метод может быть вызван только после событий onAppReady:

docEditor.showMessage(message);