События – Линия клиентской поддержки Р7-Офис

Описание

Раздел событий позволяет изменять функционал, относящийся к событиям.

onAppReady - функция вызывается, когда приложение загружается в браузер.

Пример

var onAppReady = function() {
    console.log("Сервер документов готов к работе");
};

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

onCollaborativeChanges - функция вызывается, когда документ редактируется совместно с другим пользователем в строгом режиме совместного редактирования.

Пример

var onCollaborativeChanges = function () {
    console.log("Документ изменён одним из пользователей");
};

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

onDocumentReady - функция вызывается, когда документ загружается в редактор документов.

Пример

var onDocumentReady = function() {
    console.log("Документ загружен");
};

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

onDocumentStateChange - функция вызывается, когда документ редактируется. Эта функция вызывается с параметром: {"data": true} когда текущий пользователь редактирует документ и с параметром: {"data" : false} когда изменения, вносимые в документ текущим пользователем, отправляются сервису редактирования документов.

Пример
```
var onDocumentStateChange = function (event) {
    if (event.data) {
        console.log("Документ изменён");
    } else {
        console.log("Изменения собраны службой редактирования документов");
    }
};

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

onDownloadAs - функция вызывается с абсолютной ссылкой на редактируемый файл, когда вызывается метод downloadAs. Абсолютная ссылка на скачиваемый документ отправляется в параметре data.

Пример

var onDownloadAs = function (event) {
    console.log("Редактор документов создал файл: " + event.data);
};

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

onError - функция вызывается, когда возникает ошибка или иное событие. Сообщение об ошибке отправляется в параметре data.

Пример

var onError = function (event) {
    console.log("Редактор документов сообщает об ошибке: code " + event.data.errorCode + ", описание " + event.data.errorDescription);
};

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

onInfo - функция вызывается, когда приложение открывает файл. Режим отправляется в параметре data.mode. Может быть view или edit.

Пример

var onInfo = function (event) {
    console.log("Редактор документов открыт в режиме " + event.data.mode);
};

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

onMetaChange - функция вызывается, когда метаинформация документа изменяется при помощи команды meta. Имя документа отправляется в параметре data.title.

Пример

var onMetaChange = function (event) {
    var title = event.data.title;
    ...
};

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

onMakeActionLink - функция вызывается, когда пользователь пытается получить ссылку для открытия документа, который содержит закладку с прокруткой до позиции закладки. Чтобы установить ссылку на закладку, вы должны вызвать метод setActionLink. Данные закладки возвращаются в параметре data и дальше должны быть использваны в настройке в качестве значения в параметре editorConfig.actionLink.

Пример
```
var onMakeActionLink = function (event){
    var ACTION_DATA = event.data;
    ...
    var link = GENERATE_LINK(ACTION_DATA);
    docEditor.setActionLink(link);
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onMakeActionLink": onMakeActionLink,
        ...
    },
    ...
});
```
onOutdatedVersion - функция вызывается после того, как показано сообщение об ошибке, когда документ был открыт для редактирования со старым значением document.key, который использовался для редактирования предыдущей версии документа и был успешно сохранён. Когда возникает данное событие, редактор должен быть инициализирован заново с новым document.key.

Пример
```
var onOutdatedVersion = function () {
    location.reload(true);
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onOutdatedVersion": onOutdatedVersion,
        ...
    },
    ...
});
```
onReady - функция вызывается, когда приложение загружается в браузер. В текущей версии данный параметр не используется.

onRequestClose - функция вызывается, когда работа с редактором должна быть завершена, и он должен быть закрыт.

Пример

var onRequestClose = function () {
    if (window.opener) {
        window.close();
        return;
    }
    docEditor.destroyEditor();
};

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

onRequestCompareFile - функция вызывается, когда пользователь пытается выбрать документ для сравнения, нажав кнопку Документ из Хранилища. Чтобы выбрать документ для сравнения, необходимо вызвать метод setRevisedFile.

Пример
```
var onRequestCompareFile = function() {
    docEditor.setRevisedFile({
        "fileType": "docx",
        "url": "https://example.com/url-to-example-document.docx"
    });
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestCompareFile": onRequestCompareFile,
        ...
    },
    ...
});
```
Где example.com - имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
onRequestEditRights - функция вызывается, когда пользователь пытается переключить документ из режима просмотра в режим редактирования, нажимая кнопку Редактировать документ. Когда функция вызывается, редактор должен быть инициализирован заново в режиме редактирования. Если метод не объявлен, то кнопка Редактировать не будет отображена.

Параметр onRequestEditRights является обязательным, если параметр editorConfig mode установлен в значение view и параметр permission для edit установлен в значение true, чтобы редактировать документ (разрешения документов) и пользователь мог переключиться в режим редактирования.

Пример
```
var onRequestEditRights = function () {
    console.log("Редактор документов запрашивает права на редактирование");
    document.location.reload();
};

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

