Update: bringing the api in accordance with the Document server version 5.5
This commit is contained in:
parent
5d08842915
commit
35cdec1c37
@ -32,6 +32,7 @@
|
||||
<li><b>drop</b> - отключает пользователей с идентификаторами, указанными в параметре <em>users</em> от <b>сервиса редактирования документов</b> (эти пользователи смогут просматривать документ, но не смогут его редактировать);</li>
|
||||
<li><b>forcesave</b> - принудительное сохранение редактируемого документа без его закрытия (после выполнения этой команды редактирование документа может быть продолжено, так что эта версия сохранения документа не будет финальной);</li>
|
||||
<li><b>info</b> - получение статуса документа;</li>
|
||||
<li><b>meta</b> - обновляет метаинформацию документа для всех редакторов совместной работы;</li>
|
||||
<li><b>version</b> - получение текущего номера версии Сервера документов;</li>
|
||||
</ul>
|
||||
</td>
|
||||
@ -44,6 +45,24 @@
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="meta" class="copy-link">meta</td>
|
||||
<td>Определяет метаинформацию документа (используется для значения параметра <em>c=meta</em>).</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="meta-title" class="copy-link">meta.title</td>
|
||||
<td>Определяет название документа (используется для значения параметра <em>c=meta</em>).</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="token" class="copy-link">token</td>
|
||||
<td>Определяет зашифрованную подпись, добавленную в параметры Сервера документов в виде <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#config")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>в соответствии с конфигурацией</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="userdata" class="copy-link">userdata</td>
|
||||
<td>Определяет пользовательский идентификатор, который поможет различить запросы, если их было несколько.</td>
|
||||
@ -66,6 +85,15 @@
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"users": [ "6d5a81d0" ]
|
||||
}
|
||||
</pre>
|
||||
|
||||
<p>Результат запроса возвращается в JSON формате form.</p>
|
||||
<div class="header-gray">Пример результата запроса</div>
|
||||
<pre>
|
||||
{
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="forcesave" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для принудительного сохранения редактируемого документа с идентификатором <em>6d5a81d0</em> без его закрытия.</div>
|
||||
@ -75,6 +103,15 @@
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"userdata": "sample userdata"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<p>Результат запроса возвращается в JSON формате form.</p>
|
||||
<div class="header-gray">Пример результата запроса</div>
|
||||
<pre>
|
||||
{
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="info" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для получения статуса документа с идентификатором <em>Khirz6zTPdfd7</em>.</div>
|
||||
@ -92,6 +129,26 @@
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="meta-command" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для обновления названия документа с идентификатором <em>Khirz6zTPdfd7</em></div>
|
||||
<pre>
|
||||
{
|
||||
"c": "meta",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"meta": {
|
||||
"title": "Example Document Title.docx"
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
|
||||
<p>Результат запроса возвращается в JSON формате.</p>
|
||||
<div class="header-gray">Пример результата запроса</div>
|
||||
<pre>
|
||||
{
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="version" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для получения текущего номера версии Сервера документов.</div>
|
||||
@ -108,6 +165,13 @@
|
||||
"error": 0,
|
||||
"version": "1.0"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="info-token" class="header-gray copy-link">Пример JSON объекта содержит JSON токен, отправляемого <b>командному сервису документов</b> и используемого для получения статуса документа с идентификатором <em>Khirz6zTPdfd7</em>.</div>
|
||||
<pre>
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<p><b>Сервис редактирования документов</b> оповещает <b>сервис хранения документов</b> о результатах выполнения команд, используя <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx")%>">обработчик процедур обратного вызова</a>.</p>
|
||||
|
||||
@ -46,6 +46,12 @@
|
||||
<td>строка</td>
|
||||
<td>"Примеры файлов"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="owner" class="copy-link">владелец</td>
|
||||
<td>Определяет имя владельца/создателя документа.</td>
|
||||
<td>Строка</td>
|
||||
<td>"Наталья Иванова"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="sharingSettings" class="copy-link">sharingSettings</td>
|
||||
<td>Отображает информацию о настройках, которые позволяют делиться документом с другими пользователями;<ul>
|
||||
|
||||
@ -143,7 +143,55 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onOutdatedVersion" class="copy-link">onOutdatedVersion</b> - функция вызывается после того, как показано <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/troubleshooting.aspx#key")%>">сообщение об ошибке</a>, когда документ был открыт для редактирования со старым значением <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document.aspx#key")%>">document.key</a>, который использовался для редактирования предыдущей версии документа и был успешно сохранён. Когда возникает данное событие, редактор должен быть инициализирован заново с новым <em>document.key</em>.</p>
|
||||
<p>
|
||||
<b id="onMetaChange" class="copy-link">onMetaChange</b> - функция вызывается, когда метаинформация документа изменяется при помощи команды <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/command.aspx")%>">meta</a>.
|
||||
Имя документа отправляется в параметре <em>data.title</em>.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onMetaChange = function (event) {
|
||||
var title = event.data.title;
|
||||
...
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onMetaChange": onMetaChange,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onMakeActionLink" class="copy-link">onMakeActionLink</b> - функция вызывается, когда пользователь пытается получить ссылку для открытия документа, который содержит закладку с прокруткой до позиции закладки.
|
||||
Чтобы установить ссылку на закладку, вы должны вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setActionLink")%>">setActionLink</a>.
|
||||
Данные закладки возвращаются в параметре <em>data</em> и дальше должны быть использваны в настройке в качестве значения в параметре <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#actionLink")%>">editorConfig.actionLink</a>.
|
||||
</p>
|
||||
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onOutdatedVersion" class="copy-link">onOutdatedVersion</b> - функция вызывается после того, как показано сообщение об ошибке, когда документ был открыт для редактирования со старым значением <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document.aspx#key")%>">document.key</a>, который использовался для редактирования предыдущей версии документа и был успешно сохранён. Когда возникает данное событие, редактор должен быть инициализирован заново с новым <em>document.key</em>.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onOutdatedVersion = function () {
|
||||
@ -165,7 +213,7 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onRequestClose" class="copy-link">onRequestClose</b> - функция вызывается, когда работа с редактором должна быть завершена и он должен быть закрыт.</p>
|
||||
<p><b id="onRequestClose" class="copy-link">onRequestClose</b> - функция вызывается, когда работа с редактором должна быть завершена, и он должен быть закрыт.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestClose = function () {
|
||||
@ -186,6 +234,28 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onRequestCompareFile" class="copy-link">onRequestCompareFile</b> - функция вызывается, когда пользователь пытается выбрать документ для сравнения, нажав кнопку <em>Документ из Хранилища</em>. Чтобы выбрать документ для сравнения, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setRevisedFile")%>">setRevisedFile</a>.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onRequestEditRights" class="copy-link">onRequestEditRights</b> - функция вызывается, когда пользователь пытается переключить документ из режима просмотра в режим редактирования, нажимая кнопку <em>Редактировать документ</em>. Когда функция вызывается, редактор должен быть инициализирован заново в режиме редактирования. Если метод не объявлен, то кнопка <em>Редактировать</em> не будет отображена.</p>
|
||||
<div class="note">Параметр <b>onRequestEditRights</b> является обязательным, если параметр <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#mode")%>">editorConfig</a> <em>mode</em> установлен в значение <b>view</b> и параметр <em>permission</em> для <em>edit</em> установлен в значение <b>true</b>, чтобы редактировать документ (<a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document/permissions.aspx#edit")%>">разрешения документов</a>) и пользователь мог переключиться в режим редактирования.</div>
|
||||
@ -215,10 +285,10 @@ var onRequestHistory = function() {
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">объекта истории</a> возвращаются после сохранения документа
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history</a> объекта возвращаются после сохранения документа
|
||||
"created": "2010-07-06 10:13 AM",
|
||||
"key": "af86C7e71Ca8",
|
||||
"serverVersion": serverVersion, // <em>serverVersion</em> возвращается <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">объектом истории</a> после сохранения документа
|
||||
"serverVersion": serverVersion, // <em>serverVersion</em> возвращается <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history</a> объекта после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
@ -251,7 +321,7 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onRequestHistoryClose" class="copy-link">onRequestHistoryClose</b> - функция вызывается, когда пользователь пытается вернуться к документу из просмотра истории версий документа, нажимая кнопку <em>Назад к документу</em>. Когда функция вызывается, редактор должен быть инициализирован заново в режиме редактирования. Если метод не описан, то кнопка <em>Назад к документу</em> не будет отображена.</p>
|
||||
<p><b id="onRequestHistoryClose" class="copy-link">onRequestHistoryClose</b> - функция вызывается, когда пользователь пытается вернуться к документу из просмотра истории версий документа, нажимая кнопку <em>Закрыть историю</em>. Когда функция вызывается, редактор должен быть инициализирован заново в режиме редактирования. Если метод не описан, то кнопка <em>Назад к документу</em> не будет отображена.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestHistoryClose = function() {
|
||||
@ -275,7 +345,7 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
var onRequestHistoryData = function(event) {
|
||||
var version = event.data;
|
||||
docEditor.setHistoryData({
|
||||
"changesUrl": "https://example.com/url-to-changes.zip", // <em>changesUrl</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#changesurl")%>">объекта JSON</a>, возвращается после сохранения документа
|
||||
"changesUrl": "https://example.com/url-to-changes.zip", // <em>changesUrl</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#changesurl")%>">объекта JSON</a>, возвращащенный после сохранения документа
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"previous": {
|
||||
"key": "af86C7e71Ca8",
|
||||
@ -295,6 +365,231 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
});
|
||||
</pre>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestInsertImage" class="copy-link">onRequestInsertImage</b> - функция вызывается, когда пользователь пытается вставить изображение, нажав кнопку <em>Изображение из хранилища</em>.
|
||||
Чтобы вставить изображение в файл, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#insertImage")%>">insertImage</a>.
|
||||
</p>
|
||||
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.
|
||||
Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestMailMergeRecipients" class="copy-link">onRequestMailMergeRecipients</b> - функция вызывается, когда пользователь пытается выбрать данные получателей, нажав кнопку <em>Слияние</em>.
|
||||
Чтобы выбрать получателей, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setMailMergeRecipients")%>">setMailMergeRecipients</a>.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.
|
||||
Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestRestore" class="copy-link">onRequestRestore</b> - функция вызывается, когда пользователь пытается восстановить версию файла, нажав кнопку <em>Восстановить</em> в истории версий.
|
||||
При вызове функции, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#refreshHistory")%>">refreshHistory</a> для повторной инициализации истории версий.
|
||||
Номер версии документа отправляется в параметре <em>data.version</em> если он вызывается для версии документа из истории.
|
||||
Кроме того, ссылка на документ отправляется в параметре <em>data.url</em> если она вызывается при изменении документа из <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history объекта</a>.
|
||||
</p>
|
||||
<div class="note">
|
||||
Кнопка <em>Восстановить</em> отображается только для предыдущих версий документа и скрыта для текущей.
|
||||
</div>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestRestore = function(event) {
|
||||
var url = event.data.url;
|
||||
var version = event.data.version;
|
||||
...
|
||||
docEditor.refreshHistory({
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"changes": changes, // <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history объекта</a>, возвращенный после сохранения документа
|
||||
"created": "2010-07-06 10:13 AM",
|
||||
"key": "af86C7e71Ca8",
|
||||
"serverVersion": serverVersion, // <em>serverVersion</em> из <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history объекта</a> возвращенного после сохранения документа
|
||||
"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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.
|
||||
Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestSaveAs" class="copy-link">onRequestSaveAs</b> - функция вызывается, когла пользователь пытается сохранить файл при помощи кнопки <em>Сохранить копию как...</em>.
|
||||
Заголовок документа и абсолютный URL-адрес документа для загрузки отправляются в параметре <em>data</em>.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestSaveAs = function(event) {
|
||||
var title = event.data.title;
|
||||
var url = event.data.url;
|
||||
...
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestSaveAs": onRequestSaveAs,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestSendNotify" class="copy-link">onRequestSendNotify</b> - функция вызывается, когда пользователь упоминается в комментарии.
|
||||
Список упоминаемых пользователей необходимо заполнить методом <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setUsers")%>">setUsers</a>.
|
||||
Сообщение и список электронных ящиков отправляются в параметре <em>data</em>.
|
||||
Данные комментария принимаются в параметре <em>data.actionLink</em>, а затем должны использоваться в конфигурации в качестве значения для параметра <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#actionLink")%>">editorConfig.actionLink</a> parameter.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestSharingSettings" class="copy-link">onRequestSharingSettings</b> - функция вызывается, когда пользователь пытается изменить права доступа документа при помощи кнопки <em>Настройки прав доступа</em>.
|
||||
При изменении прав доступа, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setSharingSettings")%>">setSharingSettings</a>, чтобы обновить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document/info.aspx#sharingSettings")%>">информацию</a> о настройках, которые позволяют делиться документом с другими пользователями.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestSharingSettings = function() {
|
||||
docEditor.setSharingSettings({
|
||||
"sharingSettings": [
|
||||
{
|
||||
"permissions": "Full Access",
|
||||
"user": "Елена Иванова"
|
||||
},
|
||||
{
|
||||
"permissions": "Read Only",
|
||||
"user": "Иван Петров"
|
||||
}
|
||||
]
|
||||
});
|
||||
...
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestSharingSettings": onRequestSharingSettings,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="onRequestUsers" class="copy-link">onRequestUsers</b> - функция вызывается, когда комментирующий выбирает других пользователей для упоминания в комментариях.
|
||||
Чтобы вызвать список пользователей, необходимо вызвать метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setUsers")%>">setUsers</a>.
|
||||
</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
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,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onWarning" class="copy-link">onWarning</b> - функция вызывается, когда возникает предупреждение. Сообщение о предупреждении отправляется в параметре <em>data</em>.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
|
||||
@ -57,6 +57,61 @@ docEditor.downloadAs();
|
||||
</pre>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="insertImage" class="copy-link">insertImage</b> - Вставить изображение в файл.
|
||||
Этот метод может быть вызван после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestInsertImage")%>">onRequestInsertImage</a>.
|
||||
</p>
|
||||
<pre>
|
||||
docEditor.insertImage({
|
||||
"fileType": "png",
|
||||
"url": "https://example.com/url-to-example-image.png"
|
||||
});
|
||||
</pre>
|
||||
<p>
|
||||
Где <b>example.com</b> - это имя, где установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.
|
||||
Перейдите в раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о взаимодействии службы Сервера документов с клиентским сервером.
|
||||
</p>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>fileType</td>
|
||||
<td>Определяет тип изображения, который будет помещен в файл.
|
||||
Может быть: <em>bmp</em>, <em>gif</em>, <em>jpeg</em>, <em>jpg</em>, <em>png</em>
|
||||
</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>токен</td>
|
||||
<td>Определяет зашифрованную подпись, добавленную в параметры Сервера документов в виде <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#insertImage")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>url</td>
|
||||
<td>Определяет абсолютный URL-адрес, где находится изображение.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="refreshHistory" class="copy-link">refreshHistory</b> - показывает историю версий документа. Данный метод необходимо вызывать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistory")%>">onRequestHistory</a>.</p>
|
||||
<pre>
|
||||
@ -175,6 +230,41 @@ docEditor.refreshHistory({
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="setActionLink" class="copy-link">setActionLink</b> - устанавливает ссылку на документ, содержащий закладку.
|
||||
Данный метод необходимо вызвать после события <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onMakeActionLink")%>">onMakeActionLink</a>.
|
||||
Чтобы установить ссылку, интегратор должен обработать <em>ACTION_DATA</em>, полученную от <b>службы редактирования документов</b>.
|
||||
</p>
|
||||
<pre>
|
||||
docEditor.setActionLink(link);
|
||||
</pre>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>ссылка</td>
|
||||
<td>Определяет ссылку, позволяющую перейти к положению закладки в документе.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="setHistoryData" class="copy-link">setHistoryData</b> - отправляет ссылку на документ для просмотра истории версий. Данный метод необходимо вызывать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistoryData")%>">onRequestHistoryData</a>.</p>
|
||||
<pre>
|
||||
@ -261,7 +351,7 @@ docEditor.setHistoryData({
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="token">token</td>
|
||||
<td>token</td>
|
||||
<td>Определяет закодированную подпись, добавляемую к параметру в виде <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#setHistoryData")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
@ -282,6 +372,221 @@ docEditor.setHistoryData({
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="setMailMergeRecipients" class="copy-link">setMailMergeRecipients</b> - вставить данные получателя для слияния почты в файл.
|
||||
Данный метод необходимо вызвать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestMailMergeRecipients")%>">onRequestMailMergeRecipients</a>.
|
||||
</p>
|
||||
<pre>
|
||||
docEditor.setMailMergeRecipients({
|
||||
"fileType": "xlsx",
|
||||
"url": "https://example.com/url-to-example-recipients.xlsx"
|
||||
});
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>fileType</td>
|
||||
<td>Определяет тип электронной таблицы для слияния почты в файле.
|
||||
Может быть: xlsx.
|
||||
</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>token</td>
|
||||
<td>Определяет зашифрованную подпись, добавляемую к параметру в виде <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#insertImage")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>url</td>
|
||||
<td>Определяет абсолютный URL-адрес, по которому хранятся исходные данные.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="setRevisedFile" class="copy-link">setRevisedFile</b> - выбрать документ для сравнения. Данный метод необходимо вызвать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestCompareFile")%>">onRequestCompareFile</a>.</p>
|
||||
<pre>
|
||||
docEditor.setRevisedFile({
|
||||
"fileType": "docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
});
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>fileType</td>
|
||||
<td>Определяет тип изображения для вставки в файл.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>token</td>
|
||||
<td>Определяет зашифрованную подпись, добавляемую к параметру в виде <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#insertImage")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>url</td>
|
||||
<td>Определяет абсолютный URL-адрес, по которому хранится исходное изображение.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="setSharingSettings" class="copy-link">setSharingSettings</b> - Обновляет <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document/info.aspx#sharingSettings")%>">информацию</a> о настройках, которые позволяют делиться документом с другими пользователями.
|
||||
Данный метод необходимо вызвать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestSharingSettings")%>">onRequestSharingSettings</a>.
|
||||
</p>
|
||||
<pre>
|
||||
docEditor.setSharingSettings({
|
||||
"sharingSettings": [
|
||||
{
|
||||
"permissions": "Full Access",
|
||||
"user": "Кирилл Иванов"
|
||||
},
|
||||
{
|
||||
"permissions": "Read Only",
|
||||
"user": "Елена Петрова"
|
||||
}
|
||||
]
|
||||
});
|
||||
</pre>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>sharingSettings</td>
|
||||
<td>Определяет настройки, которые позволяют поделиться документом с другими пользователями.</td>
|
||||
<td>массив объекта</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>sharingSettings.permissions</td>
|
||||
<td>Определяет права доступа для пользователя с указанным выше именем.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>sharingSettings.user</td>
|
||||
<td>Определяет имя пользователя, которому будет предоставлен доступ к документу.</td>
|
||||
<td>строка</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p>
|
||||
<b id="setUsers" class="copy-link">setUsers</b> - устанавить список пользователей, которых следует упомянуть в комментариях.
|
||||
Данный метод необходимо вызвать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestUsers")%>">onRequestUsers</a>.
|
||||
</p>
|
||||
<pre>
|
||||
docEditor.setUsers({
|
||||
"users": [
|
||||
{
|
||||
"email": "john@example.com",
|
||||
"name": "John Smith"
|
||||
},
|
||||
{
|
||||
"email": "kate@example.com",
|
||||
"name": "Kate Cage"
|
||||
},
|
||||
...
|
||||
]
|
||||
});
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
<table class="table">
|
||||
<colgroup>
|
||||
<col style="width: 100px;" />
|
||||
<col />
|
||||
<col style="width: 100px;" />
|
||||
<col style="width: 150px;" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="tablerow">
|
||||
<td>Параметр</td>
|
||||
<td>Описание</td>
|
||||
<td>Тип</td>
|
||||
<td>Наличие</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="tablerow">
|
||||
<td>users</td>
|
||||
<td>Определяет список пользователей.</td>
|
||||
<td>массив строк</td>
|
||||
<td>необязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>users.email</td>
|
||||
<td>Определяет адрес электронной почты пользователя.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>users.name</td>
|
||||
<td>Определяет полное имя пользователя.</td>
|
||||
<td>строка</td>
|
||||
<td>обязательный</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="showMessage" class="copy-link">showMessage</b> - отобразить подсказку с сообщением. Данный метод может быть вызван только после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onAppReady")%>">onAppReady</a>.</p>
|
||||
<pre>
|
||||
|
||||
@ -9,7 +9,9 @@
|
||||
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Браузер</h1>
|
||||
<p class="dscr">Когда вы отправляете клиентские браузерные запросы на Сервер документов, необходимо добавить <em>токен</em> к параметрам, чтобы подтвердить данные.</p>
|
||||
|
||||
<p id="config">Когда файл <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/open.aspx")%>">открыт</a> для редактирования на Сервере документов, к конфигурации необходимо добавить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/.aspx#token")%>">токен</a>, чтобы подтвердить данные.</p>
|
||||
<h2 id="open" class="copy-link">Открытие файла</h2>
|
||||
|
||||
<p id="config">Когда файл <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/open.aspx")%>">открыт</a> для редактирования на Сервере документов, к конфигурации необходимо добавить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config.aspx#token")%>">токен</a>, чтобы подтвердить данные.</p>
|
||||
|
||||
<p><em>Данные</em> для JWT токена в формате JSON должны иметь такую же структуру, как и <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/advanced.aspx")%>">config</a>. Список параметров, которые должны быть включены, не является строго регламентированным, но мы рекомендуем вам указывать следующие параметры:</p>
|
||||
|
||||
@ -42,8 +44,34 @@
|
||||
<div class="header-gray">Пример токена</div>
|
||||
<pre>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2N1bWVudCI6eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwicGVybWlzc2lvbnMiOnsiZG93bmxvYWQiOnRydWUsImVkaXQiOnRydWUsInByaW50Ijp0cnVlLCJyZXZpZXciOnRydWV9LCJ0aXRsZSI6IkV4YW1wbGUgRG9jdW1lbnQgVGl0bGUuZG9jeCIsInVybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4In0sImVkaXRvckNvbmZpZyI6eyJjYWxsYmFja1VybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS91cmwtdG8tY2FsbGJhY2suYXNoeCIsIm1vZGUiOiJlZGl0IiwidXNlciI6eyJpZCI6Ijc4ZTFlODQxIiwibmFtZSI6IlNtaXRoIn19fQ.dQLHmsYqKoAG6vpcLngrIUkstAycpi8dFfP4lHPk0Uc</pre>
|
||||
|
||||
<h2 id="methods" class="copy-link">Методы</h2>
|
||||
|
||||
<p id="setHistoryData">Когда вы вызываете метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setHistoryData")%>">setHistoryData</a>, чтобы просмотреть <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/history.aspx")%>">историю</a> версий документа на Сервере документов, необходимо добавить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/.aspx#token")%>">токен</a> для проверки параметров.</p>
|
||||
<p id="insertImage" class="copy-link">При вызове метода <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#InsertImage")%>">insertImage</a> для вставки изображения в файл, необходимо добавить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config.aspx#token")%>">токен</a> для проверки параметров.</p>
|
||||
|
||||
<p>
|
||||
<em>Данные</em> для JWT токена в формате JSON должны иметь такую же структуру, как и параметр метода. Список параметров, которые должны быть включены, не является строго регламентированным, но мы рекомендуем вам указывать все отправляемые параметры:
|
||||
</p>
|
||||
|
||||
<pre>
|
||||
{
|
||||
"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"
|
||||
},
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": 2
|
||||
}
|
||||
</pre>
|
||||
<p>
|
||||
Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.
|
||||
</p>
|
||||
|
||||
<div class="header-gray">Пример токена</div>
|
||||
<pre>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxlVHlwZSI6InBuZyIsInVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtaW1hZ2UucG5nIn0.FXuC3GUvPq3japwyzo4i-utUe3g1rfSDt1ytuK_VyCc</pre>
|
||||
|
||||
<p id="setHistoryData">Когда вы вызываете метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setHistoryData")%>">setHistoryData</a>, чтобы просмотреть <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/history.aspx")%>">историю</a> версий документа на Сервере документов, необходимо добавить <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config.aspx#token")%>">токен</a> для проверки параметров.</p>
|
||||
|
||||
<p><em>Данные</em> для JWT токена в формате JSON должны иметь такую же структуру, как и параметр метода. Список параметров, которые должны быть включены, не является строго регламентированным, но мы рекомендуем вам указывать все отправляемые параметры:</p>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user