R7-Office: Updated translation into Russian
This commit is contained in:
alexandervnuchkov
parent
b9700c472b
commit
f495ec7c92
@ -3,115 +3,115 @@
|
||||
<entry>
|
||||
<key>System.Boolean</key>
|
||||
<value>
|
||||
<Description>Bool value</Description>
|
||||
<Description>логическое значение</Description>
|
||||
<Example>true</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.DateTime</key>
|
||||
<value>
|
||||
<Description>Date and Time</Description>
|
||||
<Description>дата и время</Description>
|
||||
<Example>2011-10-1</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.String</key>
|
||||
<value>
|
||||
<Description>string</Description>
|
||||
<Example>some text</Example>
|
||||
<Description>строка</Description>
|
||||
<Example>какой-либо текст</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Int32</key>
|
||||
<value>
|
||||
<Description>number</Description>
|
||||
<Description>число</Description>
|
||||
<Example>1234</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Single</key>
|
||||
<value>
|
||||
<Description>number</Description>
|
||||
<Description>число</Description>
|
||||
<Example>1234</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Int64</key>
|
||||
<value>
|
||||
<Description>number</Description>
|
||||
<Description>число</Description>
|
||||
<Example>1234</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Int64[]</key>
|
||||
<value>
|
||||
<Description>array of numbers</Description>
|
||||
<Description>массив чисел</Description>
|
||||
<Example>[1234,123]</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.String[]</key>
|
||||
<value>
|
||||
<Description>array of strings</Description>
|
||||
<Example>[some string,another string]</Example>
|
||||
<Description>массив строк</Description>
|
||||
<Example>[одна строка,другая строка]</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Float</key>
|
||||
<value>
|
||||
<Description>floating point number</Description>
|
||||
<Example>123.45</Example>
|
||||
<Description>число с плавающей запятой</Description>
|
||||
<Example>123,45</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Guid</key>
|
||||
<value>
|
||||
<Description>guid</Description>
|
||||
<Description>GUID</Description>
|
||||
<Example>9924256A-739C-462b-AF15-E652A3B1B6EB</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Projects.Core.Domain.TaskPriority</key>
|
||||
<value>
|
||||
<Description>task priority</Description>
|
||||
<Description>приоритет задачи</Description>
|
||||
<Example>High = 1, Normal = 0, Low = -1</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Projects.Core.Domain.TaskStatus</key>
|
||||
<value>
|
||||
<Description>task status</Description>
|
||||
<Description>статус задачи</Description>
|
||||
<Example>NotAccept = 0,Open = 1, Closed = 2,Disable = 3,Unclassified = 4,NotInMilestone = 5</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Projects.Core.Domain.ProjectStatus</key>
|
||||
<value>
|
||||
<Description>project status</Description>
|
||||
<Description>статус проекта</Description>
|
||||
<Example>Open = 0, Closed = 1</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Projects.Core.Domain.MilestoneStatus</key>
|
||||
<value>
|
||||
<Description>milestone status</Description>
|
||||
<Description>статус этапа</Description>
|
||||
<Example>Open = 0, Closed = 1, Late = 2, Disable = 3</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Forum.TopicType</key>
|
||||
<value>
|
||||
<Description>topic type</Description>
|
||||
<Description>тип темы</Description>
|
||||
<Example>Informational=0,Poll=1</Example>
|
||||
<Note>What is this?</Note>
|
||||
<Note>Что это?</Note>
|
||||
</value>
|
||||
</entry>
|
||||
|
||||
<entry>
|
||||
<key>System.IO.Stream</key>
|
||||
<value>
|
||||
<Description>A stream for uploading files without multipart request</Description>
|
||||
<Example>N/A</Example>
|
||||
<Description>Поток для загрузки файлов на сервер без составного запроса</Description>
|
||||
<Example>Нет сведений</Example>
|
||||
<Note></Note>
|
||||
</value>
|
||||
</entry>
|
||||
@ -119,53 +119,53 @@
|
||||
<entry>
|
||||
<key>System.Net.Mime.ContentType</key>
|
||||
<value>
|
||||
<Description>A content type for stream when uploading files without multipart request</Description>
|
||||
<Description>Тип контента для потока при загрузке файлов на сервер без составного запроса</Description>
|
||||
<Example>application/octet-stream</Example>
|
||||
<Note>Set Content-Type header</Note>
|
||||
<Note>Задать заголовок Content-Type</Note>
|
||||
</value>
|
||||
</entry>
|
||||
|
||||
<entry>
|
||||
<key>System.Net.Mime.ContentDisposition</key>
|
||||
<value>
|
||||
<Description>A Content Disposition with file name for stream when uploading files without multipart request</Description>
|
||||
<Example>attachment; filename="file1.png"</Example>
|
||||
<Note>Set Content-Disposition header</Note>
|
||||
<Description>Расположение контента с именем файла для потока при загрузке файлов на сервер без составного запроса</Description>
|
||||
<Example>attachment; filename="file1.png"</Example>
|
||||
<Note>Задать заголовок Content-Disposition</Note>
|
||||
</value>
|
||||
</entry>
|
||||
|
||||
<entry>
|
||||
<key>System.Collections.Generic.IEnumerable`1[System.Web.HttpPostedFileBase]</key>
|
||||
<value>
|
||||
<Description>Files for adding using multipart/form-data</Description>
|
||||
<Example>N/A</Example>
|
||||
<Description>Файлы, добавляемые с помощью multipart/form-data</Description>
|
||||
<Example>Нет сведений</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Api.Employee.Contact</key>
|
||||
<value>
|
||||
<Description>Contact</Description>
|
||||
<Description>Контакт</Description>
|
||||
<Example>contacts[0][Type]=GTalk&contacts[0][Value]=my@gmail.com</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Guid[]</key>
|
||||
<value>
|
||||
<Description>Collection of Guids</Description>
|
||||
<Description>Коллекция GUID</Description>
|
||||
<Example></Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>ASC.Specific.ApiDateTime</key>
|
||||
<value>
|
||||
<Description>Date and Time</Description>
|
||||
<Example>Roundtrip format: 2008-04-10T06-30-00.000Z</Example>
|
||||
<Description>Дата и время</Description>
|
||||
<Example>Формат с часовым поясом: 2008-04-10T06-30-00.000Z</Example>
|
||||
</value>
|
||||
</entry>
|
||||
<entry>
|
||||
<key>System.Collections.Generic.List`1[ASC.Api.Calendar.CalendarApi+SharingParam]</key>
|
||||
<value>
|
||||
<Description>list of sharing options</Description>
|
||||
<Description>список опций общего доступа</Description>
|
||||
<Example></Example>
|
||||
</value>
|
||||
</entry>
|
||||
@ -179,7 +179,7 @@
|
||||
<entry>
|
||||
<key>ASC.Web.Studio.Core.Backup.BackupAjaxHandler+StorageParams</key>
|
||||
<value>
|
||||
<Description>Object with fields: AccessKeyId, SecretAccessKey, Bucket, FolderId, FilePath, Region</Description>
|
||||
<Description>Объект с полями: AccessKeyId, SecretAccessKey, Bucket, FolderId, FilePath, Region</Description>
|
||||
<Example></Example>
|
||||
</value>
|
||||
</entry>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Calendar</name>
|
||||
@ -17,739 +17,428 @@
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.#ctor(ASC.Api.Impl.ApiContext)">
|
||||
<summary>
|
||||
Constructor
|
||||
</summary>
|
||||
<summary>Constructor</summary>
|
||||
<param name="context"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventDays(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
|
||||
<summary>
|
||||
Returns the list of all dates which contain the events from the displayed calendars
|
||||
</summary>
|
||||
<short>
|
||||
Calendar events
|
||||
</short>
|
||||
<param name="startDate">Period start date</param>
|
||||
<param name="endDate">Period end date</param>
|
||||
<returns>Date list</returns>
|
||||
<summary>Возвращает список всех дат, содержащих события из показанных календарей</summary>
|
||||
<short>События календаря</short>
|
||||
<param name="startDate">Начальная дата периода</param>
|
||||
<param name="endDate">Конечная дата периода</param>
|
||||
<returns>Список дат</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.LoadCalendars(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
|
||||
<summary>
|
||||
Returns the list of calendars and subscriptions with the events for the current user for the selected period
|
||||
</summary>
|
||||
<short>
|
||||
Calendars and subscriptions
|
||||
</short>
|
||||
<param name="startDate">Period start date</param>
|
||||
<param name="endDate">Period end date</param>
|
||||
<returns>List of calendars and subscriptions with events</returns>
|
||||
<summary>Возвращает список календарей и подписок с событиями текущего пользователя за выбранный период</summary>
|
||||
<short>Календари и подписки</short>
|
||||
<param name="startDate">Начальная дата периода</param>
|
||||
<param name="endDate">Конечная дата периода</param>
|
||||
<returns>Список календарей и подписок с событиями</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.LoadSubscriptions">
|
||||
<summary>
|
||||
Returns the list of all subscriptions available to the user
|
||||
</summary>
|
||||
<short>
|
||||
Subscription list
|
||||
</short>
|
||||
<returns>List of subscriptions</returns>
|
||||
<summary>Возвращает список всех подписок, доступных для пользователя</summary>
|
||||
<short>Список подписок</short>
|
||||
<returns>Перечень подписок </returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ManageSubscriptions(System.Collections.Generic.IEnumerable{ASC.Api.Calendar.CalendarApi.SubscriptionState})">
|
||||
<summary>
|
||||
Updates the subscription state either subscribing or unsubscribing the user to/from it
|
||||
</summary>
|
||||
<short>
|
||||
Update subscription
|
||||
</short>
|
||||
<param name="states">Updated subscription states</param>
|
||||
<summary>Обновляет статус подписки (пользователь оформил подписку или отказался от нее)</summary>
|
||||
<short>Обновить подписку</short>
|
||||
<param name="states">Обновленные статусы подписки</param>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarById(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Calendar by ID
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>Calendar</returns>
|
||||
<summary>Возвращает подробные сведения о календаре с ИД, указанным в запросе</summary>
|
||||
<short>Календарь по ИД</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<returns>Календарь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.CreateCalendar(System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String,System.Int32)">
|
||||
<summary>
|
||||
Creates the new calendar with the parameters (name, description, color, etc.) specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create calendar
|
||||
</short>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="description">Calendar description</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<param name="timeZone">Calendar time zone</param>
|
||||
<param name="alertType">Event alert type, in case alert type is set by default</param>
|
||||
<param name="sharingOptions">Calendar sharing options with other users</param>
|
||||
<param name="iCalUrl">iCal url</param>
|
||||
<param name="isTodo">Calendar for todo list</param>
|
||||
<returns>Created calendar</returns>
|
||||
<summary>Создает новый календарь с указанными в запросе параметрами (название, описание, цвет и т. д.)</summary>
|
||||
<short>Создать календарь</short>
|
||||
<param name="name">Название календаря</param>
|
||||
<param name="description">Описание календаря</param>
|
||||
<param name="textColor">Цвет текста события</param>
|
||||
<param name="backgroundColor">Цвет фона события</param>
|
||||
<param name="timeZone">Часовой пояс календаря</param>
|
||||
<param name="alertType">Тип оповещения о событии, если он назначается по умолчанию</param>
|
||||
<param name="sharingOptions">Опции совместного доступа к календарю с другими пользователями</param>
|
||||
<param name="iCalUrl">Адрес iCal</param>
|
||||
<param name="isTodo">Календарь для списка задач</param>
|
||||
<returns>Созданный календарь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateCalendar(System.String,System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String)">
|
||||
<summary>
|
||||
Updates the selected calendar with the parameters (name, description, color, etc.) specified in the request for the current user and access rights for other users
|
||||
</summary>
|
||||
<short>
|
||||
Update calendar
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="name">Calendar new name</param>
|
||||
<param name="description">Calendar new description</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<param name="timeZone">Calendar time zone</param>
|
||||
<param name="alertType">Event alert type, in case alert type is set by default</param>
|
||||
<param name="hideEvents">Display type: show or hide events in calendar</param>
|
||||
<param name="sharingOptions">Calendar sharing options with other users</param>
|
||||
<param name="iCalUrl">iCal url</param>
|
||||
<returns>Updated calendar</returns>
|
||||
<summary>Обновляет выбранный календарь на основе параметров (название, описание, цвет и т. д.), указанных в запросе текущего пользователя и правах доступа других пользователей </summary>
|
||||
<short>Обновить календарь</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<param name="name">Новое название календаря</param>
|
||||
<param name="description">Новое описание календаря</param>
|
||||
<param name="textColor">Цвет текста события</param>
|
||||
<param name="backgroundColor">Цвет фона события</param>
|
||||
<param name="timeZone">Часовой пояс календаря</param>
|
||||
<param name="alertType">Тип оповещения о событии, если он назначается по умолчанию</param>
|
||||
<param name="hideEvents">Тип отображения: показывать или скрывать события в календаре</param>
|
||||
<param name="sharingOptions">Опции совместного доступа к календарю с другими пользователями</param>
|
||||
<param name="iCalUrl">Адрес iCal</param>
|
||||
<returns>Обновленный календарь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateCalendarView(System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean)">
|
||||
<summary>
|
||||
Change the calendar display parameters specified in the request for the current user
|
||||
</summary>
|
||||
<short>
|
||||
Update calendar user view
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<param name="timeZone">Calendar time zone</param>
|
||||
<param name="alertType">Event alert type, in case alert type is set by default</param>
|
||||
<param name="hideEvents">Display type: show or hide events in calendar</param>
|
||||
<returns>Updated calendar</returns>
|
||||
<summary>Изменить параметры отображения календаря, указанные в запросе текущего пользователя</summary>
|
||||
<short>Обновить пользовательский вид календаря</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<param name="name">Название календаря</param>
|
||||
<param name="textColor">Цвет текста события</param>
|
||||
<param name="backgroundColor">Цвет фона события</param>
|
||||
<param name="timeZone">Часовой пояс календаря</param>
|
||||
<param name="alertType">Тип оповещения о событии, если он назначается по умолчанию</param>
|
||||
<param name="hideEvents">Тип отображения: показывать или скрывать события в календаре</param>
|
||||
<returns>Обновленный календарь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveCalendar(System.Int32)">
|
||||
<summary>
|
||||
Deletes the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Delete calendar
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<summary>Удаляет календарь с ИД, указанным в запросе</summary>
|
||||
<short>Удалить календарь</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendariCalUrl(System.String)">
|
||||
<summary>
|
||||
Returns the link for the iCal associated with the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Get iCal link
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>iCal link</returns>
|
||||
<summary>Возвращает ссылку на iCal, связанный с календарем, ИД которого указан в запросе</summary>
|
||||
<short>Получить ссылку на iCal</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<returns>Ссылка на iCal</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarCalDavUrl(System.String)">
|
||||
<summary>
|
||||
Returns the link for the CalDav associated with the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Get CalDav link
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>CalDav link</returns>
|
||||
<summary>Возвращает ссылку на CalDAV, связанный с календарем, ИД которого указан в запросе</summary>
|
||||
<short>Получить ссылку на CalDAV</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<returns>Ссылка на CalDAV</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ChangeOfCalendarStorage(System.String,System.String)">
|
||||
<summary>
|
||||
Run caldav event update function
|
||||
</summary>
|
||||
<short>
|
||||
Update CalDav Event
|
||||
</short>
|
||||
<param name="change">changes of event</param>
|
||||
<summary>Выполнить функцию обновления события CalDAV</summary>
|
||||
<short>Обновить событие CalDAV</short>
|
||||
<param name="change">изменения события</param>
|
||||
<param name="key"></param>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.CaldavDeleteEvent(System.String,System.String)">
|
||||
<summary>
|
||||
Run caldav event delete function
|
||||
</summary>
|
||||
<short>
|
||||
Delete CalDav Event
|
||||
</short>
|
||||
<param name="eventInfo">event info</param>
|
||||
<summary>Выполнить функцию удаления события CalDAV</summary>
|
||||
<short>Удалить событие CalDAV</short>
|
||||
<param name="eventInfo">сведения о событии</param>
|
||||
<param name="key"></param>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendariCalStream(System.String,System.String)">
|
||||
<summary>
|
||||
Returns the feed for the iCal associated with the calendar by its ID and signagure specified in the request
|
||||
</summary>
|
||||
<short>Get iCal feed</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="signature">Signature</param>
|
||||
<remarks>To get the feed you need to use the method returning the iCal feed link (it will generate the necessary signature)</remarks>
|
||||
<returns>Calendar iCal feed</returns>
|
||||
<summary>Возвращает веб-канал iCal, связанного с календарем за счет ИД и подписи, которые указаны в запросе</summary>
|
||||
<short>Получить веб-канал iCal</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<param name="signature">Подпись</param>
|
||||
<remarks>Чтобы получить веб-канал, нужно воспользоваться методом, возвращающим ссылку на веб-канал iCal (и генерирующим необходимую подпись)</remarks>
|
||||
<returns>Веб-канал календаря iCal</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<summary>
|
||||
Imports the events from the iCal files
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="files">iCal formatted files with the events to be imported</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
<summary>Импортирует события из файлов iCal</summary>
|
||||
<short>Импорт iCal</short>
|
||||
<param name="files">Файлы в формате iCal с импортируемыми событиями</param>
|
||||
<returns>Возвращает количество импортированных событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Int32,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<summary>
|
||||
Imports the events from the iCal files to the existing calendar
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="calendarId">ID for the calendar which serves as the future storage base for the imported events</param>
|
||||
<param name="files">iCal formatted files with the events to be imported</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
<summary>Импортирует события из файлов iCal в существующий календарь</summary>
|
||||
<short>Импорт iCal</short>
|
||||
<param name="calendarId">ИД календаря, где будут храниться импортированные события</param>
|
||||
<param name="files">Файлы в формате iCal с импортируемыми событиями</param>
|
||||
<returns>Возвращает количество импортированных событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Int32,System.String)">
|
||||
<summary>
|
||||
Imports the events from the iCal files
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="iCalString">iCal formatted string</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
<summary>Импортирует события из файлов iCal</summary>
|
||||
<short>Импорт iCal</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<param name="iCalString">Строка в формате iCal</param>
|
||||
<returns>Возвращает количество импортированных событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.CreateCalendarStream(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Creates a calendar by the link to the external iCal feed
|
||||
</summary>
|
||||
<short>
|
||||
Create calendar
|
||||
</short>
|
||||
<param name="iCalUrl">Link to the external iCal feed</param>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="textColor">Event text name</param>
|
||||
<param name="backgroundColor">Event background name</param>
|
||||
<returns>Created calendar</returns>
|
||||
<summary>Создает календарь с помощью ссылки на внешний веб-канал iCal</summary>
|
||||
<short>Создать календарь</short>
|
||||
<param name="iCalUrl">Ссылка на внешний календарь iCal</param>
|
||||
<param name="name">Название календаря</param>
|
||||
<param name="textColor">Название текста события</param>
|
||||
<param name="backgroundColor">Название фона события</param>
|
||||
<returns>Созданный календарь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
|
||||
<summary>
|
||||
Creates the new event in the default calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="name">Event name</param>
|
||||
<param name="description">Event description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<returns>Event list</returns>
|
||||
<summary>Создает новое событие в календаре по умолчанию с указанными в запросе параметрами </summary>
|
||||
<short>Создать событие</short>
|
||||
<param name="name">Название события</param>
|
||||
<param name="description">Описание события</param>
|
||||
<param name="startDate">Начальная дата события</param>
|
||||
<param name="endDate">Конечная дата события</param>
|
||||
<param name="repeatType">Тип повторения события (строка RRULE в формате iCal)</param>
|
||||
<param name="alertType">Тип уведомления о событии</param>
|
||||
<param name="isAllDayLong">Тип длительности события: на весь день или нет</param>
|
||||
<param name="sharingOptions">Параметры общего доступа к событию</param>
|
||||
<returns>Список событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.Int32,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
|
||||
<summary>
|
||||
Creates the new event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event is created</param>
|
||||
<param name="name">Event name</param>
|
||||
<param name="description">Event description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<returns>Event list</returns>
|
||||
<summary>Создает новое событие в выбранном календаре с указанными в запросе параметрами</summary>
|
||||
<short>Создать событие</short>
|
||||
<param name="calendarId">ИД календаря, где создается событие</param>
|
||||
<param name="name">Название события</param>
|
||||
<param name="description">Описание события</param>
|
||||
<param name="startDate">Начальная дата события</param>
|
||||
<param name="endDate">Конечная дата события</param>
|
||||
<param name="repeatType">Тип повторения события (строка RRULE в формате iCal)</param>
|
||||
<param name="alertType">Тип уведомления о событии</param>
|
||||
<param name="isAllDayLong">Тип длительности события: на весь день или нет</param>
|
||||
<param name="sharingOptions">Параметры общего доступа к событию</param>
|
||||
<returns>Список событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.Update(System.String,System.Int32,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},ASC.Web.Core.Calendars.EventStatus)">
|
||||
<summary>
|
||||
Updates the existing event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event belongs</param>
|
||||
<param name="eventId">Event ID</param>
|
||||
<param name="name">Event new name</param>
|
||||
<param name="description">Event new description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<param name="status">Event status</param>
|
||||
<returns>Updated event list</returns>
|
||||
<summary>Обновляет существующее событие в выбранном календаре с указанными в запросе параметрами</summary>
|
||||
<short>Обновить событие</short>
|
||||
<param name="calendarId">ИД календаря, где отмечено событие</param>
|
||||
<param name="eventId">ИД события</param>
|
||||
<param name="name">Новое название события</param>
|
||||
<param name="description">Новое описание события</param>
|
||||
<param name="startDate">Начальная дата события</param>
|
||||
<param name="endDate">Конечная дата события</param>
|
||||
<param name="repeatType">Тип повторения события (строка RRULE в формате iCal)</param>
|
||||
<param name="alertType">Тип уведомления о событии</param>
|
||||
<param name="isAllDayLong">Тип длительности события: на весь день или нет</param>
|
||||
<param name="sharingOptions">Параметры общего доступа к событию</param>
|
||||
<param name="status">Статус события</param>
|
||||
<returns>Обновленный список событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddTodo(System.String,System.String)">
|
||||
<summary>
|
||||
Creates the new task in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="ics">Task in iCal format</param>
|
||||
<param name="todoUid">Task uid</param>
|
||||
<returns>Todo</returns>
|
||||
<summary>Создает новую задачу в выбранном календаре с указанными в запросе параметрами</summary>
|
||||
<short>Создать событие</short>
|
||||
<param name="ics">Задача в формате iCal</param>
|
||||
<param name="todoUid">ИД пользователя задачи</param>
|
||||
<returns>Задача</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveTodo(System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Deletes task
|
||||
</summary>
|
||||
<short>
|
||||
Delete task
|
||||
</short>
|
||||
<param name="todoId">Task ID</param>
|
||||
<param name="fromCaldavServer">Bool flag says that request from caldav server</param>
|
||||
<summary>Удаляет задачу</summary>
|
||||
<short>Удалить задачу</short>
|
||||
<param name="todoId">ИД задачи</param>
|
||||
<param name="fromCaldavServer">Булев флаг, означающий, что запрос отправлен с сервера CalDAV</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.Int32,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String)">
|
||||
<summary>
|
||||
Creates the new event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event is created</param>
|
||||
<param name="ics">Event in iCal format</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<param name="eventUid">Event uid</param>
|
||||
<returns>Event</returns>
|
||||
<summary>Создает новое событие в выбранном календаре с указанными в запросе параметрами</summary>
|
||||
<short>Создать событие</short>
|
||||
<param name="calendarId">ИД календаря, где создается событие</param>
|
||||
<param name="ics">Событие в формате iCal</param>
|
||||
<param name="alertType">Тип уведомления о событии</param>
|
||||
<param name="sharingOptions">Параметры общего доступа к событию</param>
|
||||
<param name="eventUid">ИД пользователя события</param>
|
||||
<returns>Событие</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateEvent(System.Int32,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.Boolean,System.String)">
|
||||
<summary>
|
||||
Updates the existing event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update event
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<param name="calendarId">ID of the calendar where the event belongs</param>
|
||||
<param name="ics">Event in iCal format</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<param name="fromCalDavServer">bool flag says that request from caldav server</param>
|
||||
<param name="ownerId">Event owner id</param>
|
||||
<returns>Updated event</returns>
|
||||
<summary>Обновляет существующее событие в выбранном календаре с указанными в запросе параметрами</summary>
|
||||
<short>Обновить событие</short>
|
||||
<param name="eventId">ИД события</param>
|
||||
<param name="calendarId">ИД календаря, где отмечено событие</param>
|
||||
<param name="ics">Событие в формате iCal</param>
|
||||
<param name="alertType">Тип уведомления о событии</param>
|
||||
<param name="sharingOptions">Параметры общего доступа к событию</param>
|
||||
<param name="fromCalDavServer">Булев флаг, означающий, что запрос отправлен с сервера CalDAV</param>
|
||||
<param name="ownerId">ИД организатора события</param>
|
||||
<returns>Обновленное событие</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32)">
|
||||
<summary>
|
||||
Deletes the whole event from the calendar (all events in the series)
|
||||
</summary>
|
||||
<short>
|
||||
Delete event series
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<summary>Целиком удаляет событие из календаря (все события в серии)</summary>
|
||||
<short>Удалить серию событий</short>
|
||||
<param name="eventId">ИД события</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32,ASC.Specific.ApiDateTime,ASC.Api.Calendar.CalendarApi.EventRemoveType,System.Boolean)">
|
||||
<summary>
|
||||
Deletes one event from the series of recurrent events
|
||||
</summary>
|
||||
<short>
|
||||
Delete event
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<param name="date">Date to be deleted from the recurrent event</param>
|
||||
<param name="type">Recurrent event deletion type</param>
|
||||
<param name="fromCaldavServer">Bool flag says that request from caldav server</param>
|
||||
<returns>Updated event series collection</returns>
|
||||
<summary>Удаляет одно событие из серии повторяющихся событий</summary>
|
||||
<short>Удалить событие</short>
|
||||
<param name="eventId">ИД события</param>
|
||||
<param name="date">Дата, удаляемая из повторяющегося события</param>
|
||||
<param name="type">Тип удаления повторяющегося события</param>
|
||||
<param name="fromCaldavServer">Булев флаг, означающий, что запрос отправлен с сервера CalDAV</param>
|
||||
<returns>Обновленная коллекция серии событий</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.UnsubscribeEvent(System.Int32)">
|
||||
<summary>
|
||||
Unsubscribes the current user from the event with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Unsubscribe from event
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<summary>Отменяет подписку текущего пользователя на событие с ИД, указанным в запросе</summary>
|
||||
<short>Отписаться от события</short>
|
||||
<param name="eventId">ИД события</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventHistoryByUid(System.String)">
|
||||
<summary>
|
||||
Returns the event in ics format from history
|
||||
</summary>
|
||||
<short>
|
||||
Returns the event in ics format from history
|
||||
</short>
|
||||
<param name="eventUid">Event UID</param>
|
||||
<returns>Event History</returns>
|
||||
<summary>Возвращает событие из истории в формате ICS</summary>
|
||||
<short>Возвращает событие из истории в формате ICS</short>
|
||||
<param name="eventUid">ИД пользователя события</param>
|
||||
<returns>История события</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventHistoryById(System.Int32)">
|
||||
<summary>
|
||||
Returns the event in ics format from history
|
||||
</summary>
|
||||
<short>
|
||||
Returns the event in ics format from history
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<returns>Event History</returns>
|
||||
<summary>Возвращает событие из истории в формате ICS</summary>
|
||||
<short>Возвращает событие из истории в формате ICS</short>
|
||||
<param name="eventId">ИД события</param>
|
||||
<returns>История события</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarSharingOptions(System.Int32)">
|
||||
<summary>
|
||||
Returns the sharing access parameters to the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Get access parameters
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>Sharing access parameters</returns>
|
||||
<summary>Возвращает параметры общего доступа к календарю с ИД, указанным в запросе</summary>
|
||||
<short>Получить параметры общего доступа</short>
|
||||
<param name="calendarId">ИД календаря</param>
|
||||
<returns>Параметры общего доступа</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetDefaultSharingOptions">
|
||||
<summary>
|
||||
Returns the default values for the sharing access parameters
|
||||
</summary>
|
||||
<short>
|
||||
Get default access
|
||||
</short>
|
||||
<returns>Default sharing access parameters</returns>
|
||||
<summary>Возвращает значения по умолчанию для параметров общего доступа</summary>
|
||||
<short>Получить значения доступа по умолчанию</short>
|
||||
<returns>Параметры общего доступа по умолчанию</returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.IEmitter">
|
||||
<summary>
|
||||
Defines all of the basic operations that must be implemented by parser emitters.
|
||||
</summary>
|
||||
<summary>Определяет все базовые операции, которые должны быть выполнены генераторами синтаксического анализатора.</summary>
|
||||
<remarks>
|
||||
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Parser">
|
||||
<summary>
|
||||
Parse iCalendar rfc2445 streams and convert to another format based on the emitter used.
|
||||
</summary>
|
||||
<summary>Проанализировать потоки rfc2445 iCalendar и преобразовать их в другой формат исходя из используемого генератора.</summary>
|
||||
|
||||
<remarks>
|
||||
This class is the main entry point for the ICalParser library. A parser is created
|
||||
with a TextReader that contains the iCalendar stream to be parsed, and an IEmitter, which
|
||||
is used to transform the iCalendar into another format.
|
||||
<remarks>Этот класс является основной точкой входа для библиотеки ICalParser. Синтаксический анализатор создается с параметром TextReader, содержащим анализируемый поток iCalendar, и параметром IEmitter, применяемым для перевода iCalendar в другой формат. Любой файл в формате iCalendar имеет следующий формат: ID[[;attr1;attr2;attr3;...;attrn]:value], где ID (идентификатор) — это основное ключевое слово, определяющее запись iCalendar, вслед за которым указывается необязательный набор атрибутов и единичное значение. Синтаксический анализатор во время работы идентифицирует определенные идентификаторы, атрибуты и значения, относит их к различным категориям исходя из похожего "поведения" (определенного в классе <code>Token</code>) и передает распознанные символы генератору для дальнейшей обработки. Политика восстановления синтаксического анализатора после ошибок довольно проста. В случае обнаружения ошибки она записывается, выполняется считывание оставшейся строки (возможно, с переносом), и синтаксический анализ продолжается. </remarks>
|
||||
|
||||
Each iCalendar format file is in the form:
|
||||
|
||||
ID[[;attr1;attr2;attr3;...;attrn]:value]
|
||||
|
||||
where ID is the main keyword identifying the iCalendar entry, followed optionally by a
|
||||
set of attributes and a single value. The parser works by identifying the specific IDs,
|
||||
attributes and values, categorizing them based on similar 'behaviour' (as defined in the <code>Token</code>
|
||||
class) and passing on recognized symbols to the emitter for further processing.
|
||||
|
||||
The error recovery policy of the parser is pretty simple. When an error is detected, it is recorded,
|
||||
and the rest of the (possibly folded) line is read, and parsing continues.
|
||||
</remarks>
|
||||
|
||||
<example>
|
||||
The following snippet will read the contents of the file 'myCalendar.ics', which the
|
||||
parser will expect to contain iCalendar statements, and will write the RdfICalendar
|
||||
equivalent to standard output.
|
||||
<code>
|
||||
RDFEmitter emitter = new RDFEmitter( );
|
||||
StreamReader reader = new StreamReader( "myCalendar.ics" );
|
||||
Parser parser = new Parser( reader, emitter );
|
||||
parser.Parse( );
|
||||
Console.WriteLine( emitter.Rdf );
|
||||
</code>
|
||||
</example>
|
||||
<example>Следующий фрагмент служит для считывания содержимого файла myCalendar.ics, где синтаксический анализатор ожидает наличие операторов iCalendar, и записи эквивалента RdfICalendar в стандартный вывод. <code>RDFEmitter emitter = new RDFEmitter( ); StreamReader reader = new StreamReader( "myCalendar.ics" ); Parser parser = new Parser( reader, emitter ); parser.Parse( ); Console.WriteLine( emitter.Rdf ); </code></example>
|
||||
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.#ctor(System.IO.TextReader,ASC.Api.Calendar.iCalParser.IEmitter)">
|
||||
<summary>
|
||||
Create a new iCalendar parser.
|
||||
</summary>
|
||||
<param name="reader">The reader that contains the stream of text iCalendar</param>
|
||||
<param name="_emitter">The emitter that will transform the iCalendar elements</param>
|
||||
<summary>Создать новый синтаксический анализатор iCalendar.</summary>
|
||||
<param name="reader">Средство чтения, содержащее поток текста iCalendar</param>
|
||||
<param name="_emitter">Генератор, который преобразует элементы iCalendar</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.Parse">
|
||||
<summary>
|
||||
Main entry point for starting the Parser.
|
||||
</summary>
|
||||
<summary>Основная точка входа для запуска синтаксического анализатора.</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.Parse(System.Boolean)">
|
||||
<summary>
|
||||
Alternate entry point for starting the parser.
|
||||
</summary>
|
||||
<param name="emitHandT">Indicates if the emitter should be told to emit headers
|
||||
and trailers before and after emitting the iCalendar body</param>
|
||||
<summary>Альтернативная точка входа для запуска синтаксического анализатора.</summary>
|
||||
<param name="emitHandT">Указывает на то, нужно ли заставлять генератор создавать начальные и концевые сегменты перед созданием тела iCalendar и после его создания</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseID">
|
||||
<summary>
|
||||
Parse the first field (ID) of the line. Returns a boolean on weather or not the
|
||||
method sucesfully recognized an ID. If not, the method insures that the scanner
|
||||
will start at the beginning of a new line.
|
||||
</summary>
|
||||
<summary>Проанализировать первое поле строки (ИД). Возвращает логическое значение, указывающее на то, успешно ли распознан ИД при помощи метода. Если это не так, метод обеспечивает запуск сканера с начала новой строки.</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseAttributes(ASC.Api.Calendar.iCalParser.Scanner)">
|
||||
<summary>
|
||||
Parse the list of attributes - separated by ';'s. Attributes always are in the
|
||||
form 'id=value' and indicate key/value pairs in the iCalendar attribute format.
|
||||
</summary>
|
||||
<summary>Проанализировать список атрибутов, разделенных точкой с запятой. Атрибуты всегда существуют в формате "id=значение". Они указывают на пары ключ/значение в формате атрибута iCalendar.</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseValue">
|
||||
<summary>
|
||||
Parse the value. The value is the last data item on a iCalendar input line.
|
||||
</summary>
|
||||
<summary>Проанализировать значение. Значение является последним элементом данных в строке ввода iCalendar.</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.ParserError">
|
||||
<summary>
|
||||
Basic error handling mechanism for the Parser
|
||||
</summary>
|
||||
<summary>Базовый механизм обработки ошибок синтаксическим анализатором</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Scanner">
|
||||
<summary>
|
||||
The scanner is responsible for tokenizing iCalendar (RFC2445) files for use by the
|
||||
parser.
|
||||
</summary>
|
||||
<summary>Сканер отвечает за разметку файлов iCalendar (RFC2445) для обработки синтаксическим анализатором.</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Scanner.GetNextToken(ASC.Api.Calendar.iCalParser.ScannerState)">
|
||||
<summary>
|
||||
Returns the next token in the file. Returns null on EOF.
|
||||
</summary>
|
||||
<summary>Возвращает следующий маркер в файле. Возвращает пустое значение в конце файла.</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Scanner.ConsumeToEOL">
|
||||
<summary>
|
||||
This method is used for error recovery, get the rest of the line, including
|
||||
folded lines, and position on a fresh line or EOF
|
||||
</summary>
|
||||
<summary>Этот метод применяется при восстановлении после ошибок, получения оставшейся строки, включая строки с переносом, и выбора позиции с новой строки или в конце файла. </summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Token">
|
||||
<summary>
|
||||
Represents the individual tokens returned from the scanner to the parser. Note that the
|
||||
Token creation process is sensitive to the ScannerState. This state is defined by what context
|
||||
the scanner currently is in - Parsing IDs, Parmeters, or values:
|
||||
e.g. the iCalendar grammar defines the following possible states
|
||||
id;id=parm:value
|
||||
each string parsed out of the value has to be treated differently (eg. quoted strings are
|
||||
allowed in 'parm' but not in 'id')
|
||||
|
||||
</summary>
|
||||
<summary>Представляет собой отдельные маркеры, возвращаемые синтаксическому анализатору сканером. Учтите, что процесс создания маркеров зависит от параметра ScannerState. Это состояние определяется текущим контекстом сканера: анализом идентификаторов, параметров или значений. Например, грамматика iCalendar определяет следующие возможные состояния: id;id=parm:value. Каждую строку, полученную при анализе значения, нужно обрабатывать по-своему (например, строки в кавычках разрешены в разделе "parm", но не в разделе "id").</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Notification.CalendarPatternResource">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
<summary>Строго типизированный класс ресурсов для поиска локализованных строк и т. д.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
<summary>Возвращает используемый этим классом кэшированный экземпляр ResourceManager.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.Culture">
|
||||
<summary>
|
||||
Overrides the current thread's CurrentUICulture property for all
|
||||
resource lookups using this strongly typed resource class.
|
||||
</summary>
|
||||
<summary>Переопределяет свойство CurrentUICulture текущего потока для поиска любых ресурсов с помощью этого строго типизированного класса ресурсов.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.CalendarSharingEmailPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
h1.Access Granted to Calendar: $CalendarName
|
||||
|
||||
|
||||
"$UserName":"$UserLink" has granted you the access to the calendar: $CalendarName
|
||||
|
||||
^You receive this email because you are a registered user of the "${__VirtualRootPath}":"${__VirtualRootPath}" portal. If you do not want to receive the notifications about the calendars shared with you, please manage your "subscription settings":"$RecipientSubscriptionConfigURL".^
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
h1.Access Granted to Event: $ [rest of string was truncated]";.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: #if($SharingType == "calendar") h1.Открыт доступ к календарю: $CalendarName "$UserName":"$UserLink" открыл вам доступ к календарю: $CalendarName ^Вы получили это сообщение, потому что являетесь зарегистрированным пользователем портала "${__VirtualRootPath}":"${__VirtualRootPath}". Если вы не хотите получать уведомления о календарях, к которым у вас есть доступ, измените свои "настройки подписки":"$RecipientSubscriptionConfigURL".^ #end #if($SharingType == "event") h1.Открыт доступ к событию: $ [остаток строки опущен]";.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.CalendarSharingJabberPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
Calendar. Access Granted to Calendar: $CalendarName
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
Calendar. Access Granted to Event: $EventName
|
||||
#end.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: #if($SharingType == "calendar") Calendar. Открыт доступ к календарю: $CalendarName #end #if($SharingType == "event") Calendar. Открыт доступ к событию: $EventName #end.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.CalendarSharingSubject">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
Calendar. Access granted to calendar: $CalendarName
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
Calendar. Access granted to event: $EventName
|
||||
#end.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: #if($SharingType == "calendar") Calendar. Открыт доступ к календарю: $CalendarName #end #if($SharingType == "event") Calendar. Открыт доступ к событию: $EventName #end.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertEmailPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to h1.Reminder about the Event: $EventName
|
||||
|
||||
|
||||
The $EventName event is appointed for $EventStartDate #if($EventEndDate!="")- $EventEndDate #end
|
||||
#if($EventDescription!="")
|
||||
|
||||
Event Description:
|
||||
|
||||
$EventDescription
|
||||
#end
|
||||
|
||||
|
||||
^You receive this email because you are a registered user of the "${__VirtualRootPath}":"${__VirtualRootPath}" portal. If you do not want to receive the event reminders, please manage your "subscription settings":"$RecipientSubscriptionConfigURL".^.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: h1.Напоминание о событии: $EventName Событие $EventName назначено на $EventStartDate #if($EventEndDate!="")- $EventEndDate #end #if($EventDescription!="") Описание события: $EventDescription #end ^Вы получили это сообщение, потому что являетесь зарегистрированным пользователем портала "${__VirtualRootPath}":"${__VirtualRootPath}". Если вы не хотите получать напоминания о событии, измените "настройки подписки":"$RecipientSubscriptionConfigURL".^.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertJabberPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to The $EventName event is appointed for $EventStartDate #if($EventEndDate!="")- $EventEndDate #end
|
||||
#if($EventDescription!="")
|
||||
|
||||
Event Description:
|
||||
|
||||
$EventDescription
|
||||
#end.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Событие $EventName назначено на $EventStartDate #if($EventEndDate!="")- $EventEndDate #end #if($EventDescription!="") Описание события: $EventDescription #end.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertSubject">
|
||||
<summary>
|
||||
Looks up a localized string similar to Calendar. Reminder about the event: $EventName.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Calendar. Напоминание о событии: $EventName.</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Notification.CalendarPatterns">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
<summary>Строго типизированный класс ресурсов для поиска локализованных строк и т. д.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatterns.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
<summary>Возвращает используемый этим классом кэшированный экземпляр ResourceManager.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatterns.Culture">
|
||||
<summary>
|
||||
Overrides the current thread's CurrentUICulture property for all
|
||||
resource lookups using this strongly typed resource class.
|
||||
</summary>
|
||||
<summary>Переопределяет свойство CurrentUICulture текущего потока для поиска любых ресурсов с помощью этого строго типизированного класса ресурсов.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatterns.calendar_patterns">
|
||||
<summary>
|
||||
Looks up a localized string similar to <patterns>
|
||||
<formatter type="ASC.Notify.Patterns.NVelocityPatternFormatter, ASC.Common" />
|
||||
|
||||
<pattern id="CalendarSharingPattern" sender="email.sender">
|
||||
<subject resource="|CalendarSharingSubject|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" />
|
||||
<body styler="ASC.Notify.Textile.TextileStyler,ASC.Notify.Textile" resource="|CalendarSharingEmailPattern|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" />
|
||||
</pattern>
|
||||
<pattern id="CalendarSharing [rest of string was truncated]";.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: <patterns> <formatter type="ASC.Notify.Patterns.NVelocityPatternFormatter, ASC.Common" /> <pattern id="CalendarSharingPattern" sender="email.sender"> <subject resource="|CalendarSharingSubject|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" /> <body styler="ASC.Notify.Textile.TextileStyler,ASC.Notify.Textile" resource="|CalendarSharingEmailPattern|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" /> </pattern> <pattern id="CalendarSharing [rest of string was truncated]";.</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Resources.CalendarApiResource">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
<summary>Строго типизированный класс ресурсов для поиска локализованных строк и т. д.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
<summary>Возвращает используемый этим классом кэшированный экземпляр ResourceManager.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.Culture">
|
||||
<summary>
|
||||
Overrides the current thread's CurrentUICulture property for all
|
||||
resource lookups using this strongly typed resource class.
|
||||
</summary>
|
||||
<summary>Переопределяет свойство CurrentUICulture текущего потока для поиска любых ресурсов с помощью этого строго типизированного класса ресурсов.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.BirthdayCalendarDescription">
|
||||
<summary>
|
||||
Looks up a localized string similar to Reminds about users' birthdays.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Напоминания о днях рождения пользователей.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.BirthdayCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Users' birthdays.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Дни рождения пользователей.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.CommonCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Common calendars.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Общие календари.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.DefaultCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to My calendar.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Мой календарь.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorAccessDenied">
|
||||
<summary>
|
||||
Looks up a localized string similar to Access Denied.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Доступ запрещен.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorEmptyName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Name can't be empty.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Имя не может быть пустым.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorIncorrectDateFormat">
|
||||
<summary>
|
||||
Looks up a localized string similar to Date format is incorrect.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Неверный формат даты.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorItemNotFound">
|
||||
<summary>
|
||||
Looks up a localized string similar to Item not found.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Элемент не найден.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.FullAccessOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Full Access.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Полный доступ.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.iCalCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to iCal Calendars.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Календари iCal.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.NoNameCalendar">
|
||||
<summary>
|
||||
Looks up a localized string similar to No title.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Без названия.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.NoNameEvent">
|
||||
<summary>
|
||||
Looks up a localized string similar to No title.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Без названия.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.OwnerOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Owner.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Владелец.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.PersonalCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Personal calendars.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Личные календари.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ReadOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Read Only.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Только для чтения.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Calendars shared with me.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Доступные мне календари.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedEventsCalendarDescription">
|
||||
<summary>
|
||||
Looks up a localized string similar to Here are all events, which another users shared with me.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Вот все события, которыми со мной поделились другие пользователи.</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedEventsCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Events shared with me.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: События, которыми со мной поделились. </summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.WrongiCalFeedLink">
|
||||
<summary>
|
||||
Looks up a localized string similar to An invalid reference to iCal.
|
||||
</summary>
|
||||
<summary>Выполняет поиск локализованной строки, которая похожа на следующую: Неверная ссылка на iCal.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,378 +1,254 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Employee</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Employee.EmployeeApi">
|
||||
<summary>
|
||||
User profiles access
|
||||
</summary>
|
||||
<summary>Доступ к профилю пользователя</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetMe">
|
||||
<summary>
|
||||
Returns the detailed information about the current user profile
|
||||
</summary>
|
||||
<short>
|
||||
My profile
|
||||
</short>
|
||||
<returns>Profile</returns>
|
||||
<summary>Возвращает подробные сведения о профиле текущего пользователя</summary>
|
||||
<short>Мой профиль</short>
|
||||
<returns>Профиль</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetAll">
|
||||
<summary>
|
||||
Returns the list of profiles for all portal users
|
||||
</summary>
|
||||
<short>
|
||||
All profiles
|
||||
</short>
|
||||
<returns>List of profiles</returns>
|
||||
<remarks>This method returns a partial profile. Use more specific method to get full profile</remarks>
|
||||
<summary>Возвращает список профилей всех пользователей портала</summary>
|
||||
<short>Все профили</short>
|
||||
<returns>Список профилей</returns>
|
||||
<remarks>Этот метод приводит к показу части профиля. Чтобы получить профиль целиком, воспользуйтесь более определенным методом</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetById(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the profile of the user with the name specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Specific profile
|
||||
</short>
|
||||
<param name="username">User name</param>
|
||||
<returns>User profile</returns>
|
||||
<summary>Возвращает подробные сведения о профиле пользователя с указанным в запросе именем</summary>
|
||||
<short>Определенный профиль</short>
|
||||
<param name="username">Имя пользователя</param>
|
||||
<returns>Профиль пользователя</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetByEmail(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the profile of the user with the name specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Specific profile
|
||||
</short>
|
||||
<param name="email">User email</param>
|
||||
<returns>User profile</returns>
|
||||
<summary>Возвращает подробные сведения о профиле пользователя с указанным в запросе именем</summary>
|
||||
<short>Определенный профиль</short>
|
||||
<param name="email">Адрес пользователя</param>
|
||||
<returns>Профиль пользователя</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetSearch(System.String)">
|
||||
<summary>
|
||||
Returns the list of profiles for all portal users matching the search query
|
||||
</summary>
|
||||
<short>
|
||||
Search users
|
||||
</short>
|
||||
<param name="query">Query</param>
|
||||
<returns>List of users</returns>
|
||||
<summary>Возвращает список профилей всех пользователей портала, соответствующих поисковому запросу</summary>
|
||||
<short>Выполнить поиск пользователей</short>
|
||||
<param name="query">Запрос</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetPeopleSearch(System.String)">
|
||||
<summary>
|
||||
Returns the list of users matching the search criteria
|
||||
</summary>
|
||||
<short>
|
||||
User search
|
||||
</short>
|
||||
<param name="query">Search text</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Возвращает список пользователей, соответствующих поисковому запросу</summary>
|
||||
<short>Поиск пользователя</short>
|
||||
<param name="query">Выполнить поиск текста</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetAdvanced(ASC.Core.Users.EmployeeStatus,System.String)">
|
||||
<summary>
|
||||
Returns the list of users matching the status filter and text search
|
||||
</summary>
|
||||
<short>
|
||||
User search by filter
|
||||
</short>
|
||||
<param name="status">User status</param>
|
||||
<param name="query">Search text</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Возвращает список пользователей, соответствующих фильтру статуса и искомому тексту</summary>
|
||||
<short>Поиск пользователя с фильтром</short>
|
||||
<param name="status">Статус пользователя</param>
|
||||
<param name="query">Выполнить поиск текста</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SaveUsers(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Adds a new portal user from import with the first and last name, email address
|
||||
</summary>
|
||||
<short>
|
||||
Add new import user
|
||||
</short>
|
||||
<param name="userList">The list of users to add</param>
|
||||
<param name="importUsersAsCollaborators" optional="true">Add users as guests (bool type: false|true)</param>
|
||||
<returns>Newly created users</returns>
|
||||
<summary>Импортирует нового пользователя портала и добавляет сведения о его имени, фамилии и адресе электронной почты</summary>
|
||||
<short>Добавить нового импортированного пользователя</short>
|
||||
<param name="userList">Список добавляемых пользователей</param>
|
||||
<param name="importUsersAsCollaborators" optional="true">Добавить пользователей как гостей (логический тип данных: false|true)</param>
|
||||
<returns>Недавно созданные пользователи</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetFullByFilter(System.Nullable{ASC.Core.Users.EmployeeStatus},System.Nullable{System.Guid},System.Nullable{ASC.Core.Users.EmployeeActivationStatus},System.Nullable{ASC.Core.Users.EmployeeType},System.Nullable{System.Boolean})">
|
||||
<summary>
|
||||
Returns the list of users matching the filter with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User search by extended filter
|
||||
</short>
|
||||
<param optional="true" name="employeeStatus">User status</param>
|
||||
<param optional="true" name="groupId">Group ID</param>
|
||||
<param optional="true" name="activationStatus">Activation status</param>
|
||||
<param optional="true" name="employeeType">User type</param>
|
||||
<param optional="true" name="isAdministrator">Administrator(bool type)</param>
|
||||
<returns>
|
||||
User list
|
||||
</returns>
|
||||
<summary>Возвращает список соответствующих фильтру пользователей с указанными в запросе параметрами</summary>
|
||||
<short>Поиск пользователя с расширенным фильтром</short>
|
||||
<param optional="true" name="employeeStatus">Статус пользователя</param>
|
||||
<param optional="true" name="groupId">ИД группы</param>
|
||||
<param optional="true" name="activationStatus">Статус активации</param>
|
||||
<param optional="true" name="employeeType">Тип пользователя</param>
|
||||
<param optional="true" name="isAdministrator">Администратор (логический тип данных)</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetSimpleByFilter(System.Nullable{ASC.Core.Users.EmployeeStatus},System.Nullable{System.Guid},System.Nullable{ASC.Core.Users.EmployeeActivationStatus},System.Nullable{ASC.Core.Users.EmployeeType},System.Nullable{System.Boolean})">
|
||||
<summary>
|
||||
Returns the list of users matching the filter with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User search by extended filter
|
||||
</short>
|
||||
<param optional="true" name="employeeStatus">User status</param>
|
||||
<param optional="true" name="groupId">Group ID</param>
|
||||
<param optional="true" name="activationStatus">Activation status</param>
|
||||
<param optional="true" name="employeeType">User type</param>
|
||||
<param optional="true" name="isAdministrator">Administrator(bool type)</param>
|
||||
<returns>
|
||||
User list
|
||||
</returns>
|
||||
<summary>Возвращает список соответствующих фильтру пользователей с указанными в запросе параметрами</summary>
|
||||
<short>Поиск пользователя с расширенным фильтром</short>
|
||||
<param optional="true" name="employeeStatus">Статус пользователя</param>
|
||||
<param optional="true" name="groupId">ИД группы</param>
|
||||
<param optional="true" name="activationStatus">Статус активации</param>
|
||||
<param optional="true" name="employeeType">Тип пользователя</param>
|
||||
<param optional="true" name="isAdministrator">Администратор (логический тип данных)</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.AddMember(System.Boolean,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.String)">
|
||||
<summary>
|
||||
Adds a new portal user with the first and last name, email address and several optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Add new user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="email">Email</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<param name="comment" optional="true">Comment for user</param>
|
||||
<param name="contacts">List of contacts</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<param name="password" optional="true">User Password</param>
|
||||
<returns>Newly created user</returns>
|
||||
<summary>Добавляет нового пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и несколькими необязательными параметрами</summary>
|
||||
<short>Добавить нового пользователя</short>
|
||||
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
|
||||
<param name="email">Адрес эл. почты</param>
|
||||
<param name="firstname">Имя</param>
|
||||
<param name="lastname">Фамилия</param>
|
||||
<param name="department" optional="true">Отдел</param>
|
||||
<param name="title" optional="true">Название</param>
|
||||
<param name="location" optional="true">Местоположение</param>
|
||||
<param name="sex" optional="true">Пол (мужской|женский)</param>
|
||||
<param name="birthday" optional="true">День рождения</param>
|
||||
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
|
||||
<param name="comment" optional="true">Комментарий для пользователя</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<param name="files">URL-адрес фотографии аватара</param>
|
||||
<param name="password" optional="true">Пароль пользователя</param>
|
||||
<returns>Недавно созданный пользователь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.AddMemberAsActivated(System.Boolean,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.String)">
|
||||
<summary>
|
||||
Adds a new portal user with the first and last name, email address and several optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Add new user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="email">Email</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<param name="comment" optional="true">Comment for user</param>
|
||||
<param name="contacts">List of contacts</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<param name="password">User Password</param>
|
||||
<returns>Newly created user</returns>
|
||||
<summary>Добавляет нового пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и несколькими необязательными параметрами</summary>
|
||||
<short>Добавить нового пользователя</short>
|
||||
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
|
||||
<param name="email">Адрес эл. почты</param>
|
||||
<param name="firstname">Имя</param>
|
||||
<param name="lastname">Фамилия</param>
|
||||
<param name="department" optional="true">Отдел</param>
|
||||
<param name="title" optional="true">Название</param>
|
||||
<param name="location" optional="true">Местоположение</param>
|
||||
<param name="sex" optional="true">Пол (мужской|женский)</param>
|
||||
<param name="birthday" optional="true">День рождения</param>
|
||||
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
|
||||
<param name="comment" optional="true">Комментарий для пользователя</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<param name="files">URL-адрес фотографии аватара</param>
|
||||
<param name="password">Пароль пользователя</param>
|
||||
<returns>Недавно созданный пользователь</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMember(System.Boolean,System.String,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.Nullable{System.Boolean})">
|
||||
<summary>
|
||||
Updates the data for the selected portal user with the first and last name, email address and/or optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="userid">User ID to update</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="comment" optional="true">Comment for user</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<param name="contacts">List fo contacts</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<summary>Обновляет данные для выбранного пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и/или необязательными параметрами</summary>
|
||||
<short>Обновить пользователя</short>
|
||||
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
|
||||
<param name="userid">ИД обновляемого пользователя</param>
|
||||
<param name="firstname">Имя</param>
|
||||
<param name="lastname">Фамилия</param>
|
||||
<param name="comment" optional="true">Комментарий для пользователя</param>
|
||||
<param name="department" optional="true">Отдел</param>
|
||||
<param name="title" optional="true">Название</param>
|
||||
<param name="location" optional="true">Местоположение</param>
|
||||
<param name="sex" optional="true">Пол (мужской|женский)</param>
|
||||
<param name="birthday" optional="true">День рождения</param>
|
||||
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<param name="files">URL-адрес фотографии аватара</param>
|
||||
<param name="disable"></param>
|
||||
<returns>Newly created user</returns>
|
||||
<returns>Недавно созданный пользователь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMember(System.String)">
|
||||
<summary>
|
||||
Deletes the user with the ID specified in the request from the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete user
|
||||
</short>
|
||||
<param name="userid">ID of user to delete</param>
|
||||
<summary>Удаляет пользователя с указанным в запросе с портала ИД</summary>
|
||||
<short>Удалить пользователя</short>
|
||||
<param name="userid">ИД удаляемого пользователя</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information merging the sent data with the present on the portal
|
||||
</summary>
|
||||
<short>
|
||||
Update user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
<summary>Обновляет контактные данные указанного пользователя, объединяя отправленные данные с данными на портале</summary>
|
||||
<short>Обновленные контакты пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<returns>Обновленный профиль пользователя</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SetMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information changing the data present on the portal for the sent data
|
||||
</summary>
|
||||
<short>
|
||||
Set user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
<summary>Обновляет контактные данные указанного пользователя, заменяя данные на портале отправленными данными</summary>
|
||||
<short>Задать контакты пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<returns>Обновленный профиль пользователя</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information deleting the data specified in the request from the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
<summary>Обновляет контактные данные указанного пользователя, удаляя с портала указанные в запросе данные</summary>
|
||||
<short>Удалить контакты пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="contacts">Список контактов</param>
|
||||
<returns>Обновленный профиль пользователя</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetMemberPhoto(System.String)">
|
||||
<summary>
|
||||
Get user photoes
|
||||
</summary>
|
||||
<short>
|
||||
Get user photoes
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<summary>Получить фотографии пользователя</summary>
|
||||
<short>Получить фотографии пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberPhoto(System.String,System.String)">
|
||||
<summary>
|
||||
Updates the specified user photo with the pathname
|
||||
</summary>
|
||||
<short>
|
||||
Update user photo
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<summary>Обновляет фотографию указанного пользователя с указанием пути</summary>
|
||||
<short>Обновить фотографию пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="files">URL-адрес фотографии аватара</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberPhoto(System.String)">
|
||||
<summary>
|
||||
Deletes the photo of the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Delete user photo
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<summary>Удаляет фотографию пользователя с указанным в запросе ИД</summary>
|
||||
<short>Удалить фотографию пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.CreateMemberPhotoThumbnails(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Create photo thumbnails by coordinates of original image
|
||||
</summary>
|
||||
<short>
|
||||
Create user photo thumbnails
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="tmpFile">Path to the temporary file</param>
|
||||
<summary>Создает эскизы фотографий с помощью координат исходного изображения</summary>
|
||||
<short>Создать эскизы фотографий пользователя</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="tmpFile">Путь к временному файлу</param>
|
||||
<param name="x">X</param>
|
||||
<param name="y">Y</param>
|
||||
<param name="width">Width</param>
|
||||
<param name="height">Height</param>
|
||||
<param name="width">Ширина</param>
|
||||
<param name="height">Высота</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SendUserPassword(System.String)">
|
||||
<summary>
|
||||
Remind password for the user with email specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Remind user password
|
||||
</short>
|
||||
<param name="email">User email</param>
|
||||
<summary>Напоминает пароль пользователя, адрес электронной почты которого указан в запросе</summary>
|
||||
<short>Напомнить пароль пользователя</short>
|
||||
<param name="email">Адрес пользователя</param>
|
||||
<returns></returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.ChangeUserPassword(System.Guid,System.String,System.String)">
|
||||
<summary>
|
||||
Sets the password and email for the user with the ID specified in the request
|
||||
</summary>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="password">Password</param>
|
||||
<param name="email">New email</param>
|
||||
<returns>Detailed user information</returns>
|
||||
<summary>Задает пароль и адрес электронной почты пользователя, ИД которого указан в запросе</summary>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<param name="password">Пароль</param>
|
||||
<param name="email">Новый адрес эл. почты</param>
|
||||
<returns>Подробные сведения о пользователе</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateEmployeeActivationStatus(ASC.Core.Users.EmployeeActivationStatus,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Sets the required activation status to the list of users with the ID specified in the request
|
||||
</summary>
|
||||
<summary>
|
||||
Set activation status
|
||||
</summary>
|
||||
<param name="userIds">User list ID</param>
|
||||
<param name="activationstatus">Required status</param>
|
||||
<returns>List of users</returns>
|
||||
<summary>Задает необходимый статус активации исходя из списка пользователей с указанным в запросе ИД</summary>
|
||||
<summary>Задать статус активации</summary>
|
||||
<param name="userIds">ИД списка пользователей</param>
|
||||
<param name="activationstatus">Необходимый статус</param>
|
||||
<returns>Список пользователей</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserType(ASC.Core.Users.EmployeeType,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Changes the type between user and guest for the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User type change
|
||||
</short>
|
||||
<param name="type">New user type</param>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Изменяет тип пользователя (пользователь или гость) с указанным в запросе ИД</summary>
|
||||
<short>Изменение типа пользователя</short>
|
||||
<param name="type">Новый тип пользователя</param>
|
||||
<param name="userIds">Список ИД пользователей</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserStatus(ASC.Core.Users.EmployeeStatus,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Changes the status between active and disabled for the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User status change
|
||||
</short>
|
||||
<param name="status">New user status</param>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Изменяет статус пользователя (активный или заблокированный) с указанным в запросе ИД</summary>
|
||||
<short>Изменение статуса пользователя</short>
|
||||
<param name="status">Новый статус пользователя</param>
|
||||
<param name="userIds">Список ИД пользователей</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.ResendUserInvites(System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Sends emails once again for the users who have not activated their emails
|
||||
</summary>
|
||||
<short>
|
||||
Send activation email
|
||||
</short>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Снова отправляет сообщения пользователям, которые не активировали свои адреса электронной почты</summary>
|
||||
<short>Отправить сообщение об активации</short>
|
||||
<param name="userIds">Список ИД пользователей</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.RemoveUsers(System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Delete the list of selected users
|
||||
</summary>
|
||||
<short>
|
||||
Delete users
|
||||
</short>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
<summary>Удаляет список выбранных пользователей</summary>
|
||||
<short>Удалить пользователей</short>
|
||||
<param name="userIds">Список ИД пользователей</param>
|
||||
<returns>Список пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SendInstructionsToDelete">
|
||||
<summary>
|
||||
Send instructions for delete user own profile
|
||||
</summary>
|
||||
<short>
|
||||
Send delete instructions
|
||||
</short>
|
||||
<returns>Info message</returns>
|
||||
<summary>Отправляет инструкции для удаления собственного профиля пользователя</summary>
|
||||
<short>Отправить инструкции по удалению</short>
|
||||
<returns>Информационное сообщение</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.JoinToAffiliateProgram">
|
||||
<summary>
|
||||
Join to affiliate programm
|
||||
</summary>
|
||||
<short>
|
||||
Join to affiliate programm
|
||||
</short>
|
||||
<returns>Link to affiliate programm</returns>
|
||||
<summary>Присоединиться к Аффилиат-программе</summary>
|
||||
<short>Присоединиться к Аффилиат-программе</short>
|
||||
<returns>Ссылка на Аффилиат-программу</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.LinkAccount(System.String)">
|
||||
<visible>false</visible>
|
||||
@ -381,186 +257,122 @@
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetReassignProgress(System.Guid)">
|
||||
<summary>
|
||||
Returns the progress of the started reassign process
|
||||
</summary>
|
||||
<param name="userId">User ID whose data is reassigned</param>
|
||||
<category>Reassign user data</category>
|
||||
<returns>Reassign Progress</returns>
|
||||
<summary>Возвращает ход выполнения запущенного процесса переназначения</summary>
|
||||
<param name="userId">ИД пользователя, данные которого переназначаются</param>
|
||||
<category>Переназначить данные пользователя</category>
|
||||
<returns>Ход выполнения переназначения</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateReassign(System.Guid)">
|
||||
<summary>
|
||||
Terminate reassign process
|
||||
</summary>
|
||||
<param name="userId">User ID whose data is reassigned</param>
|
||||
<category>Reassign user data</category>
|
||||
<summary>Завершить процесс переназначения</summary>
|
||||
<param name="userId">ИД пользователя, данные которого переназначаются</param>
|
||||
<category>Переназначить данные пользователя</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.StartReassign(System.Guid,System.Guid,System.Boolean)">
|
||||
<summary>
|
||||
Start a reassign process
|
||||
</summary>
|
||||
<param name="fromUserId">From User ID</param>
|
||||
<param name="toUserId">To User ID</param>
|
||||
<param name="deleteProfile">Delete profile when reassignment will be finished</param>
|
||||
<category>Reassign user data</category>
|
||||
<returns>Reassign Progress</returns>
|
||||
<summary>Запустить процесс переназначения</summary>
|
||||
<param name="fromUserId">ИД пользователя-отправителя</param>
|
||||
<param name="toUserId">ИД пользователя-получателя</param>
|
||||
<param name="deleteProfile">Удалить профиль по завершении переназначения</param>
|
||||
<category>Переназначить данные пользователя</category>
|
||||
<returns>Ход выполнения переназначения</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetRemoveProgress(System.Guid)">
|
||||
<summary>
|
||||
Returns the progress of the started remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
<returns>Remove Progress</returns>
|
||||
<summary>Возвращает ход выполнения запущенного процесса удаления</summary>
|
||||
<param name="userId">ИД пользователя</param>
|
||||
<category>Удалить данные пользователя</category>
|
||||
<returns>Ход выполнения удаления</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateRemove(System.Guid)">
|
||||
<summary>
|
||||
Terminate remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
<summary>Завершить процесс удаления</summary>
|
||||
<param name="userId">ИД пользователя</param>
|
||||
<category>Удалить данные пользователя</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.StartRemove(System.Guid)">
|
||||
<summary>
|
||||
Start a remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
<returns>Remove Progress</returns>
|
||||
<summary>Начать процесс удаления</summary>
|
||||
<param name="userId">ИД пользователя</param>
|
||||
<category>Удалить данные пользователя</category>
|
||||
<returns>Ход выполнения удаления</returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Employee.GroupsApi">
|
||||
<summary>
|
||||
Groups access
|
||||
</summary>
|
||||
<summary>Доступ к группам</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetAll">
|
||||
<summary>
|
||||
Returns the general information about all groups, such as group ID and group manager
|
||||
</summary>
|
||||
<short>
|
||||
All groups
|
||||
</short>
|
||||
<returns>List of groups</returns>
|
||||
<remarks>
|
||||
This method returns partial group info
|
||||
</remarks>
|
||||
<summary>Возвращает общие сведения обо всех группах (например, ИД группы и сведения о менеджере группы)</summary>
|
||||
<short>Все группы</short>
|
||||
<returns>Список групп</returns>
|
||||
<remarks>Этот метод приводит к показу части сведений о группе</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetById(System.Guid)">
|
||||
<summary>
|
||||
Returns the detailed information about the selected group: group name, category, description, manager, users and parent group if any
|
||||
</summary>
|
||||
<short>
|
||||
Specific group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<returns>Group</returns>
|
||||
<remarks>
|
||||
That method returns full group info
|
||||
</remarks>
|
||||
<summary>Возвращает подробные сведения о выбранной группе: название группы, категория, описание, менеджер, пользователи и родительская группа, если она существует</summary>
|
||||
<short>Определенная группа</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<returns>Группа</returns>
|
||||
<remarks>Этот метод приводит к показу всех сведений о группе</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetByUserId(System.Guid)">
|
||||
<summary>
|
||||
Returns the group list for user
|
||||
</summary>
|
||||
<short>
|
||||
User groups
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<returns>Group</returns>
|
||||
<remarks>
|
||||
That method returns user groups
|
||||
</remarks>
|
||||
<summary>Возвращает список групп для пользователя</summary>
|
||||
<short>Группы пользователей</short>
|
||||
<param name="userid">ИД пользователя</param>
|
||||
<returns>Группа</returns>
|
||||
<remarks>Этот метод приводит к показу групп пользователя</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.AddGroup(System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Adds a new group with the group manager, name and users specified
|
||||
</summary>
|
||||
<short>
|
||||
Add new group
|
||||
</short>
|
||||
<param name="groupManager">Group manager</param>
|
||||
<param name="groupName">Group name</param>
|
||||
<param name="members">List of group users</param>
|
||||
<returns>Newly created group</returns>
|
||||
<summary>Добавляет новую группу с указанными менеджером группы, названием и пользователями</summary>
|
||||
<short>Добавить новую группу</short>
|
||||
<param name="groupManager">Менеджер группы</param>
|
||||
<param name="groupName">Название группы</param>
|
||||
<param name="members">Список пользователей группы</param>
|
||||
<returns>Недавно созданная группа</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.UpdateGroup(System.Guid,System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Updates an existing group changing the group manager, name and/or users
|
||||
</summary>
|
||||
<short>
|
||||
Update existing group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="groupManager">Group manager</param>
|
||||
<param name="groupName">Group name</param>
|
||||
<param name="members">List of group users</param>
|
||||
<returns>Newly created group</returns>
|
||||
<summary>Обновляет существующую группу, изменяя менеджера группы, название и/или пользователей</summary>
|
||||
<short>Обновить существующую группу</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<param name="groupManager">Менеджер группы</param>
|
||||
<param name="groupName">Название группы</param>
|
||||
<param name="members">Список пользователей группы</param>
|
||||
<returns>Недавно созданная группа</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.DeleteGroup(System.Guid)">
|
||||
<summary>
|
||||
Deletes the selected group from the list of groups on the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<summary>Удаляет выбранную группу из списка групп на портале</summary>
|
||||
<short>Удалить группу</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.TransferMembersTo(System.Guid,System.Guid)">
|
||||
<summary>
|
||||
Move all the users from the selected group to another one specified
|
||||
</summary>
|
||||
<short>
|
||||
Move group users
|
||||
</short>
|
||||
<param name="groupid">ID of group to move from</param>
|
||||
<param name="newgroupid">ID of group to move to</param>
|
||||
<returns>Group info which users were moved</returns>
|
||||
<summary>Переместить всех пользователей из выбранной группы в другую указанную группу</summary>
|
||||
<short>Переместить пользователей группы</short>
|
||||
<param name="groupid">ИД исходной группы</param>
|
||||
<param name="newgroupid">ИД группы назначения</param>
|
||||
<returns>Сведения о группе, пользователи которой перемещены</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.SetMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Manages the group users deleting the current users and setting new ones instead
|
||||
</summary>
|
||||
<short>
|
||||
Set group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<summary>Управляет пользователями группы, удаляя текущих пользователей и добавляя вместо них новых пользователей</summary>
|
||||
<short>Задать пользователей группы</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<param name="members">Список пользователей</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.AddMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Add new group users keeping the current users and adding new ones
|
||||
</summary>
|
||||
<short>
|
||||
Add group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<summary>Добавить новых пользователей группы с сохранением текущих пользователей</summary>
|
||||
<short>Добавить пользователей группы</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<param name="members">Список пользователей</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.SetManager(System.Guid,System.Guid)">
|
||||
<summary>
|
||||
Sets the user with the ID sent as a manager to the selected group
|
||||
</summary>
|
||||
<short>
|
||||
Set group manager
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="userid">User ID to become manager</param>
|
||||
<summary>Назначает пользователя с отправленным ИД менеджером выбранной группы</summary>
|
||||
<short>Задать менеджера группы</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<param name="userid">ИД пользователя, который станет менеджером</param>
|
||||
<returns></returns>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.RemoveMembersFrom(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Removes the specified group users with all the rest current group users retained
|
||||
</summary>
|
||||
<short>
|
||||
Remove group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<summary>Удаляет указанных пользователей группы с сохранением всех текущих пользователей группы</summary>
|
||||
<short>Удалить пользователей группы</short>
|
||||
<param name="groupid">ИД группы</param>
|
||||
<param name="members">Список пользователей</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,266 +1,210 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.MailServer</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailbox(System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Create mailbox
|
||||
</summary>
|
||||
<summary>Создать почтовый ящик</summary>
|
||||
<param name="name"></param>
|
||||
<param name="local_part"></param>
|
||||
<param name="domain_id"></param>
|
||||
<param name="user_id"></param>
|
||||
<param name="notifyCurrent">Send message to creating mailbox's address</param>
|
||||
<param name="notifyProfile">Send message to email from user profile</param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Create mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
<param name="notifyCurrent">Отправить сообщение по адресу создаваемого почтового ящика</param>
|
||||
<param name="notifyProfile">Отправить сообщение по адресу электронной почты из профиля пользователя</param>
|
||||
<returns>Параметр MailboxData, связанный с владельцем</returns>
|
||||
<short>Создать почтовый ящик</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMyMailbox(System.String)">
|
||||
<summary>
|
||||
Create my mailbox
|
||||
</summary>
|
||||
<summary>Создать мой почтовый ящик</summary>
|
||||
<param name="name"></param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Create mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
<returns>Параметр MailboxData, связанный с владельцем</returns>
|
||||
<short>Создать почтовый ящик</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailboxes">
|
||||
<summary>
|
||||
Returns list of the mailboxes associated with tenant
|
||||
</summary>
|
||||
<returns>List of MailboxData for current tenant</returns>
|
||||
<short>Get mailboxes list</short>
|
||||
<category>Mailboxes</category>
|
||||
<summary>Возвращает список почтовых ящиков, связанных с владельцем</summary>
|
||||
<returns>Список параметров MailboxData для текущего владельца</returns>
|
||||
<short>Получить список почтовых ящиков</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailbox(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected mailbox
|
||||
</summary>
|
||||
<param name="id">id of mailbox</param>
|
||||
<returns>MailOperationResult object</returns>
|
||||
<exception cref="T:System.ArgumentException">Exception happens when some parameters are invalid. Text description contains parameter name and text description.</exception>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Exception happens when mailbox wasn't found.</exception>
|
||||
<short>Remove mailbox from mail server</short>
|
||||
<category>Mailboxes</category>
|
||||
<summary>Удаляет выбранный почтовый ящик</summary>
|
||||
<param name="id">ИД почтового ящика</param>
|
||||
<returns>Объект MailOperationResult</returns>
|
||||
<exception cref="T:System.ArgumentException">Когда ряд параметров неверен, происходит исключение. Текстовое описание содержит название параметра и текстовое описание.</exception>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Когда почтовый ящик не найден, происходит исключение.</exception>
|
||||
<short>Удалить почтовый ящик с почтового сервера</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.UpdateMailbox(System.Int32,System.String)">
|
||||
<summary>
|
||||
Update mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<param name="name">sender name</param>
|
||||
<returns>Updated MailboxData</returns>
|
||||
<short>Update mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
<summary>Обновить почтовый ящик</summary>
|
||||
<param name="mailbox_id">ИД почтового ящика</param>
|
||||
<param name="name">имя отправителя</param>
|
||||
<returns>Обновленный MailboxData</returns>
|
||||
<short>Обновить почтовый ящик</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddMailboxAlias(System.Int32,System.String)">
|
||||
<summary>
|
||||
Add alias to mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<param name="alias_name">name of alias</param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Add mailbox's aliases</short>
|
||||
<summary>Добавить псевдоним почтового ящика</summary>
|
||||
<param name="mailbox_id">ИД почтового ящика</param>
|
||||
<param name="alias_name">название псевдонима</param>
|
||||
<returns>Параметр MailboxData, связанный с владельцем</returns>
|
||||
<short>Добавить псевдонимы почтового ящика</short>
|
||||
<category>AddressData</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailboxAlias(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Remove alias from mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<summary>Удалить псевдоним из почтового ящика</summary>
|
||||
<param name="mailbox_id">ИД почтового ящика</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>id of mailbox</returns>
|
||||
<short>Remove mailbox's aliases</short>
|
||||
<category>Mailboxes</category>
|
||||
<returns>ИД почтового ящика</returns>
|
||||
<short>Удалить псевдонимы почтового ящика</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.ChangeMailboxPassword(System.Int32,System.String)">
|
||||
<summary>
|
||||
Change mailbox password
|
||||
</summary>
|
||||
<summary>Изменить пароль почтового ящика</summary>
|
||||
<param name="mailbox_id"></param>
|
||||
<param name="password"></param>
|
||||
<short>Change mailbox password</short>
|
||||
<category>Mailboxes</category>
|
||||
<short>Изменить пароль почтового ящика</short>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.IsAddressAlreadyRegistered(System.String,System.Int32)">
|
||||
<summary>
|
||||
Check existence of mailbox address
|
||||
</summary>
|
||||
<summary>Проверка наличия адреса почтового ящика</summary>
|
||||
<param name="local_part"></param>
|
||||
<param name="domain_id"></param>
|
||||
<short>Is server mailbox address exists</short>
|
||||
<returns>True - address exists, False - not exists</returns>
|
||||
<category>Mailboxes</category>
|
||||
<short>Проверка наличия адреса почтового ящика на сервере</short>
|
||||
<returns>"True" означает, что адрес существует, а "False" — не существует</returns>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.IsAddressValid(System.String,System.Int32)">
|
||||
<summary>
|
||||
Validate mailbox address
|
||||
</summary>
|
||||
<summary>Проверить адрес почтового ящика</summary>
|
||||
<param name="local_part"></param>
|
||||
<param name="domain_id"></param>
|
||||
<short>Is server mailbox address valid</short>
|
||||
<returns>True - address valid, False - not valid</returns>
|
||||
<category>Mailboxes</category>
|
||||
<short>Проверка допустимости адреса почтового ящика на сервере</short>
|
||||
<returns>"True" означает, что адрес допустим, а "False" — недопустим</returns>
|
||||
<category>Почтовые ящики</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailGroup(System.String,System.Int32,System.Collections.Generic.List{System.Int32})">
|
||||
<summary>
|
||||
Create group address
|
||||
</summary>
|
||||
<summary>Создать групповой адрес</summary>
|
||||
<param name="name"></param>
|
||||
<param name="domain_id"></param>
|
||||
<param name="address_ids"></param>
|
||||
<returns>MailGroupData associated with tenant</returns>
|
||||
<short>Create mail group address</short>
|
||||
<returns>Параметр MailGroupData, связанный с владельцем</returns>
|
||||
<short>Добавить групповой почтовый адрес</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddMailGroupAddress(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Add addresses to group
|
||||
</summary>
|
||||
<param name="mailgroup_id">id of group address</param>
|
||||
<summary>Добавить адреса в группу</summary>
|
||||
<param name="mailgroup_id">ИД группового адреса</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>MailGroupData associated with tenant</returns>
|
||||
<short>Add group's addresses</short>
|
||||
<returns>Параметр MailGroupData, связанный с владельцем</returns>
|
||||
<short>Добавить адреса группы</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroupAddress(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Remove address from group
|
||||
</summary>
|
||||
<param name="mailgroup_id">id of group address</param>
|
||||
<summary>Удалить адрес из группы</summary>
|
||||
<param name="mailgroup_id">ИД группового адреса</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>id of group address</returns>
|
||||
<short>Remove group's address</short>
|
||||
<returns>ИД группового адреса</returns>
|
||||
<short>Удалить адрес группы</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailGroups">
|
||||
<summary>
|
||||
Returns list of group addresses associated with tenant
|
||||
</summary>
|
||||
<returns>List of MailGroupData for current tenant</returns>
|
||||
<short>Get mail group list</short>
|
||||
<summary>Возвращает список адресов групп, связанных с владельцем</summary>
|
||||
<returns>Список параметров MailGroupData для текущего владельца</returns>
|
||||
<short>Получить список почтовой группы</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroup(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected group address
|
||||
</summary>
|
||||
<param name="id">id of group address</param>
|
||||
<returns>id of group address</returns>
|
||||
<short>Remove group address from mail server</short>
|
||||
<summary>Удаляет выбранный групповой адрес</summary>
|
||||
<param name="id">ИД группового адреса</param>
|
||||
<returns>ИД группового адреса</returns>
|
||||
<short>Удалить групповой адрес с почтового сервера</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateNotificationAddress(System.String,System.String,System.Int32)">
|
||||
<summary>
|
||||
Create address for tenant notifications
|
||||
</summary>
|
||||
<summary>Создать адрес для уведомлений владельца</summary>
|
||||
<param name="name"></param>
|
||||
<param name="password"></param>
|
||||
<param name="domain_id"></param>
|
||||
<returns>NotificationAddressData associated with tenant</returns>
|
||||
<short>Create notification address</short>
|
||||
<category>Notifications</category>
|
||||
<returns>Параметр NotificationAddressData, связанный с владельцем</returns>
|
||||
<short>Создать адрес для уведомлений</short>
|
||||
<category>Уведомления</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveNotificationAddress(System.String)">
|
||||
<summary>
|
||||
Deletes address for notification
|
||||
</summary>
|
||||
<short>Remove mailbox from mail server</short>
|
||||
<category>Notifications</category>
|
||||
<summary>Удалить адрес для уведомлений</summary>
|
||||
<short>Удалить почтовый ящик с почтового сервера</short>
|
||||
<category>Уведомления</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailServer">
|
||||
<summary>
|
||||
Returns ServerData for mail server associated with tenant
|
||||
</summary>
|
||||
<returns>ServerData for current tenant.</returns>
|
||||
<short>Get mail server</short>
|
||||
<category>Servers</category>
|
||||
<summary>Возвращает параметр ServerData для почтового сервера, связанного с владельцем</summary>
|
||||
<returns>Параметр ServerData для текущего владельца.</returns>
|
||||
<short>Узнать почтовый сервер</short>
|
||||
<category>Серверы</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailServerFullInfo">
|
||||
<summary>
|
||||
Returns ServerData for mail server associated with tenant
|
||||
</summary>
|
||||
<returns>ServerData for current tenant.</returns>
|
||||
<short>Get mail server</short>
|
||||
<category>Servers</category>
|
||||
<summary>Возвращает параметр ServerData для почтового сервера, связанного с владельцем</summary>
|
||||
<returns>Параметр ServerData для текущего владельца.</returns>
|
||||
<short>Узнать почтовый сервер</short>
|
||||
<category>Серверы</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetUnusedDnsRecords">
|
||||
<summary>
|
||||
Get or generate free to any domain DNS records
|
||||
</summary>
|
||||
<returns>DNS records for current tenant and user.</returns>
|
||||
<short>Get free DNS records</short>
|
||||
<summary>Получить или создать записи DNS для бесплатного домена </summary>
|
||||
<returns>Записи DNS для текущего владельца и пользователя.</returns>
|
||||
<short>Получить бесплатно записи DNS</short>
|
||||
<category>DnsRecords</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetDomains">
|
||||
<summary>
|
||||
Returns list of the web domains associated with tenant
|
||||
</summary>
|
||||
<returns>List of WebDomainData for current tenant</returns>
|
||||
<short>Get tenant web domain list</short>
|
||||
<category>Domains</category>
|
||||
<summary>Возвращает список веб-доменов, связанных с владельцем</summary>
|
||||
<returns>Список параметров WebDomainData для текущего владельца</returns>
|
||||
<short>Получить список веб-доменов владельца</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetCommonDomain">
|
||||
<summary>
|
||||
Returns the common web domain
|
||||
</summary>
|
||||
<returns>WebDomainData for common web domain</returns>
|
||||
<short>Get common web domain</short>
|
||||
<category>Domains</category>
|
||||
<summary>Возвращает общий веб-домен</summary>
|
||||
<returns>WebDomainData для общего веб-домена</returns>
|
||||
<short>Узнать общий веб-домен</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddDomain(System.String,System.Int32)">
|
||||
<summary>
|
||||
Associate a web domain with tenant
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<summary>Связать веб-домен с владельцем</summary>
|
||||
<param name="name">имя веб-домена</param>
|
||||
<param name="id_dns"></param>
|
||||
<returns>WebDomainData associated with tenant</returns>
|
||||
<short>Add domain to mail server</short>
|
||||
<category>Domains</category>
|
||||
<returns>Параметр WebDomainData, связанный с владельцем</returns>
|
||||
<short>Добавить домен на почтовом сервере</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveDomain(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected web domain
|
||||
</summary>
|
||||
<param name="id">id of web domain</param>
|
||||
<returns>MailOperationResult object</returns>
|
||||
<short>Remove domain from mail server</short>
|
||||
<category>Domains</category>
|
||||
<summary>Удаляет выбранный веб-домен</summary>
|
||||
<param name="id">ИД веб-домена</param>
|
||||
<returns>Объект MailOperationResult</returns>
|
||||
<short>Удалить домен с почтового сервера</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetDnsRecords(System.Int32)">
|
||||
<summary>
|
||||
Returns dns records associated with domain
|
||||
</summary>
|
||||
<param name="id">id of domain</param>
|
||||
<returns>Dns records associated with domain</returns>
|
||||
<short>Returns dns records</short>
|
||||
<summary>Возвращает записи DNS, связанные с доменом</summary>
|
||||
<param name="id">ИД домена</param>
|
||||
<returns>Записи DNS, связанные с доменом</returns>
|
||||
<short>Возвращает записи DNS</short>
|
||||
<category>DnsRecords</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.IsDomainExists(System.String)">
|
||||
<summary>
|
||||
Check web domain name existance
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<returns>True if domain name already exists.</returns>
|
||||
<short>Is domain name exists.</short>
|
||||
<category>Domains</category>
|
||||
<summary>Проверить наличие имени веб-домена</summary>
|
||||
<param name="name">имя веб-домена</param>
|
||||
<returns>"True" указывает на то, что доменное имя уже существует.</returns>
|
||||
<short>Проверка наличия доменного имени.</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CheckDomainOwnership(System.String)">
|
||||
<summary>
|
||||
Check web domain name ownership over txt record in dns
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<returns>True if user is owner of this domain.</returns>
|
||||
<short>Check domain ownership.</short>
|
||||
<category>Domains</category>
|
||||
<summary>Узнать по текстовой записи в DNS, кому принадлежит имя веб-домена</summary>
|
||||
<param name="name">имя веб-домена</param>
|
||||
<returns>"True" указывает на то, что пользователь владеет этим доменом.</returns>
|
||||
<short>Проверить владельца домена.</short>
|
||||
<category>Домены</category>
|
||||
</member>
|
||||
<member name="P:ASC.Api.MailServer.MailServerApi.Name">
|
||||
<summary>
|
||||
Api name entry
|
||||
</summary>
|
||||
<summary>Запись названия API</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
@ -1,114 +1,70 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Portal</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Portal.PortalApi">
|
||||
<summary>
|
||||
Portal info access
|
||||
</summary>
|
||||
<summary>Доступ к сведениям о портале</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.Get">
|
||||
<summary>
|
||||
Returns the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Current portal
|
||||
</short>
|
||||
<returns>Portal</returns>
|
||||
<summary>Возвращает текущий портал</summary>
|
||||
<short>Текущий портал</short>
|
||||
<returns>Портал</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUser(System.Guid)">
|
||||
<summary>
|
||||
Returns the user with specified userID from the current portal
|
||||
</summary>
|
||||
<short>
|
||||
User with specified userID
|
||||
</short>
|
||||
<category>Users</category>
|
||||
<returns>User</returns>
|
||||
<summary>Возвращает пользователя с указанным ИД из текущего портала</summary>
|
||||
<short>Пользователь с указанным ИД</short>
|
||||
<category>Пользователи</category>
|
||||
<returns>Пользователь</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GeInviteLink(ASC.Core.Users.EmployeeType)">
|
||||
<summary>
|
||||
Returns invitational link to the portal
|
||||
</summary>
|
||||
<short>
|
||||
Returns invitational link to the portal
|
||||
</short>
|
||||
<param name="employeeType">
|
||||
User or Visitor
|
||||
</param>
|
||||
<category>Users</category>
|
||||
<returns>
|
||||
Invite link
|
||||
</returns>
|
||||
<summary>Возвращает пригласительную ссылку на портал</summary>
|
||||
<short>Возвращает пригласительную ссылку на портал</short>
|
||||
<param name="employeeType">Пользователь или гость</param>
|
||||
<category>Пользователи</category>
|
||||
<returns>Пригласительная ссылка</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetShortenLink(System.String)">
|
||||
<summary>
|
||||
Returns shorten link
|
||||
</summary>
|
||||
<param name="link">Link for shortening</param>
|
||||
<returns>link</returns>
|
||||
<summary>Возвращает сокращенную ссылку</summary>
|
||||
<param name="link">Ссылка для сокращения</param>
|
||||
<returns>ссылка</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUsedSpace">
|
||||
<summary>
|
||||
Returns the used space of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Used space of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Used space</returns>
|
||||
<summary>Возвращает используемое пространство текущего портала</summary>
|
||||
<short>Используемое пространство текущего портала</short>
|
||||
<category>Квота</category>
|
||||
<returns>Используемое пространство</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUsersCount">
|
||||
<summary>
|
||||
Returns the users count of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Users count of the current portal
|
||||
</short>
|
||||
<category>Users</category>
|
||||
<returns>Users count</returns>
|
||||
<summary>Возвращает число пользователей текущего портала</summary>
|
||||
<short>Число пользователей текущего портала</short>
|
||||
<category>Пользователи</category>
|
||||
<returns>Число пользователей</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetTariff">
|
||||
<summary>
|
||||
Returns the current tariff of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Tariff of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Tariff</returns>
|
||||
<summary>Возвращает текущий тариф текущего портала</summary>
|
||||
<short>Тариф текущего портала</short>
|
||||
<category>Квота</category>
|
||||
<returns>Тариф</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetQuota">
|
||||
<summary>
|
||||
Returns the current quota of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Quota of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Quota</returns>
|
||||
<summary>Возвращает текущую квоту текущего портала</summary>
|
||||
<short>Квота текущего портала</short>
|
||||
<category>Квота</category>
|
||||
<returns>Квота</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRightQuota">
|
||||
<summary>
|
||||
Returns the recommended quota of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Quota of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Quota</returns>
|
||||
<summary>Возвращает рекомендуемую квоту текущего портала</summary>
|
||||
<short>Квота текущего портала</short>
|
||||
<category>Квота</category>
|
||||
<returns>Квота</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetFullAbsolutePath(System.String)">
|
||||
<summary>
|
||||
Returns path
|
||||
</summary>
|
||||
<short>
|
||||
path
|
||||
</short>
|
||||
<returns>path</returns>
|
||||
<summary>Возвращает путь</summary>
|
||||
<short>путь</short>
|
||||
<returns>путь</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetMessageCount">
|
||||
@ -142,83 +98,63 @@
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupSchedule">
|
||||
<summary>
|
||||
Returns the backup schedule of the current portal
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup Schedule</returns>
|
||||
<summary>Возвращает расписание резервного копирования текущего портала</summary>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>Расписание резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.CreateBackupSchedule(ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Int32,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.CronParams,System.Boolean)">
|
||||
<summary>
|
||||
Create the backup schedule of the current portal
|
||||
</summary>
|
||||
<param name="storageType">Storage type</param>
|
||||
<param name="storageParams">Storage parameters</param>
|
||||
<param name="backupsStored">Max of the backup's stored copies</param>
|
||||
<param name="cronParams">Cron parameters</param>
|
||||
<param name="backupMail">Include mail in the backup</param>
|
||||
<category>Backup</category>
|
||||
<summary>Создать расписание резервного копирования текущего портала</summary>
|
||||
<param name="storageType">Тип хранилища</param>
|
||||
<param name="storageParams">Параметры хранилища</param>
|
||||
<param name="backupsStored">Максимальное количество сохраняемых резервных копий</param>
|
||||
<param name="cronParams">Параметры Cron</param>
|
||||
<param name="backupMail">Включить почту в резервную копию</param>
|
||||
<category>Резервное копирование</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupSchedule">
|
||||
<summary>
|
||||
Delete the backup schedule of the current portal
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<summary>Удалить расписание резервного копирования текущего портала</summary>
|
||||
<category>Резервное копирование</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.StartBackup(ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Boolean)">
|
||||
<summary>
|
||||
Start a backup of the current portal
|
||||
</summary>
|
||||
<param name="storageType">Storage Type</param>
|
||||
<param name="storageParams">Storage Params</param>
|
||||
<param name="backupMail">Include mail in the backup</param>
|
||||
<category>Backup</category>
|
||||
<returns>Backup Progress</returns>
|
||||
<summary>Начать резервное копирование текущего портала</summary>
|
||||
<param name="storageType">Тип хранилища</param>
|
||||
<param name="storageParams">Параметры хранилища</param>
|
||||
<param name="backupMail">Включить почту в резервную копию</param>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>Ход выполнения резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupProgress">
|
||||
<summary>
|
||||
Returns the progress of the started backup
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup Progress</returns>
|
||||
<summary>Возвращает ход выполнения начавшегося резервного копирования</summary>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>Ход выполнения резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupHistory">
|
||||
<summary>
|
||||
Returns the backup history of the started backup
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup History</returns>
|
||||
<summary>Возвращает историю начавшегося резервного копирования</summary>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>История резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackup(System.Guid)">
|
||||
<summary>
|
||||
Delete the backup with the specified id
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<summary>Удалить резервную копию с указанным ИД</summary>
|
||||
<category>Резервное копирование</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupHistory">
|
||||
<summary>
|
||||
Delete all backups of the current portal
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup History</returns>
|
||||
<summary>Удалить все резервные копии текущего портала</summary>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>История резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.StartBackupRestore(System.String,ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Boolean)">
|
||||
<summary>
|
||||
Start a data restore of the current portal
|
||||
</summary>
|
||||
<param name="backupId">Backup Id</param>
|
||||
<param name="storageType">Storage Type</param>
|
||||
<param name="storageParams">Storage Params</param>
|
||||
<param name="notify">Notify about backup to users</param>
|
||||
<category>Backup</category>
|
||||
<returns>Restore Progress</returns>
|
||||
<summary>Начать восстановление данных текущего портала</summary>
|
||||
<param name="backupId">ИД резервной копии</param>
|
||||
<param name="storageType">Тип хранилища</param>
|
||||
<param name="storageParams">Параметры хранилища</param>
|
||||
<param name="notify">Уведомлять других о резервном копировании</param>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>Ход выполнения восстановления</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRestoreProgress">
|
||||
<summary>
|
||||
Returns the progress of the started restore
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Restore Progress</returns>
|
||||
<summary>Возвращает ход выполнения начавшегося восстановления</summary>
|
||||
<category>Резервное копирование</category>
|
||||
<returns>Ход выполнения восстановления</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetTempPath(System.String)">
|
||||
<visible>false</visible>
|
||||
@ -257,16 +193,12 @@
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRandomPassword">
|
||||
<summary>
|
||||
Get random password
|
||||
</summary>
|
||||
<short>Get random password</short>
|
||||
<summary>Получить случайный пароль</summary>
|
||||
<short>Получить случайный пароль</short>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Portal.PortalApi.Name">
|
||||
<summary>
|
||||
Api name entry
|
||||
</summary>
|
||||
<summary>Запись названия API</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,302 +1,174 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Settings</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Settings.SettingsApi">
|
||||
<summary>
|
||||
Portal settings
|
||||
</summary>
|
||||
<summary>Настройки портала</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSmtpSettings">
|
||||
<summary>
|
||||
Returns current portal SMTP settings
|
||||
</summary>
|
||||
<short>
|
||||
Get SMTP settings
|
||||
</short>
|
||||
<returns>SmtpSettings data</returns>
|
||||
<summary>Возвращает настройки SMTP текущего портала</summary>
|
||||
<short>Получить настройки SMTP</short>
|
||||
<returns>Данные SmtpSettings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveSmtpSettings(ASC.Api.Settings.Smtp.SmtpSettingsWrapper)">
|
||||
<summary>
|
||||
Save SMTP settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Save SMTP settings
|
||||
</short>
|
||||
<param name="smtpSettings">SMTP settings data</param>
|
||||
<returns>SmtpSettings data</returns>
|
||||
<summary>Сохранить настройки SMTP для текущего портала</summary>
|
||||
<short>Сохранить настройки SMTP</short>
|
||||
<param name="smtpSettings">Данные настроек SMTP</param>
|
||||
<returns>Данные SmtpSettings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.ResetSmtpSettings">
|
||||
<summary>
|
||||
Reset SMTP settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Reset SMTP settings
|
||||
</short>
|
||||
<returns>SmtpSettings data</returns>
|
||||
<summary>Сброс настроек SMTP для текущего портала</summary>
|
||||
<short>Сбросить настройки SMTP</short>
|
||||
<returns>Данные SmtpSettings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TestSmtpSettings">
|
||||
<summary>
|
||||
Test SMTP settings for current portal (send test message to user email)
|
||||
</summary>
|
||||
<short>
|
||||
Test SMTP settings
|
||||
</short>
|
||||
<returns>SmtpOperationStatus data</returns>
|
||||
<summary>Проверить настройки SMTP для текущего портала (отправить тестовое сообщение по адресу электронной почты пользователя)</summary>
|
||||
<short>Проверить настройки SMTP</short>
|
||||
<returns>Данные SmtpOperationStatus</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSmtpOperationStatus">
|
||||
<summary>
|
||||
Returns SMTP test process status
|
||||
</summary>
|
||||
<short>
|
||||
Get SMTP test process status
|
||||
</short>
|
||||
<returns>SmtpOperationStatus object</returns>
|
||||
<summary>Возвращает статус процесса проверки SMTP</summary>
|
||||
<short>Получить статус процесса проверки SMTP</short>
|
||||
<returns>Объект SmtpOperationStatus</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2">
|
||||
<summary>
|
||||
Returns current portal SSO settings
|
||||
</summary>
|
||||
<short>
|
||||
Get SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
<summary>Возвращает текущие настройки SSO портала</summary>
|
||||
<short>Получить настройки SSO</short>
|
||||
<returns>Объект SsoSettingsV2</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetDefaultSsoSettingsV2">
|
||||
<summary>
|
||||
Returns default portal SSO settings
|
||||
</summary>
|
||||
<short>
|
||||
Get default SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
<summary>Возвращает настройки SSO по умолчанию для портала</summary>
|
||||
<short>Получить настройки SSO по умолчанию</short>
|
||||
<returns>Объект SsoSettingsV2</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2Constants">
|
||||
<summary>
|
||||
Returns SSO settings constants
|
||||
</summary>
|
||||
<short>
|
||||
Get SSO settings constants
|
||||
</short>
|
||||
<returns>object</returns>
|
||||
<summary>Возвращает константы настроек SSO</summary>
|
||||
<short>Получить константы настроек SSO</short>
|
||||
<returns>объект</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveSsoSettingsV2(System.String)">
|
||||
<summary>
|
||||
Save SSO settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Save SSO settings
|
||||
</short>
|
||||
<param name="serializeSettings">serialized SsoSettingsV2 object</param>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
<summary>Сохранить настройки SSO для текущего портала</summary>
|
||||
<short>Сохранить настройки SSO</short>
|
||||
<param name="serializeSettings">сериализованный объект SsoSettingsV2</param>
|
||||
<returns>Объект SsoSettingsV2</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.ResetSsoSettingsV2">
|
||||
<summary>
|
||||
Reset SSO settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Reset SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
<summary>Сброс настроек SSO для текущего портала</summary>
|
||||
<short>Сброс настроек SSO</short>
|
||||
<returns>Объект SsoSettingsV2</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapSettings">
|
||||
<summary>
|
||||
Returns current portal LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP settings
|
||||
</short>
|
||||
<returns>LDAPSupportSettings object</returns>
|
||||
<summary>Возвращает настройки LDAP текущего портала</summary>
|
||||
<short>Получить настройки LDAP</short>
|
||||
<returns>Объект LDAPSupportSettings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapCronSettings">
|
||||
<summary>
|
||||
Returns current portal LDAP AutoSync cron expression if any
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP AutoSync Cron expression
|
||||
</short>
|
||||
<returns>string or null</returns>
|
||||
<summary>Возвращает выражение Cron для автоматической синхронизации LDAP текущего портала, если оно имеется</summary>
|
||||
<short>Получить выражение Cron для LDAP AutoSync</short>
|
||||
<returns>строка или пустое значение</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetLdapCronSettings(System.String)">
|
||||
<summary>
|
||||
Sets current portal LDAP AutoSync cron expression
|
||||
</summary>
|
||||
<short>
|
||||
Sets LDAP AutoSync Cron expression
|
||||
</short>
|
||||
<summary>Задает выражение Cron для автоматической синхронизации LDAP текущего портала</summary>
|
||||
<short>Задать выражение Cron для LDAP AutoSync</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SyncLdap">
|
||||
<summary>
|
||||
Start sync users and groups process by LDAP
|
||||
</summary>
|
||||
<short>
|
||||
Sync LDAP
|
||||
</short>
|
||||
<summary>Начать синхронизировать процессы пользователей и групп согласно LDAP</summary>
|
||||
<short>Синхронизировать LDAP</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TestLdapSync">
|
||||
<summary>
|
||||
Starts the process of collecting preliminary changes on the portal according to the selected LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Sync LDAP
|
||||
</short>
|
||||
<summary>Запускает процесс сбора предварительных изменений на портале согласно выбранным настройкам LDAP</summary>
|
||||
<short>Синхронизировать LDAP</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveLdapSettings(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Save LDAP settings and start import/sync users and groups process by LDAP
|
||||
</summary>
|
||||
<short>
|
||||
Save LDAP settings
|
||||
</short>
|
||||
<param name="settings">LDAPSupportSettings serialized string</param>
|
||||
<param name="acceptCertificate">Flag permits errors of checking certificates</param>
|
||||
<summary>Сохранить настройки LDAP и начать импорт/синхронизацию процессов пользователей и групп согласно LDAP</summary>
|
||||
<short>Сохранить настройки LDAP</short>
|
||||
<param name="settings">Сериализованная строка LDAPSupportSettings</param>
|
||||
<param name="acceptCertificate">Флаг разрешает ошибки при проверке сертификатов</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TestLdapSave(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Starts the process of collecting preliminary changes on the portal according to the LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Save LDAP settings
|
||||
</short>
|
||||
<summary>Начинает процесс сбора предварительных изменений на портале согласно настройкам LDAP</summary>
|
||||
<short>Сохранить настройки LDAP</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapOperationStatus">
|
||||
<summary>
|
||||
Returns LDAP sync process status
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP sync process status
|
||||
</short>
|
||||
<returns>LDAPSupportSettingsResult object</returns>
|
||||
<summary>Возвращает статус процесса синхронизации LDAP</summary>
|
||||
<short>Получить статус процесса синхронизации LDAP</short>
|
||||
<returns>Объект LDAPSupportSettingsResult</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetDefaultLdapSettings">
|
||||
<summary>
|
||||
Returns LDAP default settings
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP default settings
|
||||
</short>
|
||||
<returns>LDAPSupportSettings object</returns>
|
||||
<summary>Возвращает настройки LDAP по умолчанию</summary>
|
||||
<short>Получить настройки LDAP по умолчанию</short>
|
||||
<returns>Объект LDAPSupportSettings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSettings">
|
||||
<summary>
|
||||
Returns the list of all available portal settings with the current values for each one
|
||||
</summary>
|
||||
<short>
|
||||
Portal settings
|
||||
</short>
|
||||
<returns>Settings</returns>
|
||||
<summary>Возвращает список всех имеющихся настроек портала с текущими значениями каждой настройки</summary>
|
||||
<short>Настройки портала</short>
|
||||
<returns>Настройки</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetQuotaUsed">
|
||||
<summary>
|
||||
Returns space usage quota for portal with the space usage of each module
|
||||
</summary>
|
||||
<short>
|
||||
Space usage
|
||||
</short>
|
||||
<returns>Space usage and limits for upload</returns>
|
||||
<summary>Возвращает квоту использования пространства для портала и сведения об использовании пространства каждого модуля</summary>
|
||||
<short>Использование пространства</short>
|
||||
<returns>Использование пространства и ограничения для загрузки на серверы</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.RecalculateQuota">
|
||||
<summary>
|
||||
Start Recalculate Quota Task
|
||||
</summary>
|
||||
<short>
|
||||
Recalculate Quota
|
||||
</short>
|
||||
<summary>Запустить задачу пересчета квоты</summary>
|
||||
<short>Пересчитать квоту</short>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CheckRecalculateQuota">
|
||||
<summary>
|
||||
Check Recalculate Quota Task
|
||||
</summary>
|
||||
<short>
|
||||
Check Recalculate Quota Task
|
||||
</short>
|
||||
<returns>Check Recalculate Quota Task Status</returns>
|
||||
<summary>Проверить задачу пересчета квоты</summary>
|
||||
<short>Проверить задачу пересчета квоты</short>
|
||||
<returns>Статус проверки задачи пересчета квоты</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetBuildVersions">
|
||||
<summary>
|
||||
Get build version
|
||||
</summary>
|
||||
<summary>Получить версию сборки</summary>
|
||||
<visible>false</visible>
|
||||
<returns>Current onlyoffice, editor, mailserver versions</returns>
|
||||
<returns>Текущие версии сервера совместной работы, редактора и почтового сервера</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetVersions">
|
||||
<summary>
|
||||
Get list of availibe portal versions including current version
|
||||
</summary>
|
||||
<short>
|
||||
Portal versions
|
||||
</short>
|
||||
<summary>Получить список доступных версий портала, включая текущую версию</summary>
|
||||
<short>Версии портал</short>
|
||||
<visible>false</visible>
|
||||
<returns>List of availibe portal versions including current version</returns>
|
||||
<returns>Список доступных версий портала, включая текущую версию</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetVersion(System.Int32)">
|
||||
<summary>
|
||||
Set current portal version to the one with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Change portal version
|
||||
</short>
|
||||
<param name="versionId">Version ID</param>
|
||||
<summary>Выбрать версию с указанным в запросе ИД в качестве текущей версии портала</summary>
|
||||
<short>Изменить версию портала</short>
|
||||
<param name="versionId">ИД версии</param>
|
||||
<visible>false</visible>
|
||||
<returns>List of availibe portal versions including current version</returns>
|
||||
<returns>Список доступных версий портала, включая текущую версию</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetWebItemSecurityInfo(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Returns security settings about product, module or addons
|
||||
</summary>
|
||||
<short>
|
||||
Get security settings
|
||||
</short>
|
||||
<param name="ids">Module ID list</param>
|
||||
<summary>Возвращает настройки безопасности продукта, модуля или надстроек</summary>
|
||||
<short>Получить настройки безопасности</short>
|
||||
<param name="ids">Список ИД модулей</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetEnabledModules">
|
||||
<summary>
|
||||
Return list of enabled modules
|
||||
</summary>
|
||||
<short>
|
||||
Enabled modules
|
||||
</short>
|
||||
<summary>Возвращает список включенных модулей</summary>
|
||||
<short>Включенные модули</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetPasswordSettings">
|
||||
<summary>
|
||||
Get portal password settings
|
||||
</summary>
|
||||
<short>
|
||||
Password settings
|
||||
</short>
|
||||
<summary>Получить настройки пароля портала</summary>
|
||||
<short>Настройки пароля</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetWebItemSecurity(System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Set security settings for product, module or addons
|
||||
</summary>
|
||||
<short>
|
||||
Set security settings
|
||||
</short>
|
||||
<param name="id">Module ID</param>
|
||||
<param name="enabled">Enabled</param>
|
||||
<param name="subjects">User (Group) ID list</param>
|
||||
<summary>Задать настройки безопасности продукта, модуля или надстроек</summary>
|
||||
<short>Задать настройки безопасности</short>
|
||||
<param name="id">ИД модуля</param>
|
||||
<param name="enabled">Включен</param>
|
||||
<param name="subjects">Список ИД пользователей (групп)</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetAccessToWebItems(System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.Boolean}})">
|
||||
<summary>
|
||||
Set access to products, modules or addons
|
||||
</summary>
|
||||
<short>
|
||||
Set access
|
||||
</short>
|
||||
<summary>Определяет доступ к продуктам, модулям или надстройкам</summary>
|
||||
<short>Задать доступ</short>
|
||||
<param name="items"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLogo">
|
||||
<summary>
|
||||
Get portal logo image URL
|
||||
</summary>
|
||||
<short>
|
||||
Portal logo
|
||||
</short>
|
||||
<returns>Portal logo image URL</returns>
|
||||
<summary>Получить URL-адрес изображения для логотипа портала</summary>
|
||||
<short>Логотип портала</short>
|
||||
<returns>URL-адрес изображения для логотипа портала</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveWhiteLabelSettings(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}})">
|
||||
<visible>false</visible>
|
||||
@ -317,66 +189,48 @@
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetIpRestrictions">
|
||||
<summary>
|
||||
Get portal ip restrictions
|
||||
</summary>
|
||||
<summary>Получить ограничения IP-адресов портала</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveIpRestrictions(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
save new portal ip restrictions
|
||||
</summary>
|
||||
<param name="ips">ip restrictions</param>
|
||||
<summary>сохранить новые ограничения IP-адресов портала</summary>
|
||||
<param name="ips">ограничения IP-адресов</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateIpRestrictionsSettings(System.Boolean)">
|
||||
<summary>
|
||||
update ip restrictions settings
|
||||
</summary>
|
||||
<param name="enable">enable ip restrictions settings</param>
|
||||
<summary>обновить настройки ограничений IP-адресов</summary>
|
||||
<param name="enable">включить настройки ограничений IP-адресов</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSettings(System.Boolean)">
|
||||
<summary>
|
||||
update tips settings
|
||||
</summary>
|
||||
<param name="show">show tips for user</param>
|
||||
<summary>обновить настройки советов</summary>
|
||||
<param name="show">показывать пользователю советы</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSubscription">
|
||||
<summary>
|
||||
change tips&tricks subscription
|
||||
</summary>
|
||||
<returns>subscription state</returns>
|
||||
<summary>изменить подписку на советы и приемы</summary>
|
||||
<returns>состояние подписки</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CompleteWizard">
|
||||
<summary>
|
||||
Complete Wizard
|
||||
</summary>
|
||||
<summary>Завершить работу мастера</summary>
|
||||
<returns>WizardSettings</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TfaSettings(System.String)">
|
||||
<summary>
|
||||
Update two-factor authentication settings
|
||||
</summary>
|
||||
<param name="type">sms, app or none</param>
|
||||
<returns>true if success</returns>
|
||||
<summary>Обновить настройки двухфакторной аутентификации</summary>
|
||||
<param name="type">SMS, приложение или отсутствуют</param>
|
||||
<returns>true в случае успеха</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppGetCodes">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppRequestNewCodes">
|
||||
<summary>
|
||||
Requests new backup codes for two-factor application
|
||||
</summary>
|
||||
<returns>New backup codes</returns>
|
||||
<summary>Запрашивает новые коды резервного копирования для приложения с двухфакторной аутентификацией</summary>
|
||||
<returns>Новые коды резервного копирования</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppNewApp(System.Guid)">
|
||||
<summary>
|
||||
Unlinks current two-factor auth application
|
||||
</summary>
|
||||
<returns>Login url</returns>
|
||||
<summary>Отвязывает текущее приложение с двухфакторной аутентификацией</summary>
|
||||
<returns>URL-адрес логина</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CloseWelcomePopup">
|
||||
<visible>false</visible>
|
||||
@ -391,103 +245,73 @@
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.RefreshLicense">
|
||||
<summary>
|
||||
Refresh license
|
||||
</summary>
|
||||
<summary>Обновить лицензию</summary>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItems">
|
||||
<summary>
|
||||
Get Custom Navigation Items
|
||||
</summary>
|
||||
<returns>CustomNavigationItem List</returns>
|
||||
<summary>Получить настраиваемые элементы навигации</summary>
|
||||
<returns>Список CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItemSample">
|
||||
<summary>
|
||||
Get Custom Navigation Items Sample
|
||||
</summary>
|
||||
<returns>CustomNavigationItem Sample</returns>
|
||||
<summary>Получить пример настраиваемых элементов навигации</summary>
|
||||
<returns>Пример CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItem(System.Guid)">
|
||||
<summary>
|
||||
Get Custom Navigation Item by Id
|
||||
</summary>
|
||||
<param name="id">Item id</param>
|
||||
<summary>Получить настраиваемый элемент навигации по ИД</summary>
|
||||
<param name="id">ИД элемента</param>
|
||||
<returns>CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CreateCustomNavigationItem(ASC.Web.Studio.Core.CustomNavigationItem)">
|
||||
<summary>
|
||||
Add Custom Navigation Item
|
||||
</summary>
|
||||
<param name="item">Item</param>
|
||||
<summary>Добавить настраиваемый элементы навигации</summary>
|
||||
<param name="item">Элемент</param>
|
||||
<returns>CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.DeleteCustomNavigationItem(System.Guid)">
|
||||
<summary>
|
||||
Delete Custom Navigation Item by Id
|
||||
</summary>
|
||||
<param name="id">Item id</param>
|
||||
<summary>Удалить настраиваемый элемент навигации по ИД</summary>
|
||||
<param name="id">ИД элемента</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateEmailActivationSettings(System.Boolean)">
|
||||
<summary>
|
||||
update email activation settings
|
||||
</summary>
|
||||
<param name="show">show email activation panel for user</param>
|
||||
<summary>обновить настройки активации по электронной почте</summary>
|
||||
<param name="show">показать панель активации пользователя по электронной почте</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCompanyWhiteLabelSettings">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSpaceUsageStatistics(System.Guid)">
|
||||
<summary>
|
||||
Get WebItem Space Usage Statistics
|
||||
</summary>
|
||||
<param name="id">WebItem id</param>
|
||||
<returns>UsageSpaceStatItemWrapper List</returns>
|
||||
<summary>Получить статистику использования пространства WebItem</summary>
|
||||
<param name="id">ИД WebItem</param>
|
||||
<returns>Список UsageSpaceStatItemWrapper</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetVisitStatistics(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
|
||||
<summary>
|
||||
Get User Visit Statistics
|
||||
</summary>
|
||||
<param name="fromDate">From Date</param>
|
||||
<param name="toDate">To Date</param>
|
||||
<returns>ChartPointWrapper List</returns>
|
||||
<summary>Получить статистику посещений пользователя</summary>
|
||||
<param name="fromDate">Начальная дата</param>
|
||||
<param name="toDate">Конечная дата</param>
|
||||
<returns>Список ChartPointWrapper</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetAllStorages">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetStorageProgress">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateStorage(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}})">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetAllCdnStorages">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateCdn(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}})">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetAllBackupStorages">
|
||||
<summary>
|
||||
Get Storage
|
||||
</summary>
|
||||
<returns>Consumer</returns>
|
||||
<summary>Получить хранилище</summary>
|
||||
<returns>Получатель</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
@ -1,112 +1,82 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Specific</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint">
|
||||
<summary>
|
||||
Authorization for api
|
||||
</summary>
|
||||
<summary>Авторизация для API</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Gets authentication token for use in api authorization
|
||||
</summary>
|
||||
<short>
|
||||
Get token
|
||||
</short>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<returns>tokent to use in 'Authorization' header when calling API methods</returns>
|
||||
<exception cref="T:System.Security.Authentication.AuthenticationException">Thrown when not authenticated</exception>
|
||||
<summary>Получает токен аутентификации для использования при авторизации API</summary>
|
||||
<short>Получить токен</short>
|
||||
<param name="userName">имя пользователя или адрес эл. почты</param>
|
||||
<param name="password">пароль</param>
|
||||
<param name="provider">тип поставщика услуг социальных сетей</param>
|
||||
<param name="accessToken">токен поставщика</param>
|
||||
<returns>токен, применяемый в заголовке "Авторизация" при вызове методов API</returns>
|
||||
<exception cref="T:System.Security.Authentication.AuthenticationException">Появляется при отсутствии аутентификации</exception>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SaveMobilePhone(System.String,System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Set mobile phone for user
|
||||
</summary>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<param name="mobilePhone">new mobile phone</param>
|
||||
<returns>mobile phone</returns>
|
||||
<summary>Задать мобильный телефон для пользователя</summary>
|
||||
<param name="userName">имя пользователя или адрес эл. почты</param>
|
||||
<param name="password">пароль</param>
|
||||
<param name="provider">тип поставщика услуг социальных сетей</param>
|
||||
<param name="accessToken">токен поставщика</param>
|
||||
<param name="mobilePhone">новый мобильный телефон</param>
|
||||
<returns>мобильный телефон</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SendSmsCode(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Send sms code again
|
||||
</summary>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<returns>mobile phone</returns>
|
||||
<summary>Снова отправить код по СМС</summary>
|
||||
<param name="userName">имя пользователя или адрес эл. почты</param>
|
||||
<param name="password">Пароль</param>
|
||||
<param name="provider">тип поставщика услуг социальных сетей</param>
|
||||
<param name="accessToken">токен поставщика</param>
|
||||
<returns>мобильный телефон</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Gets two-factor authentication token for use in api authorization
|
||||
</summary>
|
||||
<short>
|
||||
Get token
|
||||
</short>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<param name="code">sms code</param>
|
||||
<returns>tokent to use in 'Authorization' header when calling API methods</returns>
|
||||
<summary>Получить токен двухфакторной аутентификации для использования при авторизации API</summary>
|
||||
<short>Получить токен</short>
|
||||
<param name="userName">имя пользователя или адрес эл. почты</param>
|
||||
<param name="password">пароль</param>
|
||||
<param name="provider">тип поставщика услуг социальных сетей</param>
|
||||
<param name="accessToken">токен поставщика</param>
|
||||
<param name="code">код из СМС</param>
|
||||
<returns>токен, применяемый в заголовке "Авторизация" при вызове методов API</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.RegisterUserOnPersonal(System.String,System.String,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Request of invitation by email on personal.onlyoffice.com
|
||||
</summary>
|
||||
<param name="email">Email address</param>
|
||||
<param name="lang">Culture</param>
|
||||
<param name="spam">User consent to subscribe to the ONLYOFFICE newsletter</param>
|
||||
<param name="analytics">Track analytics</param>
|
||||
<summary>Запрос по электронной почте приглашения посетить personal.onlyoffice.com</summary>
|
||||
<param name="email">Адрес эл. почты</param>
|
||||
<param name="lang">Культура</param>
|
||||
<param name="spam">Согласие пользователя подписаться на рассылку новостей</param>
|
||||
<param name="analytics">Отслеживать аналитику</param>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Check userName and password
|
||||
</summary>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<summary>Проверить имя пользователя и пароль</summary>
|
||||
<param name="userName">имя пользователя или адрес эл. почты</param>
|
||||
<param name="password">Пароль</param>
|
||||
<param name="key"></param>
|
||||
<exception cref="T:System.Security.Authentication.AuthenticationException">Thrown when not authenticated</exception>
|
||||
<exception cref="T:System.Security.Authentication.AuthenticationException">Появляется при отсутствии аутентификации</exception>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="P:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.Name">
|
||||
<summary>
|
||||
Entry point name
|
||||
</summary>
|
||||
<summary>Название точки входа</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint">
|
||||
<summary>
|
||||
Capabilities for api
|
||||
</summary>
|
||||
<summary>Возможности для API</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.#ctor(ASC.Api.Impl.ApiContext)">
|
||||
<summary>
|
||||
Constructor
|
||||
</summary>
|
||||
<summary>Конструктор</summary>
|
||||
<param name="context"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.GetPortalCapabilities">
|
||||
<summary>
|
||||
Returns the information about portal capabilities
|
||||
</summary>
|
||||
<short>
|
||||
Get portal capabilities
|
||||
</short>
|
||||
<summary>Возвращает сведения о возможностях портала</summary>
|
||||
<short>Получить возможности портала</short>
|
||||
<returns>CapabilitiesData</returns>
|
||||
</member>
|
||||
<member name="P:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.Name">
|
||||
<summary>
|
||||
Entry point name
|
||||
</summary>
|
||||
<summary>Название точки входа</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
</doc>
|
||||
@ -27,7 +27,7 @@
|
||||
<ul class="dropdown-content">
|
||||
<li id="navitem_apieditors"><a class="dropdown-item" href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/basic.aspx")%>">Сервер документов</a></li>
|
||||
<li id="navitem_plugins"><a class="dropdown-item" href="<%=VirtualPathUtility.ToAbsolute("~/api/plugins/index.aspx")%>">Плагины</a></li>
|
||||
<li id="navitem_portals"><a class="dropdown-item" href="<%=VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx")%>">Р7-Офис. Сервер</a></li>
|
||||
<li id="navitem_portals"><a class="dropdown-item" href="<%=VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx")%>">Сервер совместной работы</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</li><!--
|
||||
|
||||
@ -26,131 +26,131 @@
|
||||
|
||||
<pre>
|
||||
config = {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"info": {
|
||||
"author": "Иван Петров",
|
||||
"created": "2010-07-07 3:46 PM",
|
||||
"folder": "Примеры файлов",
|
||||
"sharingSettings": [
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"info": {
|
||||
"author": "Иван Петров",
|
||||
"created": "2010-07-07 3:46 PM",
|
||||
"folder": "Примеры файлов",
|
||||
"sharingSettings": [
|
||||
{
|
||||
"permissions": "Полный доступ",
|
||||
"user": "Иван Петров"
|
||||
"permissions": "Полный доступ",
|
||||
"user": "Иван Петров"
|
||||
},
|
||||
{
|
||||
"permissions": "Только для чтения",
|
||||
"user": "Елена Иванова"
|
||||
"permissions": "Только для чтения",
|
||||
"user": "Елена Иванова"
|
||||
},
|
||||
...
|
||||
]
|
||||
},
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"permissions": {
|
||||
"comment": true,
|
||||
"download": true,
|
||||
"edit": true,
|
||||
"fillForms": true,
|
||||
"print": true,
|
||||
"review": true
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"permissions": {
|
||||
"comment": true,
|
||||
"download": true,
|
||||
"edit": true,
|
||||
"fillForms": true,
|
||||
"print": true,
|
||||
"review": true
|
||||
},
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx",
|
||||
"createUrl": "https://example.com/url-to-create-document/",
|
||||
"customization": {
|
||||
"autosave": true,
|
||||
"chat": true,
|
||||
"commentAuthorOnly": false,
|
||||
"compactToolbar": false,
|
||||
"customer": {
|
||||
"address": "Мой город, 123-45",
|
||||
"info": "Дополнительная информация",
|
||||
"logo": "https://example.com/logo-big.png",
|
||||
"mail": "john@example.com",
|
||||
"name": "Иван Петров и сыновья.",
|
||||
"www": "example.com"
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx",
|
||||
"createUrl": "https://example.com/url-to-create-document/",
|
||||
"customization": {
|
||||
"autosave": true,
|
||||
"chat": true,
|
||||
"commentAuthorOnly": false,
|
||||
"compactToolbar": false,
|
||||
"customer": {
|
||||
"address": "Мой город, 123-45",
|
||||
"info": "Дополнительная информация",
|
||||
"logo": "https://example.com/logo-big.png",
|
||||
"mail": "john@example.com",
|
||||
"name": "Иван Петров и сыновья.",
|
||||
"www": "example.com"
|
||||
},
|
||||
"feedback": {
|
||||
"url": "https://example.com",
|
||||
"visible": true
|
||||
"feedback": {
|
||||
"url": "https://example.com",
|
||||
"visible": true
|
||||
},
|
||||
"forcesave": false,
|
||||
"goback": {
|
||||
"blank": true,
|
||||
"text": "Вернуться к документам",
|
||||
"url": "https://example.com"
|
||||
"forcesave": false,
|
||||
"goback": {
|
||||
"blank": true,
|
||||
"text": "Вернуться к документам",
|
||||
"url": "https://example.com"
|
||||
},
|
||||
"help": true,
|
||||
"logo": {
|
||||
"image": "https://example.com/logo.png",
|
||||
"imageEmbedded": "https://example.com/logo_em.png",
|
||||
"url": "https://example.com"
|
||||
"help": true,
|
||||
"logo": {
|
||||
"image": "https://example.com/logo.png",
|
||||
"imageEmbedded": "https://example.com/logo_em.png",
|
||||
"url": "https://example.com"
|
||||
},
|
||||
"showReviewChanges": false,
|
||||
"zoom": 100
|
||||
"showReviewChanges": false,
|
||||
"zoom": 100
|
||||
},
|
||||
"embedded": {
|
||||
"embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
|
||||
"fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
|
||||
"saveUrl": "https://example.com/download?doc=exampledocument1.docx",
|
||||
"shareUrl": "https://example.com/view?doc=exampledocument1.docx",
|
||||
"toolbarDocked": "top"
|
||||
"embedded": {
|
||||
"embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
|
||||
"fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
|
||||
"saveUrl": "https://example.com/download?doc=exampledocument1.docx",
|
||||
"shareUrl": "https://example.com/view?doc=exampledocument1.docx",
|
||||
"toolbarDocked": "top"
|
||||
},
|
||||
"lang": "ru-RU",
|
||||
"mode": "edit",
|
||||
"plugins": {
|
||||
"autostart": [
|
||||
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
|
||||
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
|
||||
"lang": "ru-RU",
|
||||
"mode": "edit",
|
||||
"plugins": {
|
||||
"autostart": [
|
||||
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
|
||||
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
|
||||
...
|
||||
],
|
||||
"pluginsData": [
|
||||
"https://example.com/plugin1/config.json",
|
||||
"https://example.com/plugin2/config.json",
|
||||
"pluginsData": [
|
||||
"https://example.com/plugin1/config.json",
|
||||
"https://example.com/plugin2/config.json",
|
||||
...
|
||||
]
|
||||
},
|
||||
"recent": [
|
||||
"recent": [
|
||||
{
|
||||
"folder": "Примеры файлов",
|
||||
"title": "exampledocument1.docx",
|
||||
"url": "https://example.com/exampledocument1.docx"
|
||||
"folder": "Примеры файлов",
|
||||
"title": "exampledocument1.docx",
|
||||
"url": "https://example.com/exampledocument1.docx"
|
||||
},
|
||||
{
|
||||
"folder": "Примеры файлов",
|
||||
"title": "exampledocument2.docx",
|
||||
"url": "https://example.com/exampledocument2.docx"
|
||||
"folder": "Примеры файлов",
|
||||
"title": "exampledocument2.docx",
|
||||
"url": "https://example.com/exampledocument2.docx"
|
||||
},
|
||||
...
|
||||
],
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
}
|
||||
},
|
||||
"events": {
|
||||
"onAppReady": onAppReady,
|
||||
"onCollaborativeChanges": onCollaborativeChanges,
|
||||
"onDocumentReady": onDocumentReady,
|
||||
"onDocumentStateChange": onDocumentStateChange,
|
||||
"onDownloadAs": onDownloadAs,
|
||||
"onError": onError,
|
||||
"onInfo": onInfo,
|
||||
"onOutdatedVersion": onOutdatedVersion,
|
||||
"onRequestClose": onRequestClose,
|
||||
"onRequestEditRights": onRequestEditRights,
|
||||
"onRequestHistory": onRequestHistory,
|
||||
"onRequestHistoryClose": onRequestHistoryClose,
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
"onWarning": onWarning
|
||||
"events": {
|
||||
"onAppReady": onAppReady,
|
||||
"onCollaborativeChanges": onCollaborativeChanges,
|
||||
"onDocumentReady": onDocumentReady,
|
||||
"onDocumentStateChange": onDocumentStateChange,
|
||||
"onDownloadAs": onDownloadAs,
|
||||
"onError": onError,
|
||||
"onInfo": onInfo,
|
||||
"onOutdatedVersion": onOutdatedVersion,
|
||||
"onRequestClose": onRequestClose,
|
||||
"onRequestEditRights": onRequestEditRights,
|
||||
"onRequestHistory": onRequestHistory,
|
||||
"onRequestHistoryClose": onRequestHistoryClose,
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
"onWarning": onWarning
|
||||
},
|
||||
"height": "100%",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
|
||||
"type": "desktop",
|
||||
"width": "100%"
|
||||
"height": "100%",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
|
||||
"type": "desktop",
|
||||
"width": "100%"
|
||||
};
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
|
||||
@ -18,29 +18,29 @@
|
||||
<p>Целевой HTML файл, в который должны быть встроены редакторы, должен иметь тег-заполнитель <em>div</em>, в который будет передана вся информация о редакторе:</p>
|
||||
|
||||
<pre>
|
||||
<div id="placeholder"></div>
|
||||
<script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script>
|
||||
<div id="placeholder"></div>
|
||||
<script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script>
|
||||
</pre>
|
||||
|
||||
<p>Код страницы, содержащий изменяемые параметры выглядит следующим образом:</p>
|
||||
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", config);
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", config);
|
||||
</pre>
|
||||
|
||||
<p>Где <em>config</em> - это объект:</p>
|
||||
|
||||
<pre>
|
||||
config = {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx"
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx"
|
||||
}
|
||||
};
|
||||
</pre>
|
||||
@ -48,8 +48,6 @@ config = {
|
||||
|
||||
<p>Теперь объект <i>docEditor</i> может быть использован, чтобы вызывать <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx")%>">методы</a> <b>редактора документов</b>.</p>
|
||||
|
||||
<p>Вышеописанный пример включает все параметры, необходимые для корректного запуска Сервера Документов. Существуют также дополнительные необязательные параметры, которые могут быть изменены, чтобы добиться различных результатов, при работе с вашим документом (изменить права доступа к документу, отобразить иную информацию о документе, и т.д.) Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/advanced.aspx")%>">Расширенные параметры</a>, чтобы узнать, что означают эти параметры и как вы можете изменять их.</p>
|
||||
<p>Вышеописанный пример включает все параметры, необходимые для корректного запуска Сервера документов. Существуют также дополнительные необязательные параметры, которые могут быть изменены, чтобы добиться различных результатов, при работе с вашим документом (изменить права доступа к документу, отобразить иную информацию о документе, и т.д.) Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/advanced.aspx")%>">Расширенные параметры</a>, чтобы узнать, что означают эти параметры и как вы можете изменять их.</p>
|
||||
|
||||
<h2>Поддержка</h2>
|
||||
<p>Вы можете задать вопрос нашим разработчикам по адресу <a href="http://dev.onlyoffice.org/viewforum.php?f=9" target="_blank">dev.onlyoffice.org</a> (необходима регистрация).</p>
|
||||
</div>
|
||||
|
||||
@ -7,31 +7,31 @@
|
||||
</script>
|
||||
<div class="MainHelpCenter">
|
||||
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Совместное редактирование</h1>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс совместного редактирования на Сервере документов.</p><img alt="Совместное редактирование" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/coedit.jpg")%>" /><ol>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс совместного редактирования на Сервере документов.</p><ol>
|
||||
<li>Пользователь 1 и пользователь 2 открывают один и тот же документ в <b>редакторе документов</b>, то есть, когда файл открывается несколькими пользователями, используется один и тот же <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document.aspx#key")%>">ключ документа</a>.</li>
|
||||
<li>Пользователь 1 изменяет открытый документ.</li>
|
||||
<li><b>Редактор документов</b> отправляет изменения, сделанные пользователем 1 <b>сервису редактирования документов</b>.</li>
|
||||
<li><b>Сервис редактирования документов</b> отправляет изменения, сделанные пользователем 1 <b>редактору документов</b> пользователя 2.</li>
|
||||
<li>С этого момента изменения становятся видимыми для пользователя 2.</li>
|
||||
</ol><img alt="Совместное редактирование" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/coedit-view.png")%>" /><h2 id="apply" class="copy-link">Как это возможно сделать на практике</h2>
|
||||
</ol><h2 id="apply" class="copy-link">Как это возможно сделать на практике</h2>
|
||||
<ol>
|
||||
<li>Создайте пустой <em>html</em> файл.</li>
|
||||
<li>Добавьте <em>div</em> элемент, как показано ниже.<pre><div id="placeholder"></div></pre>
|
||||
<li>Добавьте <em>div</em> элемент, как показано ниже.<pre><div id="placeholder"></div></pre>
|
||||
</li>
|
||||
<li>Свяжите ссылку на ваш Сервер документов, которая будет использоваться на вашем сайте с JavaScript API.<pre><script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script></pre>Где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов.</li>
|
||||
<li>Свяжите ссылку на ваш Сервер документов, которая будет использоваться на вашем сайте с JavaScript API.<pre><script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script></pre>Где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов.</li>
|
||||
<li>Добавьте скрипт инициализации <b>Редактора документов</b> для <em>div</em> элемента с конфигурацией документа, который вы хотите открыть.<pre>
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
}
|
||||
}
|
||||
});
|
||||
@ -39,18 +39,18 @@ new DocsAPI.DocEditor("placeholder", {
|
||||
<li>Откройте ваш <em>html</em> файл в браузере.</li>
|
||||
<li>Теперь сделайте копию созданного вами <em>html</em> документа.</li>
|
||||
<li>Измените скрипт инициализации <b>Редактора Документов</b> в скопированном <em>html</em> файле.<pre>
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
@ -64,26 +64,26 @@
|
||||
<div id="drop" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для отключения пользователя с идентификатором <em>6d5a81d0</em> от сервиса редактирования документов.</div>
|
||||
<pre>
|
||||
{
|
||||
"c": "drop",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"users": [ "6d5a81d0" ]
|
||||
"c": "drop",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"users": [ "6d5a81d0" ]
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="forcesave" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для принудительного сохранения редактируемого документа с идентификатором <em>6d5a81d0</em> без его закрытия.</div>
|
||||
<pre>
|
||||
{
|
||||
"c": "forcesave",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"userdata": "sample userdata"
|
||||
"c": "forcesave",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"userdata": "sample userdata"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="info" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для получения статуса документа с идентификатором <em>Khirz6zTPdfd7</em>.</div>
|
||||
<pre>
|
||||
{
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
@ -91,15 +91,15 @@
|
||||
<div class="header-gray">Пример результата запроса</div>
|
||||
<pre>
|
||||
{
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
"error": 0,
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div id="version" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>командному сервису документов</b> и используемого для получения текущего номера версии Сервера документов.</div>
|
||||
<pre>
|
||||
{
|
||||
"c": "version"
|
||||
"c": "version"
|
||||
}
|
||||
</pre>
|
||||
|
||||
@ -107,8 +107,8 @@
|
||||
<div class="header-gray">Пример результата запроса</div>
|
||||
<pre>
|
||||
{
|
||||
"error": 0,
|
||||
"version": "1.0"
|
||||
"error": 0,
|
||||
"version": "1.0"
|
||||
}
|
||||
</pre>
|
||||
|
||||
|
||||
@ -32,43 +32,43 @@
|
||||
<td id="documentType" class="copy-link">documentType</td>
|
||||
<td>Определяет тип открытого документа: <em>открыть текстовый документ (.doc, .docm, .docx, .dot, .dotm, .dotx, .epub, .fodt, .htm, .html, .mht, .odt, .ott, .pdf, .rtf, .txt, .djvu, .xps) для просмотра или редактирования</em> - <b>text</b>, <em>открыть таблицу (.csv, .fods, .ods, .ots, .xls, .xlsx, .xlt, .xltm, .xltx) для просмотра или редактирования</em> - <b>spreadsheet</b>, <em>открыть презентацию (.fodp, .odp, .otp, .pot, .potm, .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx) для просмотра или редактирования</em> - <b>presentation</b>.</td>
|
||||
<td>строка</td>
|
||||
<td>"spreadsheet"</td>
|
||||
<td>"spreadsheet"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="height" class="copy-link">высота</td>
|
||||
<td>Определяет высоту документа (по умолчанию - <b>100%</b>) в окне браузера.</td>
|
||||
<td>строка</td>
|
||||
<td>"100%"</td>
|
||||
<td>"100%"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="token" class="copy-link">token</td>
|
||||
<td>Определяет закодированную подпись, добавляемую к конфигурации <b>Сервера документов</b> в форме <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/browser.aspx#config")%>">токена</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M"</td>
|
||||
<td>"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="type" class="copy-link">тип</td>
|
||||
<td>Определяет платформу, используемую для работы с документом. Может быть: <em>оптимизирован для доступа к документу с персонального компьютера или ноутбука</em> - <b>desktop</b>, <em>оптимизирован для доступа с планшета или смартфона</em> - <b>mobile</b>, <em>специально сформирован, чтобы иметь возможность легко встраиваться в веб-страницы</em> - <b>embedded</b>. Значением по умолчанию является <b>"desktop"</b>.</td>
|
||||
<td>Определяет платформу, используемую для работы с документом. Может быть: <em>оптимизирован для доступа к документу с персонального компьютера или ноутбука</em> - <b>desktop</b>, <em>оптимизирован для доступа с планшета или смартфона</em> - <b>mobile</b>, <em>специально сформирован, чтобы иметь возможность легко встраиваться в веб-страницы</em> - <b>embedded</b>. Значением по умолчанию является <b>"desktop"</b>.</td>
|
||||
<td>строка</td>
|
||||
<td>"desktop"</td>
|
||||
<td>"desktop"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="width" class="copy-link">width</td>
|
||||
<td>Определяет ширину документа (по умолчанию - <b>100%</b>) в окне браузера.</td>
|
||||
<td>строка</td>
|
||||
<td>"100%"</td>
|
||||
<td>"100%"</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"documentType": "text",
|
||||
"height": "100%",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
|
||||
"type": "desktop",
|
||||
"width": "100%",
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"documentType": "text",
|
||||
"height": "100%",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
|
||||
"type": "desktop",
|
||||
"width": "100%",
|
||||
...
|
||||
});
|
||||
</pre>
|
||||
|
||||
@ -32,35 +32,35 @@
|
||||
<td id="fileType" class="copy-link">fileType<span class="required">*</span></td>
|
||||
<td>Определяет тип файла для просматриваемого или редактируемого документа.</td>
|
||||
<td>строка</td>
|
||||
<td>"docx"</td>
|
||||
<td>"docx"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="key" class="copy-link">key<span class="required">*</span></td>
|
||||
<td>Определяет уникальный идентификатор, используемый для распознавания документа сервисом. В случае, если передан уже известный ключ, документ будет взят из кэша. Каждый раз, когда документ редактируется и сохраняется, ключ должен быть сгенерирован заново. Ссылка на документ может быть использована в качестве <b>ключа</b>, но без специальных символов, и длиной, ограниченной 20-ю символами.</td>
|
||||
<td>строка</td>
|
||||
<td>"Khirz6zTPdfd7"</td>
|
||||
<td>"Khirz6zTPdfd7"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="title" class="copy-link">title<span class="required">*</span></td>
|
||||
<td>Определяет желаемое имя файла для просматриваемого или редактируемого документа, которое также будет использовано как имя файла при его скачивании.</td>
|
||||
<td>строка</td>
|
||||
<td>"Пример названия документа.docx"</td>
|
||||
<td>"Пример названия документа.docx"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="url" class="copy-link">url<span class="required">*</span></td>
|
||||
<td>Определяет абсолютную ссылку на путь, по которому сохранён просматриваемый или редактируемый документ.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/url-to-example-document.docx"</td>
|
||||
<td>"https://example.com/url-to-example-document.docx"</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table><span class="required-descr"><span class="required">*</span><em> - обязательное поле</em></span><div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
},
|
||||
...
|
||||
});
|
||||
|
||||
@ -32,55 +32,49 @@
|
||||
<td id="author" class="copy-link">author</td>
|
||||
<td>Определяет имя автора/создателя документа.</td>
|
||||
<td>строка</td>
|
||||
<td>"Иван Петров"</td>
|
||||
<td>"Иван Петров"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="created" class="copy-link">created</td>
|
||||
<td>Определяет дату создания документа.</td>
|
||||
<td>строка</td>
|
||||
<td>"2010-07-07 3:46 PM"</td>
|
||||
<td>"2010-07-07 3:46 PM"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="folder" class="copy-link">folder</td>
|
||||
<td>Определяет папку, в которой хранится документ (может быть пустым в случае, если документ хранится в корневой директории).</td>
|
||||
<td>строка</td>
|
||||
<td>"Примеры файлов"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/info.png")%>" alt="" /></td>
|
||||
<td>"Примеры файлов"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="sharingSettings" class="copy-link">sharingSettings</td>
|
||||
<td>Отображает информацию о настройках, которые позволяют делиться документом с другими пользователями;<ul>
|
||||
<li><b>permissions</b> - права доступа для пользователя, с вышеуказанным именем. Может быть <b>Полный доступ</b>, <b>Только для чтения</b> или <b>Запрет доступа</b> <br /> <b>тип</b>: строка <br /> <b>пример</b>: "Полный доступ"</li>
|
||||
<li><b>user</b> - имя пользователя, которому мы отправляем документ <br /> <b>тип</b>: строка <br /> <b>пример</b>: "Иван Петров"</li>
|
||||
<li><b>permissions</b> - права доступа для пользователя, с вышеуказанным именем. Может быть <b>Полный доступ</b>, <b>Только для чтения</b> или <b>Запрет доступа</b> <br /> <b>тип</b>: строка <br /> <b>пример</b>: "Полный доступ"</li>
|
||||
<li><b>user</b> - имя пользователя, которому мы отправляем документ <br /> <b>тип</b>: строка <br /> <b>пример</b>: "Иван Петров"</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>массив объектов</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/sharing_settings.png")%>" alt="" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"info": {
|
||||
"author": "Иван Петров",
|
||||
"created": "2010-07-07 3:46 PM",
|
||||
"folder": "Примеры файлов",
|
||||
"sharingSettings": [
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"info": {
|
||||
"author": "Иван Петров",
|
||||
"created": "2010-07-07 3:46 PM",
|
||||
"folder": "Примеры файлов",
|
||||
"sharingSettings": [
|
||||
{
|
||||
"permissions": "Полный доступ",
|
||||
"user": "Иван Петров"
|
||||
"permissions": "Полный доступ",
|
||||
"user": "Иван Петров"
|
||||
},
|
||||
{
|
||||
"permissions": "Только для чтения",
|
||||
"user": "Елена Иванова"
|
||||
"permissions": "Только для чтения",
|
||||
"user": "Елена Иванова"
|
||||
},
|
||||
...
|
||||
]
|
||||
|
||||
@ -36,11 +36,6 @@
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/comment.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="note">
|
||||
@ -70,22 +65,12 @@
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/permissions.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="fillForms" class="copy-link">fillForms</td>
|
||||
<td>Defines if the forms can be filled. Filling in forms will only be available for the document editor if the <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#mode")%>">mode</a> parameter is set to <b>edit</b>. The default value coincides with the value of the <a href="#edit">edit</a> or the <a href="#review">review</a> parameter.</td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/fill-forms.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="note">
|
||||
@ -103,11 +88,6 @@
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/review.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="note">
|
||||
|
||||
@ -43,11 +43,6 @@
|
||||
<td>string</td>
|
||||
<td>"https://example.com/url-to-create-document/"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/create.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="lang" class="copy-link">lang</td>
|
||||
<td>Defines the editor interface language (if some other languages other than English are present). Is set using the two letter (<b>de</b>, <b>ru</b>, <b>it</b>, etc.) or four letter (<b>en-US</b>, <b>fr-FR</b>, etc.) language codes. The default value is <b>"en-US"</b>.</td>
|
||||
@ -90,11 +85,6 @@
|
||||
<td>array of object</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4">
|
||||
<img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/recent.png")%>" alt="" />
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="user" class="copy-link">user</td>
|
||||
<td>Defines the user currently viewing or editing the document:
|
||||
|
||||
@ -61,12 +61,12 @@
|
||||
<tr class="tablerow">
|
||||
<td id="customer" class="copy-link">customer<span class="required">*</span></td>
|
||||
<td>Содержит информацию для раздела <b>О компании</b>. Объект имеет следующие параметры:<ul>
|
||||
<li><b>address</b> - почтовый адрес вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Мой город, 123-45";</li>
|
||||
<li><b>info</b> - некоторая информация о вышеуказанной компании или человеке, которая будет отображена на странице <b>О компании</b>, видимой для всех пользователей, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Некоторая дополнительная информация";</li>
|
||||
<li><b>logo</b> - путь к файлу изображения логотипа, который будет отображён на странице <b>О компании</b> (не существует каких-либо рекомендаций для данного файла, но лучше всего, если этот файл является файлом формата .png с прозрачным фоном. Данное изображение должно иметь следующий размер: 432x70, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo-big.png".</li>
|
||||
<li><b>mail</b> - адрес электронной почты вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "john@example.com".</li>
|
||||
<li><b>name</b> - имя вышеуказанной компании или человека, предоставляющих доступ к редакторам, <br /><b>тип</b>: строка, <br /> <b>пример</b>: "Иван Петров и сыновья.";</li>
|
||||
<li><b>www</b> - адрес сайта вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "example.com".</li>
|
||||
<li><b>address</b> - почтовый адрес вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Мой город, 123-45";</li>
|
||||
<li><b>info</b> - некоторая информация о вышеуказанной компании или человеке, которая будет отображена на странице <b>О компании</b>, видимой для всех пользователей, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Некоторая дополнительная информация";</li>
|
||||
<li><b>logo</b> - путь к файлу изображения логотипа, который будет отображён на странице <b>О компании</b> (не существует каких-либо рекомендаций для данного файла, но лучше всего, если этот файл является файлом формата .png с прозрачным фоном. Данное изображение должно иметь следующий размер: 432x70, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo-big.png".</li>
|
||||
<li><b>mail</b> - адрес электронной почты вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "john@example.com".</li>
|
||||
<li><b>name</b> - имя вышеуказанной компании или человека, предоставляющих доступ к редакторам, <br /><b>тип</b>: строка, <br /> <b>пример</b>: "Иван Петров и сыновья.";</li>
|
||||
<li><b>www</b> - адрес сайта вышеуказанной компании или человека, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "example.com".</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>объект</td>
|
||||
@ -75,7 +75,7 @@
|
||||
<tr class="tablerow">
|
||||
<td id="feedback" class="copy-link">feedback</td>
|
||||
<td>Определяет настройки для кнопки <b>Обратная связь и поддержка</b>. Может быть логическим типом (лишь отображает или скрывает кнопку меню <b>Обратная связь и поддержка</b>) или объектом. В случае, если он имеет объектный тип, доступны следующие параметры:<ul>
|
||||
<li><b>url</b> - абсолютный адрес сайта, который будет открыт при нажатии кнопки <b>Обратная связь и поддержка</b>, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com";</li>
|
||||
<li><b>url</b> - абсолютный адрес сайта, который будет открыт при нажатии кнопки <b>Обратная связь и поддержка</b>, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com";</li>
|
||||
<li><b>visible</b> - отображает или скрывает кнопку <b>Обратная связь и поддержка</b>, <br /> <b>тип</b>: логический, <br /> <b>пример</b>: true</li>
|
||||
</ul>Значением по умолчанию является <b>false</b>.</td>
|
||||
<td>логический или объектный</td>
|
||||
@ -91,8 +91,8 @@
|
||||
<td id="goback" class="copy-link">goback</td>
|
||||
<td>Определяет настройки для кнопки меню <b>Перейти к документам</b> и кнопке в верхнем правом углу. Объект имеет следующие параметры:<ul>
|
||||
<li><b>blank</b> - открыть веб-сайт в новой вкладке/окне браузера (если параметр установлен в значение <em>true</em>) или текущей вкладке (если параметр установлен в значение <em>false</em>), при нажатии на кнопку <b>Перейти к документам</b>. Значение по умолчанию - <b>true</b>, <br /> <b>тип</b>: логический, <br /> <b>пример</b>: true;</li>
|
||||
<li><b>text</b> - текст, который будет отображён для кнопки <b>Перейти к документам</b> и кнопке в верхнем правом углу (то есть вместо <em>Перейти к документам</em>), <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Перейти к документам";</li>
|
||||
<li><b>url</b>- абсолютный адрес сайта, который будет открыт при нажатии кнопки <b>Перейти к документам</b>, тип: строка, <br /> <b>пример</b>: "https://example.com".</li>
|
||||
<li><b>text</b> - текст, который будет отображён для кнопки <b>Перейти к документам</b> и кнопке в верхнем правом углу (то есть вместо <em>Перейти к документам</em>), <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "Перейти к документам";</li>
|
||||
<li><b>url</b>- абсолютный адрес сайта, который будет открыт при нажатии кнопки <b>Перейти к документам</b>, тип: строка, <br /> <b>пример</b>: "https://example.com".</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>логический или объектный</td>
|
||||
@ -104,15 +104,12 @@
|
||||
<td>логический</td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/help.png")%>" alt="" /></td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="logo" class="copy-link">logo<span class="required">*</span></td>
|
||||
<td>Изменяет изображение в верхнем левом углу заголовка редактора. Рекомендуемая высота изображения - 20 пикселей. Объект имеет следующие параметры:<ul>
|
||||
<li><b>image</b> - путь к файлу изображения, отображаемому в обычном режиме работы (то есть в режимах просмотра и редактирования для всех редакторов). Данное изображение должно иметь следующий размер: 172x40, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo.png";</li>
|
||||
<li><b>imageEmbedded</b> - путь к файлу изображения, отображаемый во встроенном режиме (смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/.aspx#type")%>">config</a>, чтобы выяснить, как определить <b>встроенный</b> тип документа). Данное изображение должно иметь следующий размер: 248x40, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo_em.png";</li>
|
||||
<li><b>url</b> - абсолютная ссылка, которая будет использована, когда кто-либо нажимает на логотип (может быть использовано для перехода на ваш сайт, и т.д.). Оставьте пустой строкой или <em>null</em>, чтобы сделать логотип некликабельным, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com".</li>
|
||||
<li><b>image</b> - путь к файлу изображения, отображаемому в обычном режиме работы (то есть в режимах просмотра и редактирования для всех редакторов). Данное изображение должно иметь следующий размер: 172x40, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo.png";</li>
|
||||
<li><b>imageEmbedded</b> - путь к файлу изображения, отображаемый во встроенном режиме (смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/.aspx#type")%>">config</a>, чтобы выяснить, как определить <b>встроенный</b> тип документа). Данное изображение должно иметь следующий размер: 248x40, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com/logo_em.png";</li>
|
||||
<li><b>url</b> - абсолютная ссылка, которая будет использована, когда кто-либо нажимает на логотип (может быть использовано для перехода на ваш сайт, и т.д.). Оставьте пустой строкой или <em>null</em>, чтобы сделать логотип некликабельным, <br /> <b>тип</b>: строка, <br /> <b>пример</b>: "https://example.com".</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>object</td>
|
||||
@ -130,44 +127,41 @@
|
||||
<td>целочисленный</td>
|
||||
<td>100</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/customization.png")%>" alt="" /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table><span class="required-descr"><span class="required">*</span><em> - доступно для редактирования только в Решении для разработчиков</em></span><div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"customization": {
|
||||
"chat": true,
|
||||
"commentAuthorOnly": false,
|
||||
"compactToolbar": false,
|
||||
"customer": {
|
||||
"address": "Мой город, 123-45",
|
||||
"info": "Дополнительная информация",
|
||||
"logo": "https://example.com/logo-big.png",
|
||||
"mail": "john@example.com",
|
||||
"name": "Иван Петров и сыновья.",
|
||||
"www": "example.com"
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"customization": {
|
||||
"chat": true,
|
||||
"commentAuthorOnly": false,
|
||||
"compactToolbar": false,
|
||||
"customer": {
|
||||
"address": "Мой город, 123-45",
|
||||
"info": "Дополнительная информация",
|
||||
"logo": "https://example.com/logo-big.png",
|
||||
"mail": "john@example.com",
|
||||
"name": "Иван Петров и сыновья.",
|
||||
"www": "example.com"
|
||||
},
|
||||
"feedback": {
|
||||
"url": "https://example.com",
|
||||
"visible": true
|
||||
"feedback": {
|
||||
"url": "https://example.com",
|
||||
"visible": true
|
||||
},
|
||||
"forcesave": false,
|
||||
"goback": {
|
||||
"blank": true,
|
||||
"text": "Вернуться к документам",
|
||||
"url": "https://example.com"
|
||||
"forcesave": false,
|
||||
"goback": {
|
||||
"blank": true,
|
||||
"text": "Вернуться к документам",
|
||||
"url": "https://example.com"
|
||||
},
|
||||
"help": true,
|
||||
"logo": {
|
||||
"image": "https://example.com/logo.png",
|
||||
"imageEmbedded": "https://example.com/logo_em.png",
|
||||
"url": "https://www.r7-office.ru"
|
||||
"help": true,
|
||||
"logo": {
|
||||
"image": "https://example.com/logo.png",
|
||||
"imageEmbedded": "https://example.com/logo_em.png",
|
||||
"url": "https://www.r7-office.ru"
|
||||
},
|
||||
"showReviewChanges": false,
|
||||
"zoom": 100
|
||||
"showReviewChanges": false,
|
||||
"zoom": 100
|
||||
},
|
||||
...
|
||||
},
|
||||
|
||||
@ -32,48 +32,45 @@
|
||||
<td id="embedUrl" class="copy-link">embedUrl</td>
|
||||
<td>Определяет абсолютную ссылку к документу, который служит исходным файлом, содержащим код веб-страницы.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/embedded?doc=exampledocument1.docx"</td>
|
||||
<td>"https://example.com/embedded?doc=exampledocument1.docx"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="fullscreenUrl" class="copy-link">fullscreenUrl</td>
|
||||
<td>Определяет абсолютную ссылку к документу, который будет открыт в полноэкранном режиме.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/embedded?doc=exampledocument1.docx#fullscreen"</td>
|
||||
<td>"https://example.com/embedded?doc=exampledocument1.docx#fullscreen"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="saveUrl" class="copy-link">saveUrl</td>
|
||||
<td>Определяет абсолютную ссылку, с помощью которой пользователь может сохранить документ к себе на компьютер.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/download?doc=exampledocument1.docx"</td>
|
||||
<td>"https://example.com/download?doc=exampledocument1.docx"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="shareUrl" class="copy-link">shareUrl</td>
|
||||
<td>Определяет абсолютную ссылку, с помощью которой другие пользователи могут поделиться этим документом.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/view?doc=exampledocument1.docx"</td>
|
||||
<td>"https://example.com/view?doc=exampledocument1.docx"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td id="toolbarDocked" class="copy-link">toolbarDocked</td>
|
||||
<td>Определяет расположение встроенной панели инструментов просмотра, может быть <b>top</b> или <b>bottom</b>.</td>
|
||||
<td>строка</td>
|
||||
<td>"top"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/embedded.png")%>" alt="" /></td>
|
||||
<td>"top"</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"embedded": {
|
||||
"embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
|
||||
"fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
|
||||
"saveUrl": "https://example.com/download?doc=exampledocument1.docx",
|
||||
"shareUrl": "https://example.com/view?doc=exampledocument1.docx",
|
||||
"toolbarDocked": "top"
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"embedded": {
|
||||
"embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
|
||||
"fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
|
||||
"saveUrl": "https://example.com/download?doc=exampledocument1.docx",
|
||||
"shareUrl": "https://example.com/view?doc=exampledocument1.docx",
|
||||
"toolbarDocked": "top"
|
||||
},
|
||||
...
|
||||
},
|
||||
|
||||
@ -44,27 +44,24 @@
|
||||
<td id="url" class="copy-link">url</td>
|
||||
<td>Определяет абсолютный путь к директории, в которой расположены плагины. Данный параметр не используется, пожалуйста используйте вместо этого ссылки в поле <a href="#pluginsData">pluginsData</a>.</td>
|
||||
<td>строка</td>
|
||||
<td>"https://example.com/plugins/"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td colspan="4"><img src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/plugins.png")%>" alt="" /></td>
|
||||
<td>"https://example.com/plugins/"</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="header-gray">Example</div>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"plugins": {
|
||||
"autostart": [
|
||||
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
|
||||
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"editorConfig": {
|
||||
"plugins": {
|
||||
"autostart": [
|
||||
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
|
||||
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
|
||||
...
|
||||
],
|
||||
"pluginsData": [
|
||||
"https://example.com/plugin1/config.json",
|
||||
"https://example.com/plugin2/config.json",
|
||||
"pluginsData": [
|
||||
"https://example.com/plugin1/config.json",
|
||||
"https://example.com/plugin2/config.json",
|
||||
...
|
||||
]
|
||||
},
|
||||
|
||||
@ -17,12 +17,12 @@
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onAppReady = function() {
|
||||
console.log("Сервер документов готов к работе");
|
||||
console.log("Сервер документов готов к работе");
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onAppReady": onAppReady,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onAppReady": onAppReady,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -35,12 +35,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onCollaborativeChanges = function () {
|
||||
console.log("Документ изменён одним из пользователей");
|
||||
console.log("Документ изменён одним из пользователей");
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onCollaborativeChanges": onCollaborativeChanges,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onCollaborativeChanges": onCollaborativeChanges,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -53,12 +53,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onDocumentReady = function() {
|
||||
console.log("Документ загружен");
|
||||
console.log("Документ загружен");
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDocumentReady": onDocumentReady,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDocumentReady": onDocumentReady,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -67,20 +67,20 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<p><b id="onDocumentStateChange" class="copy-link">onDocumentStateChange</b> - функция вызывается, когда документ редактируется. Эта функция вызывается с параметром: <em>{"data": true}</em> когда текущий пользователь редактирует документ и с параметром: <em>{"data" : false}</em> когда изменения, вносимые в документ текущим пользователем, отправляются <b>сервису редактирования документов</b>.</p>
|
||||
<p><b id="onDocumentStateChange" class="copy-link">onDocumentStateChange</b> - функция вызывается, когда документ редактируется. Эта функция вызывается с параметром: <em>{"data": true}</em> когда текущий пользователь редактирует документ и с параметром: <em>{"data" : false}</em> когда изменения, вносимые в документ текущим пользователем, отправляются <b>сервису редактирования документов</b>.</p>
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onDocumentStateChange = function (event) {
|
||||
if (event.data) {
|
||||
console.log("Документ изменён");
|
||||
console.log("Документ изменён");
|
||||
} else {
|
||||
console.log("Изменения собраны службой редактирования документов");
|
||||
console.log("Изменения собраны службой редактирования документов");
|
||||
}
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDocumentStateChange": onDocumentStateChange,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDocumentStateChange": onDocumentStateChange,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -93,12 +93,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onDownloadAs = function (event) {
|
||||
console.log("Редактор документов создал файл: " + event.data);
|
||||
console.log("Редактор документов создал файл: " + event.data);
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDownloadAs": onDownloadAs,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onDownloadAs": onDownloadAs,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -111,12 +111,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onError = function (event) {
|
||||
console.log("Редактор документов сообщает об ошибке: code " + event.data.errorCode + ", описание " + event.data.errorDescription);
|
||||
console.log("Редактор документов сообщает об ошибке: code " + event.data.errorCode + ", описание " + event.data.errorDescription);
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onError": onError,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onError": onError,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -129,12 +129,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onInfo = function (event) {
|
||||
console.log("Редактор документов открыт в режиме " + event.data.mode);
|
||||
console.log("Редактор документов открыт в режиме " + event.data.mode);
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onInfo": onInfo,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onInfo": onInfo,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -150,9 +150,9 @@ var onOutdatedVersion = function () {
|
||||
location.reload(true);
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onOutdatedVersion": onOutdatedVersion,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onOutdatedVersion": onOutdatedVersion,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -176,9 +176,9 @@ var onRequestClose = function () {
|
||||
docEditor.destroyEditor();
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestClose": onRequestClose,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestClose": onRequestClose,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -192,13 +192,13 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onRequestEditRights = function () {
|
||||
console.log("Редактор документов запрашивает права на редактирование");
|
||||
console.log("Редактор документов запрашивает права на редактирование");
|
||||
document.location.reload();
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestEditRights": onRequestEditRights,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestEditRights": onRequestEditRights,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -212,37 +212,37 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<pre>
|
||||
var onRequestHistory = function() {
|
||||
docEditor.refreshHistory({
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
},
|
||||
"version": 1
|
||||
"version": 1
|
||||
},
|
||||
{
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
},
|
||||
"version": 2
|
||||
"version": 2
|
||||
},
|
||||
...
|
||||
]
|
||||
});
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistory": onRequestHistory,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistory": onRequestHistory,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -258,9 +258,9 @@ var onRequestHistoryClose = function() {
|
||||
document.location.reload();
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryClose": onRequestHistoryClose,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryClose": onRequestHistoryClose,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -275,20 +275,20 @@ 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>, возвращается после сохранения документа
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"previous": {
|
||||
"key": "af86C7e71Ca8",
|
||||
"url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
|
||||
"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",
|
||||
"url": "https://example.com/url-to-the-previous-version-of-the-document.docx"
|
||||
},
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": version
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": version
|
||||
})
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
...
|
||||
},
|
||||
...
|
||||
@ -300,12 +300,12 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример</div>
|
||||
<pre>
|
||||
var onWarning = function (event) {
|
||||
console.log("Редактор документов сообщает о предупреждении: code " + event.data.warningCode + ", description " + event.data.warningDescription);
|
||||
console.log("Редактор документов сообщает о предупреждении: code " + event.data.warningCode + ", description " + event.data.warningDescription);
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onWarning": onWarning,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onWarning": onWarning,
|
||||
...
|
||||
},
|
||||
...
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
<li><em>xlsx</em> - для таблиц,</li>
|
||||
<li><em>pptx</em> - для презентаций.</li>
|
||||
</ul>
|
||||
<p>Нижеперечисленные шаги объясняют процесс конвертирования документов.</p><img alt="Промежуточная конвертация необходима для редактирования документа." src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/conversion.jpg")%>" /><ol>
|
||||
<p>Нижеперечисленные шаги объясняют процесс конвертирования документов.</p><ol>
|
||||
<li>Пользователь выбирает файл на жёстком диске компьютера, который будет отправлен <b>менеджеру документов</b>.</li>
|
||||
<li><b>Менеджер документов</b> загружает выбранный файл на <b>сервис хранения документов</b>.</li>
|
||||
<li><b>Сервис хранения документов</b> отправляет загруженный файл <b>сервису конвертации документов</b> Сервера документов для конвертации его в один из форматов Office Open XML при помощи <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/conversionapi.aspx")%>">API конвертации</a>.</li>
|
||||
@ -25,7 +25,7 @@
|
||||
</ol>
|
||||
<h2>Экспорт документа</h2>
|
||||
<p>Если пользователю необходимо скачать файл в формате, отличном от Office Open XML, Сервер документов конвертирует файл документа, сохранённый в <b>сервисе хранения документов</b>, в подходящий формат до его экспорта.</p>
|
||||
<p>Нижеперечисленные шаги объясняют процесс экспорта документа.</p><img alt="Экспорт документа" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/export.jpg")%>" /><ol>
|
||||
<p>Нижеперечисленные шаги объясняют процесс экспорта документа.</p><ol>
|
||||
<li>Пользователь выбирает файл в <b>менеджере документов</b> и формат, в котором он желает скачать файл.</li>
|
||||
<li><b>Менеджер документов</b> преобразует данные действия пользователя в запрос к <b>сервису хранения документов</b>.</li>
|
||||
<li><b>Сервис хранения документов</b> отправляет загруженный файл <b>сервису конвертации документов</b> Сервера документов для конвертации его в один из подходящих форматов при помощи <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/conversionapi.aspx")%>">API конвертации</a>.</li>
|
||||
|
||||
@ -591,12 +591,12 @@
|
||||
<div id="sample-conversion" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>сервису конвертации документов</b> и используемого для конвертации файлов из формата <em>docx</em> в формат <em>pdf</em></div>
|
||||
<pre>
|
||||
{
|
||||
"async": false,
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"async": false,
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.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>
|
||||
@ -604,17 +604,17 @@
|
||||
<div id="sample-thumbnail" class="header-gray copy-link">Пример JSON объекта, отправляемого <b>сервису конвертации документов</b> и используемого для генерации миниатюры в формате <em>png</em> для файла формата <em>docx</em></div>
|
||||
<pre>
|
||||
{
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "png",
|
||||
"thumbnail": {
|
||||
"aspect": 0,
|
||||
"first": true,
|
||||
"height": 150,
|
||||
"width": 100
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "png",
|
||||
"thumbnail": {
|
||||
"aspect": 0,
|
||||
"first": true,
|
||||
"height": 150,
|
||||
"width": 100
|
||||
},
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"title": "Пример названия документа.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>
|
||||
@ -623,7 +623,7 @@
|
||||
<div class="header-gray">Пример ответа в формате XML</div>
|
||||
<p>При формировании ссылки на конечный файл используется имя сервера, к которому был отправлен запрос на конвертацию.</p>
|
||||
<pre>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<FileResult>
|
||||
<EndConvert>True</EndConvert>
|
||||
<FileUrl>https://documentserver/ResourceService.ashx?filename=output.doc</FileUrl>
|
||||
@ -634,15 +634,15 @@
|
||||
<p>При формировании ссылки на конечный файл используется имя сервера, к которому был отправлен запрос на конвертацию.</p>
|
||||
<pre>
|
||||
{
|
||||
"endConvert": true,
|
||||
"fileUrl": "https://documentserver/ResourceService.ashx?filename=output.doc",
|
||||
"percent": 100
|
||||
"endConvert": true,
|
||||
"fileUrl": "https://documentserver/ResourceService.ashx?filename=output.doc",
|
||||
"percent": 100
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div class="header-gray">Пример промежуточного ответа на асинхронный запрос (с параметром <em>async=true</em>) в формате XML</div>
|
||||
<pre>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<FileResult>
|
||||
<EndConvert>False</EndConvert>
|
||||
<FileUrl></FileUrl>
|
||||
@ -652,14 +652,14 @@
|
||||
<div class="header-gray">Пример промежуточного ответа на асинхронный запрос (с параметром <em>async=true</em>) в формате JSON</div>
|
||||
<pre>
|
||||
{
|
||||
"endConvert": false,
|
||||
"percent": 95
|
||||
"endConvert": false,
|
||||
"percent": 95
|
||||
}
|
||||
</pre>
|
||||
|
||||
<div class="header-gray">Пример ответа в формате XML при возникновении ошибки</div>
|
||||
<pre>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<FileResult>
|
||||
<Error>-3</Error>
|
||||
</FileResult>
|
||||
@ -667,7 +667,7 @@
|
||||
<div class="header-gray">Пример ответа в формате JSON при возникновении ошибки</div>
|
||||
<pre>
|
||||
{
|
||||
"error": -3
|
||||
"error": -3
|
||||
}
|
||||
</pre>
|
||||
|
||||
|
||||
@ -29,59 +29,59 @@
|
||||
<pre>
|
||||
var onRequestHistory = function() {
|
||||
docEditor.refreshHistory({
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"created": "2010-07-06 10:13 AM",
|
||||
"key": "af86C7e71Ca8",
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
"created": "2010-07-06 10:13 AM",
|
||||
"key": "af86C7e71Ca8",
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
},
|
||||
"version": 1
|
||||
"version": 1
|
||||
},
|
||||
{
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
},
|
||||
"version": 2
|
||||
"version": 2
|
||||
},
|
||||
...
|
||||
]
|
||||
});
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistory": onRequestHistory,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistory": onRequestHistory,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre><img alt="Открытие файла" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/history_open.png")%>" /></li>
|
||||
</pre></li>
|
||||
<li>
|
||||
<p>Для инициализации Редактора документов, в скрипте конфигурации укажите обработчик событий, который будет выбирать <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistoryData")%>">версию из истории версий</a>. Когда вызывается событие <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistoryData")%>">onRequestHistoryData</a>, должен быть выполнен метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setHistoryData")%>">setHistoryData</a>. Этот метод содержит абсолютную ссылку на файл, соответствующий выбранной версии.</p>
|
||||
<pre>
|
||||
var onRequestHistoryData = function(event) {
|
||||
var version = event.data;
|
||||
docEditor.setHistoryData({
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": version
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": version
|
||||
})
|
||||
};
|
||||
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
"events": {
|
||||
"onRequestHistoryData": onRequestHistoryData,
|
||||
...
|
||||
},
|
||||
...
|
||||
});
|
||||
</pre><img alt="Открытие файла" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/history.png")%>" /></li>
|
||||
</pre></li>
|
||||
<li>Откройте ваш <em>html</em> файл в браузере.</li>
|
||||
<li>Откройте <em>Историю версий</em> в меню редактора документов.</li>
|
||||
</ol>
|
||||
@ -93,29 +93,29 @@ var docEditor = new DocsAPI.DocEditor("placeholder", {
|
||||
<p><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#history")%>">history</a> - эта информация позволяет отображать время создания/редактирования и автора для каждой версии документа, когда вы просматриваете историю изменений документа в боковой панели. Должна быть отправлена как свойство изменений объекта, переданного методу <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#refreshHistory")%>">refreshHistory</a> в качестве аргумента.</p>
|
||||
<pre>
|
||||
docEditor.refreshHistory({
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
},
|
||||
"version": 1
|
||||
"version": 1
|
||||
},
|
||||
{
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"serverVersion": serverVersion,
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"serverVersion": serverVersion,
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
},
|
||||
"version": 2
|
||||
"version": 2
|
||||
},
|
||||
...
|
||||
],
|
||||
@ -126,16 +126,16 @@ docEditor.refreshHistory({
|
||||
<p><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#changesurl")%>">Changesurl</a> - абсолютная ссылка на файл с данными о редактировании документа, используемый для показа изменений, относящихся к конкретной версии документа. Файл должен быть сохранён, а его адрес должен быть отправлен как параметр changesUrl , используя метод <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx#setHistoryData")%>">setHistoryData</a>. Ссылка на предыдущую версию документа (<em>previous.url</em>), которая должна быть добавлена к объекту.</p>
|
||||
<pre>
|
||||
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"
|
||||
"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
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": 2
|
||||
});
|
||||
</pre>
|
||||
<div class="note">Запрос <em>changesurl</em> выполняется в браузере, с помощью тега iframe, с доменом <b>documentserver</b>, где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов. Для его корректной работы должно быть разрешено совместное использование ресурсов между разными источниками (CORS). Этого можно добиться используя заголовок <em>Access-Control-Allow-Origin</em>.</div><img alt="changesurl" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/changesurl.png")%>" /></li>
|
||||
<div class="note">Запрос <em>changesurl</em> выполняется в браузере, с помощью тега iframe, с доменом <b>documentserver</b>, где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов. Для его корректной работы должно быть разрешено совместное использование ресурсов между разными источниками (CORS). Этого можно добиться используя заголовок <em>Access-Control-Allow-Origin</em>.</div></li>
|
||||
</ul>
|
||||
</div>
|
||||
@ -9,7 +9,7 @@
|
||||
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Методы</h1>
|
||||
<p class="dscr">После инициализации <b>редактора документов</b> вы получите объект, который можно использовать для вызова методов.</p>
|
||||
<pre>
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", config);
|
||||
var docEditor = new DocsAPI.DocEditor("placeholder", config);
|
||||
</pre>
|
||||
|
||||
<ul>
|
||||
@ -61,29 +61,29 @@ docEditor.downloadAs();
|
||||
<p><b id="refreshHistory" class="copy-link">refreshHistory</b> - показывает историю версий документа. Данный метод необходимо вызывать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistory")%>">onRequestHistory</a>.</p>
|
||||
<pre>
|
||||
docEditor.refreshHistory({
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
"currentVersion": 2,
|
||||
"history": [
|
||||
{
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
"changes": changes, // <em>changes</em> от <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx#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> после сохранения документа
|
||||
"user": {
|
||||
"id": "F89d8069ba2b",
|
||||
"name": "Елена Иванова"
|
||||
},
|
||||
"version": 1
|
||||
"version": 1
|
||||
},
|
||||
{
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"serverVersion": serverVersion,
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
"changes": changes,
|
||||
"created": "07.07.2010 15:46 AM",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"serverVersion": serverVersion,
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иван Петров"
|
||||
},
|
||||
"version": 2
|
||||
"version": 2
|
||||
},
|
||||
...
|
||||
],
|
||||
@ -92,7 +92,7 @@ docEditor.refreshHistory({
|
||||
<p>Показ сообщения об ошибке, поясняющей, почему история версий документа не может быть отображена.</p>
|
||||
<pre>
|
||||
docEditor.refreshHistory({
|
||||
"error": "Exception",
|
||||
"error": "Exception",
|
||||
});
|
||||
</pre>
|
||||
<table class="table">
|
||||
@ -179,33 +179,33 @@ docEditor.refreshHistory({
|
||||
<p><b id="setHistoryData" class="copy-link">setHistoryData</b> - отправляет ссылку на документ для просмотра истории версий. Данный метод необходимо вызывать после событий <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx#onRequestHistoryData")%>">onRequestHistoryData</a>.</p>
|
||||
<pre>
|
||||
docEditor.setHistoryData({
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3giLCJ2ZXJzaW9uIjoyfQ.N9N9IMwX5e6kdfx4wssAPrGMnzPAZCd4PwDf2D8mJ8s",
|
||||
"url": "https://example.com/url-to-example-document.docx",
|
||||
"version": 2
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3giLCJ2ZXJzaW9uIjoyfQ.N9N9IMwX5e6kdfx4wssAPrGMnzPAZCd4PwDf2D8mJ8s",
|
||||
"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>
|
||||
<p>Если после редактирования и сохранения документа, возвращается ссылка <em>changesurl</em> на документ, в котором были произведены изменения, загрузите файл, используя эту ссылку и отправьте ссылку на файл в параметре <em>changesUrl</em>. Абсолютная ссылка на документ предыдущей версии должна быть передан в параметре <em>previous.url</em>.</p>
|
||||
<pre>
|
||||
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"
|
||||
"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
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaGFuZ2VzVXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1jaGFuZ2VzLnppcCIsImtleSI6IktoaXJ6NnpUUGRmZDciLCJwcmV2aW91cyI6eyJrZXkiOiJhZjg2QzdlNzFDYTgiLCJ1cmwiOiJodHRwOi8vZXhhbXBsZS5jb20vdXJsLXRvLXRoZS1wcmV2aW91cy12ZXJzaW9uLW9mLXRoZS1kb2N1bWVudC5kb2N4In0sInVybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1kb2N1bWVudC5kb2N4IiwidmVyc2lvbiI6Mn0.9dgDsaVLFQ6RtoX_1s2pBVJHGnyMjxDXKC2TpC2nXb4",
|
||||
"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>
|
||||
<p>Отправка сообщения об ошибке, поясняющей, почему версия документа не может быть отображена.</p>
|
||||
<pre>
|
||||
docEditor.setHistoryData({
|
||||
"error": "Exception",
|
||||
"version": 2
|
||||
"error": "Exception",
|
||||
"version": 2
|
||||
});
|
||||
</pre>
|
||||
<table class="table">
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
</script>
|
||||
<div class="MainHelpCenter">
|
||||
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Открытие файла</h1>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс открытия файлов на Сервере документов.</p><img alt="Открытие файла" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/opening.jpg")%>" /><ol>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс открытия файлов на Сервере документов.</p><ol>
|
||||
<li>Пользователь использует <b>менеджер документов</b> (который можно открыть в браузере) для открытия документов для просмотра или редактирования.<div class="note"><b>Менеджер документов</b> получает список всех доступных для пользователя документов от <b>сервиса хранения документов</b>.</div>
|
||||
</li>
|
||||
<li>Идентификатор документа и ссылка на него отправляются <b>редактору документов</b> от <b>сервиса хранения документов</b> при помощи <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/basic.aspx")%>">JavaScript API</a>.</li>
|
||||
@ -21,18 +21,18 @@
|
||||
<h2 id="apply" class="copy-link">Как это возможно сделать на практике</h2>
|
||||
<ol>
|
||||
<li>Создайте пустой <em>html</em> файл.</li>
|
||||
<li>Добавьте <em>div</em> элемент, как показано ниже.<pre><div id="placeholder"></div></pre>
|
||||
<li>Добавьте <em>div</em> элемент, как показано ниже.<pre><div id="placeholder"></div></pre>
|
||||
</li>
|
||||
<li>Свяжите ссылку на ваш Сервер документов, которая будет использоваться на вашем сайте с JavaScript API.<pre><script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script></pre>Где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов.</li>
|
||||
<li>Свяжите ссылку на ваш Сервер документов, которая будет использоваться на вашем сайте с JavaScript API.<pre><script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script></pre>Где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов.</li>
|
||||
<li>Добавьте скрипт инициализации <b>Редактора документов</b> для <em>div</em> элемента с конфигурацией документа, который вы хотите открыть.<pre>
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text"
|
||||
"documentType": "text"
|
||||
});
|
||||
</pre>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.</li>
|
||||
<li>Откройте ваш <em>html</em> файл в браузере.</li>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
</script>
|
||||
<div class="MainHelpCenter">
|
||||
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Сохранение файла</h1>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс сохранения на Сервере документов.</p><img alt="Открытие файла" src="<%=VirtualPathUtility.ToAbsolute("~/content/img/editor/saving.jpg")%>" /><ol>
|
||||
<p class="dscr">Нижеперечисленные шаги объясняют процесс сохранения на Сервере документов.</p><ol>
|
||||
<li>Пользователь редактирует документ в <b>редакторе документов</b>.</li>
|
||||
<li><b>Редактор документов</b> отправляет изменения <b>сервису редактирования документов</b>.</li>
|
||||
<li>Пользователь закрывает <b>редактор документов</b>.</li>
|
||||
@ -21,16 +21,16 @@
|
||||
<li>Создайте <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/callback.aspx")%>">обработчик обратных вызовов</a>, чтобы сохранить документ из <b>сервиса редактирования документов</b>.</li>
|
||||
<li>Создайте <em>html</em>, чтобы <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/open.aspx#apply")%>">Открыть документ</a>.</li>
|
||||
<li>В скрипте конфигурации, для инициализации Редактора документов, укажите ссылку на файл с <em>обработчиком обратных вызовов</em> в <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#callbackUrl")%>">строке параметра</a>.<pre>
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
new DocsAPI.DocEditor("placeholder", {
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx"
|
||||
"documentType": "text",
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx"
|
||||
}
|
||||
});
|
||||
</pre>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>.</li>
|
||||
@ -44,6 +44,8 @@ new DocsAPI.DocEditor("placeholder", {
|
||||
<p>Начальное время задержки конвертации необходимо для обеспечения возможности возвращения к редактированию файла, без его сохранения, например при перезагрузке веб-станицы с открытым для редактирования документом. По умолчанию начальное время задержки конвертации определяется в файле конфигурации <b>Сервера документов</b>, который может быть найден в следующих директориях:</p>
|
||||
<div>Для Linux - <em>/etc/r7office/documentserver/<b>default.json</b></em></div>
|
||||
<div>Для Windows - <em>%ProgramFiles%\R7OFFICE\DocumentServer\config\<b>default.json</b></em></div>
|
||||
<p>Если вы хотите изменить его, вы можете использовать файл <em>local.json</em>, где должны быть сохранены все редактируемые параметры. Этот файл должен быть создан в той же папке, что и файл <em>default.json</em> и <b>полная структура объектов</b> для необходимых параметров <b>должна быть сохранена</b> (смотрите примеры ниже).</p>
|
||||
<div class="note">Пожалуйста, не редактируйте содержимое файла <em>default.json</em> напрямую. Значения по умолчанию будут перезаписаны каждый раз, когда вы перезапускаете Docker-контейнер или обновляете <b>Сервер документов</b> до новой версии, и все ваши изменения будут утеряны.</div>
|
||||
|
||||
<div class="header-gray">Параметры</div>
|
||||
|
||||
@ -75,10 +77,10 @@ new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример файла конфигурации local.json</div>
|
||||
<pre>
|
||||
{
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"server": {
|
||||
"savetimeoutdelay": 5000
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"server": {
|
||||
"savetimeoutdelay": 5000
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -92,8 +94,8 @@ new DocsAPI.DocEditor("placeholder", {
|
||||
<ul>
|
||||
<li>С помощью запроса к <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/command.aspx")%>">командному сервису документов</a>, с параметром <em>c</em>, установленным в значение <b>forcesave</b>. Параметр <em>forcesavetype</em> будет иметь значение <b>0</b> при отправке запроса к <b>обработчику обратных вызовов</b>.</li>
|
||||
<li>Включите режим <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor/customization.aspx#forcesave")%>">editorConfig.customization.forcesave</a>, установив значение этого параметра равным <b>true</b> в конфигурации инициализации редактора. В этом случае, каждый раз, когда пользователь будет нажимать кнопку <b>Сохранить</b>, будет произведено принудительное сохранение, и параметр <em>forcesavetype</em> будет иметь значение <b>1</b>, когда запрос отправляется к <b>обработчику обратных вызовов</b>.</li>
|
||||
<li>Вы можете включить функцию повторения принудительного автосохранения на <b>Сервере документов</b> в дополнительном файле конфигурации, который может быть найден (в случае, если вы уже его создали) или помещён по следуюшему пути:<div>Для Linux - <em>/etc/r7office/documentserver/<b>default.json</b></em></div>
|
||||
<div>Для Windows - <em>%ProgramFiles%\R7OFFICE\DocumentServer\config\<b>default.json</b></em></div>
|
||||
<li>Вы можете включить функцию повторения принудительного автосохранения на <b>Сервере документов</b> в дополнительном файле конфигурации, который может быть найден (в случае, если вы уже его создали) или помещён по следуюшему пути:<div>Для Linux - <em>/etc/r7office/documentserver/<b>local.json</b></em></div>
|
||||
<div>Для Windows - <em>%ProgramFiles%\R7OFFICE\DocumentServer\config\<b>local.json</b></em></div>
|
||||
|
||||
<div class="header-gray">Параметры</div>
|
||||
|
||||
@ -131,11 +133,11 @@ new DocsAPI.DocEditor("placeholder", {
|
||||
<div class="header-gray">Пример файла конфигурации local.json</div>
|
||||
<pre>
|
||||
{
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"autoAssembly": {
|
||||
"enable": true,
|
||||
"interval": "5m"
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"autoAssembly": {
|
||||
"enable": true,
|
||||
"interval": "5m"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -12,8 +12,10 @@
|
||||
<div class="note">Эта функция используется в <b>Сервере документов</b>.</div>
|
||||
|
||||
<p>Для настройки проверки подлинности необходимо отредактировать файл конфигурации, который может быть найден (или создан) по следующему пути:</p>
|
||||
<div>Для Linux - <em>/etc/r7office/documentserver/<b>default.json</b></em></div>
|
||||
<div>Для Windows - <em>%ProgramFiles%\R7OFFICE\DocumentServer\config\<b>default.json</b></em></div>
|
||||
<div>Для Linux - <em>/etc/r7office/documentserver/<b>local.json</b></em></div>
|
||||
<div>Для Windows - <em>%ProgramFiles%\R7OFFICE\DocumentServer\config\<b>local.json</b></em></div>
|
||||
|
||||
<div class="note">Значения по умолчанию доступны в файле конфигурации <em>default.json</em>, который находится в вышеуказанных папках (для Linux и Windows). Пожалуйста, не редактируйте содержимое файла <em>default.json</em> напрямую. Значения по умолчанию будут перезаписаны каждый раз, когда вы перезапускаете Docker-контейнер или обновляете <b>Сервер документов</b> до новой версии, и все ваши изменения будут утеряны.</div>
|
||||
|
||||
<p>Перезапустите сервисы, чтобы изменения конфигурации вступили в силу:</p>
|
||||
|
||||
@ -47,7 +49,7 @@ supervisorctl restart all
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>services.CoAuthoring.secret.outbox.string</td>
|
||||
<td>Определяет <em>секретный ключ</em> для генерации токена в <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">запросах</a> <b>сервиса редактирования документов</b> к адресу "callbackUrl".</td>
|
||||
<td>Определяет <em>секретный ключ</em> для генерации токена в <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/signature/request.aspx")%>">запросах</a> <b>сервиса редактирования документов</b> к адресу "callbackUrl".</td>
|
||||
<td>строка</td>
|
||||
<td>secret</td>
|
||||
</tr>
|
||||
@ -76,22 +78,22 @@ supervisorctl restart all
|
||||
<div class="header-gray">Пример файла конфигурации local.json</div>
|
||||
<pre>
|
||||
{
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"secret": {
|
||||
"inbox": {
|
||||
"string": "secret"
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"secret": {
|
||||
"inbox": {
|
||||
"string": "secret"
|
||||
},
|
||||
"outbox": {
|
||||
"string": "secret"
|
||||
"outbox": {
|
||||
"string": "secret"
|
||||
},
|
||||
},
|
||||
"token": {
|
||||
"enable": {
|
||||
"browser": true,
|
||||
"request": {
|
||||
"inbox": true,
|
||||
"outbox": true
|
||||
"token": {
|
||||
"enable": {
|
||||
"browser": true,
|
||||
"request": {
|
||||
"inbox": true,
|
||||
"outbox": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -50,14 +50,14 @@
|
||||
<div class="header-gray">Пример файла конфигурации local.json</div>
|
||||
<pre>
|
||||
{
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"token": {
|
||||
"inbox": {
|
||||
"inBody": true,
|
||||
"services": {
|
||||
"CoAuthoring": {
|
||||
"token": {
|
||||
"inbox": {
|
||||
"inBody": true,
|
||||
},
|
||||
"outbox": {
|
||||
"inBody": true
|
||||
"outbox": {
|
||||
"inBody": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -75,8 +75,8 @@
|
||||
<div class="header-gray">Пример параметров запроса на получение статуса отредактированного документа</div>
|
||||
<pre>
|
||||
{
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
@ -89,7 +89,7 @@ Host: documentserver
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
|
||||
}
|
||||
</pre>
|
||||
|
||||
@ -100,11 +100,11 @@ Content-Type: application/json
|
||||
<div class="header-gray">Пример параметров запроса на конвертацию документа</div>
|
||||
<pre>
|
||||
{
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.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>
|
||||
@ -115,7 +115,7 @@ Host: documentserver
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxldHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwib3V0cHV0dHlwZSI6InBkZiIsInRpdGxlIjoiRXhhbXBsZSBEb2N1bWVudCBUaXRsZS5kb2N4IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.U-YAfuuy7clWjn-xOncfJ-sxVG5DlcYn0AOzJYkoR0M"
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxldHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwib3V0cHV0dHlwZSI6InBkZiIsInRpdGxlIjoiRXhhbXBsZSBEb2N1bWVudCBUaXRsZS5kb2N4IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.U-YAfuuy7clWjn-xOncfJ-sxVG5DlcYn0AOzJYkoR0M"
|
||||
}
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
@ -123,23 +123,23 @@ Content-Type: application/json
|
||||
|
||||
<h2>Исходящие запросы</h2>
|
||||
|
||||
<p id="callbackUrl" class="copy-link">Для исходящих запросов на адрес "<a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#callbackUrl")%>">callbackUrl</a>" проверка выполняется <b>сервисом редактирования документов</b>.</p>
|
||||
<p id="callbackUrl" class="copy-link">Для исходящих запросов на адрес "<a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#callbackUrl")%>">callbackUrl</a>" проверка выполняется <b>сервисом редактирования документов</b>.</p>
|
||||
|
||||
<div class="header-gray">Пример параметров запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<div class="header-gray">Пример параметров запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<pre>
|
||||
{
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
}
|
||||
</pre>
|
||||
<div class="header-gray">Пример запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<div class="header-gray">Пример запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<pre>
|
||||
POST url-to-callback.ashx HTTP/1.1
|
||||
Host: example.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwic3RhdHVzIjo0fQ.gCyNKPpg6ISAnhvFQmRiY6BRqG6WPcEGgnK79hREdkU"
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwic3RhdHVzIjo0fQ.gCyNKPpg6ISAnhvFQmRiY6BRqG6WPcEGgnK79hREdkU"
|
||||
}
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
@ -152,7 +152,7 @@ Content-Type: application/json
|
||||
<div class="header-gray">Пример данных для запроса к сервису хранения документов на скачивание файла</div>
|
||||
<pre>
|
||||
{
|
||||
"url: "http://example.com/url-to-example-document.docx"
|
||||
"url: "http://example.com/url-to-example-document.docx"
|
||||
}
|
||||
</pre>
|
||||
<div class="header-gray">Пример запроса к сервису хранения документов на скачивание файла</div>
|
||||
@ -162,5 +162,5 @@ Host: example.com
|
||||
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJodHRwOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQuZG9jeCJ9.-DBTpvYH2srNUc3Xy2N4QozEXO6VF1XS89K7Li0JM68
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
<p>Токен содержит данные (полную ссылку на документ, в примере выше это <em>{"url: "http://example.com/url-to-example-document.docx"}</em>), которая также дублирована в заголовке как <b>Host</b> (<em>example.com</em>) и адрес документа, к которому отправлен GET запрос (<em>url-to-example-document.docx</em>).</p>
|
||||
<p>Токен содержит данные (полную ссылку на документ, в примере выше это <em>{"url: "http://example.com/url-to-example-document.docx"}</em>), которая также дублирована в заголовке как <b>Host</b> (<em>example.com</em>) и адрес документа, к которому отправлен GET запрос (<em>url-to-example-document.docx</em>).</p>
|
||||
</div>
|
||||
@ -15,24 +15,24 @@
|
||||
|
||||
<pre>
|
||||
{
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"permissions": {
|
||||
"download": true,
|
||||
"edit": true,
|
||||
"print": true,
|
||||
"review": true
|
||||
"document": {
|
||||
"fileType": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"permissions": {
|
||||
"download": true,
|
||||
"edit": true,
|
||||
"print": true,
|
||||
"review": true
|
||||
},
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
},
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx",
|
||||
"mode": "edit",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иванов"
|
||||
"editorConfig": {
|
||||
"callbackUrl": "https://example.com/url-to-callback.ashx",
|
||||
"mode": "edit",
|
||||
"user": {
|
||||
"id": "78e1e841",
|
||||
"name": "Иванов"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -49,14 +49,14 @@
|
||||
|
||||
<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"
|
||||
"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
|
||||
"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>
|
||||
|
||||
@ -22,9 +22,9 @@
|
||||
<div class="header-gray">Пример данных запроса на получение статуса отредактированного документа</div>
|
||||
<pre>
|
||||
{
|
||||
"payload": {
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
"payload": {
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
@ -36,8 +36,8 @@ Content-Type: application/json
|
||||
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImMiOiJpbmZvIiwia2V5IjoiS2hpcno2elRQZGZkNyJ9fQ.hGQ8kquQWpg4MQYiSYaIzik0wotP1coAop6QfLruenA
|
||||
|
||||
{
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
"c": "info",
|
||||
"key": "Khirz6zTPdfd7"
|
||||
}
|
||||
</pre>
|
||||
|
||||
@ -47,12 +47,12 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImMiO
|
||||
<div class="header-gray">Пример данных запроса на конвертацию документа</div>
|
||||
<pre>
|
||||
{
|
||||
"payload": {
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"payload": {
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
@ -65,11 +65,11 @@ Content-Type: application/json
|
||||
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImZpbGV0eXBlIjoiZG9jeCIsImtleSI6IktoaXJ6NnpUUGRmZDciLCJvdXRwdXR0eXBlIjoicGRmIiwidGl0bGUiOiJFeGFtcGxlIERvY3VtZW50IFRpdGxlLmRvY3giLCJ1cmwiOiJodHRwOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQuZG9jeCJ9fQ.Ec50Gvafu4niR2I1LPgETn1jkvvs1wKm0YeeI1RbRQs
|
||||
|
||||
{
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.docx",
|
||||
"url": "https://example.com/url-to-example-document.docx"
|
||||
"filetype": "docx",
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"outputtype": "pdf",
|
||||
"title": "Пример названия документа.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>
|
||||
@ -77,18 +77,18 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImZpb
|
||||
|
||||
<h2>Исходящие запросы</h2>
|
||||
|
||||
<p id="callbackUrl" class="copy-link">Для исходящих запросов на адрес "<a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#callbackUrl")%>">callbackUrl</a>" проверка выполняется <b>сервисом редактирования документов</b>.</p>
|
||||
<p id="callbackUrl" class="copy-link">Для исходящих запросов на адрес "<a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx#callbackUrl")%>">callbackUrl</a>" проверка выполняется <b>сервисом редактирования документов</b>.</p>
|
||||
|
||||
<div class="header-gray">Пример данных запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<div class="header-gray">Пример данных запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<pre>
|
||||
{
|
||||
"payload": {
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
"payload": {
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
<div class="header-gray">Пример запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<div class="header-gray">Пример запроса на адрес "callbackUrl" сервисом редактирования документов, когда последний пользователь закрыл документ без изменений</div>
|
||||
<pre>
|
||||
POST url-to-callback.ashx HTTP/1.1
|
||||
Host: example.com
|
||||
@ -96,8 +96,8 @@ Content-Type: application/json
|
||||
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImtleSI6IktoaXJ6NnpUUGRmZDciLCJzdGF0dXMiOjR9fQ.MfVoGT-aYuPJfjQAaxwBv7-CqBylDae2AF9K5TpLf-E
|
||||
|
||||
{
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
"key": "Khirz6zTPdfd7",
|
||||
"status": 4
|
||||
}
|
||||
</pre>
|
||||
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
|
||||
|
||||
@ -27,8 +27,8 @@ Content-Type: application/json
|
||||
Accept: application/json
|
||||
|
||||
{
|
||||
"userName": "yourusername",
|
||||
"password": "yourpassword"
|
||||
"userName": "yourusername",
|
||||
"password": "yourpassword"
|
||||
}
|
||||
</pre>
|
||||
<div class="note">Обратите внимание, что необходимо ввести адрес вашего собственного портала в поле <em>Host: yourportal.r7-office.ru</em> вместо адреса yourportal.r7-office.ru.</div>
|
||||
@ -39,13 +39,13 @@ HTTP/1.1 201 Created
|
||||
Cache-Control: private
|
||||
Content-Type: application/json; charset=utf-8
|
||||
{
|
||||
"count": 1,
|
||||
"response": {
|
||||
"expires": "2010-07-07T17:06:03.5845502+03:00",
|
||||
"token": "sdjhfskjdhkqy739459234"
|
||||
"count": 1,
|
||||
"response": {
|
||||
"expires": "2010-07-07T17:06:03.5845502+03:00",
|
||||
"token": "sdjhfskjdhkqy739459234"
|
||||
},
|
||||
"status": 0,
|
||||
"statusCode": 201
|
||||
"status": 0,
|
||||
"statusCode": 201
|
||||
}
|
||||
</pre>
|
||||
</li>
|
||||
@ -67,11 +67,11 @@ Authorization:sdjhfskjdhkqy739459234
|
||||
|
||||
<div id="csharp" class="header-gray">Пример запроса авторизации на языке C#</div>
|
||||
<pre>
|
||||
var request = System.Net.WebRequest.Create("https://yourportal.r7-office.ru/api/2.0/authentication.json");
|
||||
request.Method = "POST";
|
||||
request.ContentType = "application/json";
|
||||
var request = System.Net.WebRequest.Create("https://yourportal.r7-office.ru/api/2.0/authentication.json");
|
||||
request.Method = "POST";
|
||||
request.ContentType = "application/json";
|
||||
|
||||
var body = "{\"userName\":\"yourusername\",\"password\":\"yourpassword\"}";
|
||||
var body = "{\"userName\":\"yourusername\",\"password\":\"yourpassword\"}";
|
||||
var data = System.Text.Encoding.UTF8.GetBytes(body);
|
||||
|
||||
request.ContentLength = data.Length;
|
||||
@ -87,7 +87,7 @@ var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
|
||||
|
||||
<div id="curl" class="header-gray">Пример запроса авторизации в формате cURL</div>
|
||||
<pre>
|
||||
curl --request POST --header "Content-Type: application/json" --data "{\"username\":\"yourusername\",\"password\":\"yourpassword\"}" "https://yourportal.r7-office.ru/api/2.0/authentication.json"
|
||||
curl --request POST --header "Content-Type: application/json" --data "{\"username\":\"yourusername\",\"password\":\"yourpassword\"}" "https://yourportal.r7-office.ru/api/2.0/authentication.json"
|
||||
</pre>
|
||||
<div class="note">Обратите внимание, что необходимо ввести адрес вашего собственного портала в поле <em>yourportal.r7-office.ru</em> вместо адреса yourportal.r7-office.ru.</div>
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@
|
||||
</h2>
|
||||
<p>
|
||||
<b>В случае успешного ответа будет возвращён статус-код в диапазоне 200</b> и, в случае, если в запросе не был задан формат, ответ в формате XML.
|
||||
Обратите внимание, что в случае, если в результате запроса должна быть создана новая запись (новый пост, комментарий и т.д.) статус ответа будет "201 Created".
|
||||
Обратите внимание, что в случае, если в результате запроса должна быть создана новая запись (новый пост, комментарий и т.д.) статус ответа будет "201 Created".
|
||||
При любой другой успешной операции (успешный запрос, удаление или обновление записи) код статуса ответа будет 200.
|
||||
</p>
|
||||
<p>
|
||||
@ -65,10 +65,5 @@
|
||||
В данной документации используются следующие условные обозначения:<br />
|
||||
<b>{text}</b>: означает, что текст в фигурных скобках должен быть заменён на ваши собственные данные (ID, поисковый запрос и т.д.)
|
||||
</p>
|
||||
<h2>Поддержка
|
||||
</h2>
|
||||
<p>
|
||||
Вы можете задать вопрос нашим разработчикам по адресу <a href="http://dev.onlyoffice.org/viewforum.php?f=9" target="_blank">dev.onlyoffice.org</a> (необходима регистрация).
|
||||
</p>
|
||||
|
||||
</div>
|
||||
@ -39,12 +39,12 @@
|
||||
<pre>
|
||||
batch = [
|
||||
{
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/people/@self"
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/people/@self"
|
||||
},
|
||||
{
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/group/@self"
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/group/@self"
|
||||
}
|
||||
]
|
||||
</pre>
|
||||
@ -58,20 +58,20 @@ batch = [
|
||||
|
||||
<pre>
|
||||
{
|
||||
"count": 1,
|
||||
"startIndex": 0,
|
||||
"status": 0,
|
||||
"statusCode": 200,
|
||||
"response": [
|
||||
"count": 1,
|
||||
"startIndex": 0,
|
||||
"status": 0,
|
||||
"statusCode": 200,
|
||||
"response": [
|
||||
{
|
||||
"status": 200,
|
||||
"headers": {
|
||||
"x-AspNet-Version": "2.0.50727",
|
||||
"access-Control-Allow-Origin": "*",
|
||||
"cache-Control": "private, max-age=0",
|
||||
"content-Type": "application/json; charset=UTF-8"
|
||||
"status": 200,
|
||||
"headers": {
|
||||
"x-AspNet-Version": "2.0.50727",
|
||||
"access-Control-Allow-Origin": "*",
|
||||
"cache-Control": "private, max-age=0",
|
||||
"content-Type": "application/json; charset=UTF-8"
|
||||
},
|
||||
"data": "{\"count\": 1, \"startIndex\": 0, \"status\": 0, \"statusCode\": 200, \"response\": {\"id\": \"293bb997-28d8-4be0-8547-6eb50add1f3c\", \"userName\": \"Иван.Петров\", \"firstName\": \"Иван\", \"lastName\": \"Петров\", \"email\": \"ivan@gmail.com\", \"birthday\": \"1974-05-16T05:00:00.0000000+05:00\", \"sex\": \"male\", \"status\": 1, \"terminated\": null, \"department\": \"Пример группы\", \"workFrom\": \"2007-10-09T05:00:00.0000000+05:00\", \"location\": \"\", \"notes\": \"\", \"displayName\": \"Иван Петров\", \"title\": \"Управляющий\", \"contacts\": [], \"groups\": [{\"id\": \"eeb47881-6330-4b6d-8a32-82366d4caf27\", \"name\": \"Пример группы\", \"manager\": \"Елена.Иванова\"}], \"avatarMedium\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_48-48.jpeg\", \"avatar\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_82-82.jpeg\", \"avatarSmall\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_32-32.jpeg\"}}"
|
||||
"data": "{\"count\": 1, \"startIndex\": 0, \"status\": 0, \"statusCode\": 200, \"response\": {\"id\": \"293bb997-28d8-4be0-8547-6eb50add1f3c\", \"userName\": \"Иван.Петров\", \"firstName\": \"Иван\", \"lastName\": \"Петров\", \"email\": \"ivan@gmail.com\", \"birthday\": \"1974-05-16T05:00:00.0000000+05:00\", \"sex\": \"male\", \"status\": 1, \"terminated\": null, \"department\": \"Пример группы\", \"workFrom\": \"2007-10-09T05:00:00.0000000+05:00\", \"location\": \"\", \"notes\": \"\", \"displayName\": \"Иван Петров\", \"title\": \"Управляющий\", \"contacts\": [], \"groups\": [{\"id\": \"eeb47881-6330-4b6d-8a32-82366d4caf27\", \"name\": \"Пример группы\", \"manager\": \"Елена.Иванова\"}], \"avatarMedium\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_48-48.jpeg\", \"avatar\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_82-82.jpeg\", \"avatarSmall\": \"/data/0/userphotos/eeb47881-6330-4b6d-8a32-82366d4caf27_size_32-32.jpeg\"}}"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -87,13 +87,13 @@ batch = [
|
||||
<pre>
|
||||
batch = [
|
||||
{
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/people/@self"
|
||||
"method": "GET",
|
||||
"relativeUrl": "/api/2.0/people/@self"
|
||||
},
|
||||
{
|
||||
"method": "POST",
|
||||
"relativeUrl": "/api/2.0/people/{userid}/contacts",
|
||||
"body": "contacts[0].Type=skype&contacts[0].Value=skypename&contacts[1].Type=msn&contacts[1].Value=msn_login"
|
||||
"method": "POST",
|
||||
"relativeUrl": "/api/2.0/people/{userid}/contacts",
|
||||
"body": "contacts[0].Type=skype&contacts[0].Value=skypename&contacts[1].Type=msn&contacts[1].Value=msn_login"
|
||||
}
|
||||
]
|
||||
</pre>
|
||||
|
||||
@ -49,7 +49,7 @@
|
||||
<tr class="tablerow">
|
||||
<td>sortOrder</td>
|
||||
<td>
|
||||
Направление сортировки. Может принимать значения "descending" или "ascending". Например, с параметром sortBy используется:<br/>
|
||||
Направление сортировки. Может принимать значения "descending" или "ascending". Например, с параметром sortBy используется:<br/>
|
||||
<a href="<%=VirtualPathUtility.ToAbsolute("~/api/portals/section.aspx?section=people")%>">api/2.0/people?sortBy=userName&sortOrder=descending</a>
|
||||
</td>
|
||||
</tr>
|
||||
@ -59,7 +59,7 @@
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>filterOp</td>
|
||||
<td>Операция фильтрации. Может принимать одно из следующих значений: "contains","equals","startsWith","present"</td>
|
||||
<td>Операция фильтрации. Может принимать одно из следующих значений: "contains","equals","startsWith","present"</td>
|
||||
</tr>
|
||||
<tr class="tablerow">
|
||||
<td>filterValue</td>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/batch.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/faq.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/filters.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/method.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/section.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/auth.ascx" />
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<body class="api_documentation community_server_api">
|
||||
</asp:Content>
|
||||
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Р7-Офис. Сервер</a></h5>
|
||||
<h5><a href="<%= VirtualPathUtility.ToAbsolute("~/api/portals/index.aspx") %>">Сервер совместной работы Р7-Офис</a></h5>
|
||||
</asp:Content>
|
||||
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
|
||||
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Portals/Basic.ascx" />
|
||||
|
||||
Loading…
Reference in New Issue
Block a user