onRequestHistory - функция вызывается, когда пользователь пытается просмотреть историю версий документа, нажимая на кнопку История версий. Чтобы просмотреть историю версий документа, вам необходимо вызвать метод refreshHistory.

Пример

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

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

onRequestHistoryClose - функция вызывается, когда пользователь пытается вернуться к документу из просмотра истории версий документа, нажимая кнопку Закрыть историю. Когда функция вызывается, редактор должен быть инициализирован заново в режиме редактирования. Если метод не описан, то кнопка Назад к документу не будет отображена.

Пример
```
var onRequestHistoryClose = function() {
    document.location.reload();
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestHistoryClose": onRequestHistoryClose,
        ...
    },
    ...
});
```
onRequestHistoryData - функция вызывается, когда пользователь пытается перейти к конкретной версии документа при просмотре истории версий документа. Чтобы просмотреть изменения, относящиеся к конкретной версии документа, вам необходимо вызвать метод setHistoryData. Номер версии документа отправляется в параметре data.

Пример
```
var onRequestHistoryData = function(event) {
    var version = event.data;
    docEditor.setHistoryData({
        "changesUrl": "https://example.com/url-to-changes.zip", // changesUrl от объекта JSON, возвращащенный после сохранения документа
        "key": "Khirz6zTPdfd7",
        "previous": {
            "key": "af86C7e71Ca8",
            "url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
        },
        "url": "https://example.com/url-to-example-document.docx",
        "version": version
    })
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestHistoryData": onRequestHistoryData,
        ...
    },
    ...
});
```
Где example.com - имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
onRequestInsertImage - функция вызывается, когда пользователь пытается вставить изображение, нажав кнопку Изображение из хранилища. Чтобы вставить изображение в файл, необходимо вызвать метод insertImage.

Пример
```
var onRequestInsertImage = function() {
    docEditor.insertImage({
        "fileType": "png",
        "url": "https://example.com/url-to-example-image.png"
    });
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestInsertImage": onRequestInsertImage,
        ...
    },
    ...
});
```
Где example.com - имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
onRequestMailMergeRecipients - функция вызывается, когда пользователь пытается выбрать данные получателей, нажав кнопку Слияние. Чтобы выбрать получателей, необходимо вызвать метод setMailMergeRecipients.

Пример
```
var onRequestMailMergeRecipients = function() {
    docEditor.setMailMergeRecipients({
        "fileType": "xlsx",
        "url": "https://example.com/url-to-example-recipients.xlsx"
    });
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestMailMergeRecipients": onRequestMailMergeRecipients,
        ...
    },
    ...
});
```
Где example.com - имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.

onRequestRestore - функция вызывается, когда пользователь пытается восстановить версию файла, нажав кнопку Восстановить в истории версий. При вызове функции, необходимо вызвать метод refreshHistory для повторной инициализации истории версий. Номер версии документа отправляется в параметре data.version если он вызывается для версии документа из истории. Кроме того, ссылка на документ отправляется в параметре data.url если она вызывается при изменении документа из history объекта.

Кнопка Восстановить отображается только для предыдущих версий документа и скрыта для текущей.

Пример

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

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

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

onRequestSaveAs - функция вызывается, когла пользователь пытается сохранить файл при помощи кнопки Сохранить копию как.... Заголовок документа и абсолютный URL-адрес документа для загрузки отправляются в параметре data.

Пример
```
var onRequestSaveAs = function(event) {
    var title = event.data.title;
    var url = event.data.url;
    ...
};

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onRequestSaveAs": onRequestSaveAs,
        ...
    },
    ...
});
```
onRequestSendNotify - функция вызывается, когда пользователь упоминается в комментарии. Список упоминаемых пользователей необходимо заполнить методом setUsers. Сообщение и список электронных ящиков отправляются в параметре data. Данные комментария принимаются в параметре data.actionLink, а затем должны использоваться в конфигурации в качестве значения для параметра editorConfig.actionLink parameter.

Пример
```
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,
        ...
    },
    ...
});
```

onRequestSharingSettings - функция вызывается, когда пользователь пытается изменить права доступа документа при помощи кнопки Настройки прав доступа. При изменении прав доступа, необходимо вызвать метод setSharingSettings, чтобы обновить информацию о настройках, которые позволяют делиться документом с другими пользователями.

Пример

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

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

onRequestUsers - функция вызывается, когда комментирующий выбирает других пользователей для упоминания в комментариях. Чтобы вызвать список пользователей, необходимо вызвать метод setUsers.

Пример

var onRequestUsers = function() {
    docEditor.setUsers({
        "users": [
            {
                "email": "elena@example.com",
                "name": "Елена Иванова"
            },
            {
                "email": "ivan@example.com",
                "name": "Иван Петров"
            },
            ...
        ]
    });
};

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

onWarning - функция вызывается, когда возникает предупреждение. Сообщение о предупреждении отправляется в параметре data.

Пример

var onWarning = function (event) {
    console.log("Редактор документов сообщает о предупреждении: code " + event.data.warningCode + ", description " + event.data.warningDescription);
};

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

Похожие статьи