helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.xml
2019-02-25 13:59:30 +03:00

946 lines
60 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>ASC.Api.Documents</name>
</assembly>
<members>
<member name="M:ASC.Api.Documents.BlockchainApi.UpdateData(System.String,System.String)">
<summary>
</summary>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.BlockchainApi.GetAccessAddresses(System.String)">
<summary>
</summary>
<visible>false</visible>
</member>
<member name="T:ASC.Api.Documents.DocumentsApi">
<summary>Предоставляет доступ к документам</summary>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.#ctor(ASC.Api.Impl.ApiContext,ASC.Web.Files.Services.WCFService.IFileStorageService)">
<summary>
</summary>
<param name="context"></param>
<param name="fileStorageService"></param>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetMyFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в разделе &quot;Мои документы&quot; текущего пользователя</summary>
<short>Моя папка</short>
<category>Папки</category>
<returns>Содержимое моей папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetProjectsFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в разделе &quot;Документы проекта&quot; текущего пользователя</summary>
<short>Папка проектов</short>
<category>Папки</category>
<returns>Содержимое папки проектов</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetCommonFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в разделе &quot;Общие документы&quot; текущего пользователя</summary>
<short>Общая папка</short>
<category>Папки</category>
<returns>Содержимое общей папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetShareFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в разделе &quot;Доступные для меня&quot; текущего пользователя</summary>
<short>Папка общего доступа</short>
<category>Папки</category>
<returns>Содержимое папки общего доступа</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetTrashFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в разделе &quot;Корзина&quot;</summary>
<short>Папка для мусора</short>
<category>Папки</category>
<returns>Содержимое папки для мусора</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolder(System.String,System.Guid,ASC.Files.Core.FilterType)">
<summary>Возвращает подробный список файлов и папок в папке с указанным в запросе ИД</summary>
<short>Папка по ИД</short>
<category>Папки</category>
<param name="folderId">ИД папки</param>
<param name="userIdOrGroupId" optional="true">ИД пользователя или группы</param>
<param name="filterType" optional="true" remark="Allowed values: None (0), FilesOnly (1), FoldersOnly (2), DocumentsOnly (3), PresentationsOnly (4), SpreadsheetsOnly (5) or ImagesOnly (7)">Тип фильтра</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UploadFileToMy(System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Загружает указанный файл в раздел &quot;Мои документы&quot; с помощью метода загрузки одного файла или стандартного метода multipart/form-data</summary>
<short>Загрузить в мои</short>
<category>Загрузки</category>
<remarks>
<![CDATA[
Загрузка может выполняться 2 разными способами:
<ol>
<li>Загрузка одного файла. Необходимо задать заголовки Content-Type и Content-Disposition, чтобы указать имя файла и тип контента, а затем отправить файл в теле запроса</li>
<li>С помощью стандартного метода multipart/form-data</li>
</ol>]]>
</remarks>
<param name="file" visible="false">Запросить входной поток</param>
<param name="contentType" visible="false">Заголовок Content-Type</param>
<param name="contentDisposition" visible="false">Заголовок Content-Disposition</param>
<param name="files" visible="false">Список файлов, отправляемых методом multipart/form-data</param>
<returns>Загруженный файл</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UploadFileToCommon(System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
<summary>Загружает указанный файл в раздел &quot;Общие документы&quot; с помощью метода загрузки одного файла или стандартного метода multipart/form-data</summary>
<short>Загрузить в общие</short>
<category>Загрузки</category>
<remarks>
<![CDATA[
Загрузка может выполняться 2 разными способами:
<ol>
<li>Загрузка одного файла. Необходимо задать заголовки Content-Type и Content-Disposition, чтобы указать имя файла и тип контента, а затем отправить файл в теле запроса</li>
<li>С помощью стандартного метода multipart/form-data</li>
</ol>]]>
</remarks>
<param name="file" visible="false">Запросить входной поток</param>
<param name="contentType" visible="false">Заголовок Content-Type</param>
<param name="contentDisposition" visible="false">Заголовок Content-Disposition</param>
<param name="files" visible="false">Список файлов, отправляемых методом multipart/form-data</param>
<returns>Загруженный файл</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UploadFile(System.String,System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase},System.Nullable{System.Boolean},System.Boolean,System.Boolean)">
<summary>Загружает указанный файл в выбранную папку с помощью метода загрузки одного файла или стандартного метода multipart/form-data</summary>
<short>Загрузить в папку</short>
<category>Загрузки</category>
<remarks>
<![CDATA[
Загрузка может выполняться 2 разными способами:
<ol>
<li>Загрузка одного файла. Необходимо задать заголовки Content-Type и Content-Disposition, чтобы указать имя файла и тип контента, а затем отправить файл в теле запроса</li>
<li>С помощью стандартного метода multipart/form-data</li>
</ol>]]>
</remarks>
<param name="folderId">ИД папки, в которую выполняется загрузка</param>
<param name="file" visible="false">Запросить входной поток</param>
<param name="contentType" visible="false">Заголовок Content-Type</param>
<param name="contentDisposition" visible="false">Заголовок Content-Disposition</param>
<param name="files" visible="false">Список файлов, отправляемых методом multipart/form-data</param>
<param name="createNewIfExist" visible="false">Создать новый при наличии</param>
<param name="storeOriginalFileFlag" visible="false">Если значение — True, загружать документы также в оригинальном формате</param>
<param name="keepConvertStatus" visible="false">Сохранять беседу о статусе после завершения</param>
<returns>Загруженный файл</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToMy(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>Загружает указанный файл методом загрузки одного файла в раздел &quot;Общие документы&quot;</summary>
<param name="file" visible="false">Запросить входной поток</param>
<param name="title">Имя загружаемого файла</param>
<param name="createNewIfExist" visible="false">Создать новый при наличии</param>
<param name="keepConvertStatus" visible="false">Сохранять разговор о статусе после завершения</param>
<category>Загрузки</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToCommon(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>Загружает указанный файл методом загрузки одного файла в раздел &quot;Общие документы&quot;</summary>
<param name="file" visible="false">Запросить входной поток</param>
<param name="title">Имя загружаемого файла</param>
<param name="createNewIfExist" visible="false">Создать новый при наличии</param>
<param name="keepConvertStatus" visible="false">Сохранять беседу о статусе после завершения</param>
<category>Загрузки</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFile(System.String,System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>Загружает указанный файл методом загрузки одного файла</summary>
<param name="folderId">ИД папки, в которую выполняется загрузка</param>
<param name="file" visible="false">Запросить входной поток</param>
<param name="title">Имя загружаемого файла</param>
<param name="createNewIfExist" visible="false">Создать новый при наличии</param>
<param name="keepConvertStatus" visible="false">Сохранять беседу о статусе после завершения</param>
<category>Загрузки</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.SaveEditing(System.String,System.String,System.String,System.IO.Stream,System.String)">
<summary>
</summary>
<param name="fileId">ИД файла</param>
<param name="fileExtension"></param>
<param name="downloadUri"></param>
<param name="stream"></param>
<param name="doc"></param>
<category>Файлы</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.StartEdit(System.String,System.Boolean,System.String)">
<summary>
</summary>
<param name="fileId">ИД файла</param>
<param name="editingAlone"></param>
<param name="doc"></param>
<category>Файлы</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.TrackEditFile(System.String,System.Guid,System.String,System.String,System.Boolean)">
<summary>
</summary>
<param name="fileId">ИД файла</param>
<param name="tabId"></param>
<param name="docKeyForTrack"></param>
<param name="doc"></param>
<param name="isFinish"></param>
<category>Файлы</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.OpenEdit(System.String,System.Int32,System.String)">
<summary>
</summary>
<param name="fileId">ИД файла</param>
<param name="version"></param>
<param name="doc"></param>
<category>Файлы</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateUploadSession(System.String,System.String,System.Int64,System.String)">
<summary>Создает сессию для загрузки больших файлов несколькими порциями.</summary>
<short>Поэтапная загрузка</short>
<category>Загрузки</category>
<param name="folderId">ИД папки, в которую загружается файл</param>
<param name="fileName">Имя загружаемого файла</param>
<param name="fileSize">Размер загружаемого файла в байтах</param>
<param name="relativePath">Относительная папка из folderId</param>
<remarks>
<![CDATA[
Размер каждой порции данных может быть разным. Но важно помнить, что он должен быть кратен <b>512</b> и составлять не менее <b>5 МБ</b>. Последняя порция данных может быть любого размера.
После ответа на начальный запрос со статусом "200 OK" вам необходимо узнать значение поля "location" (местоположение) в ответе. Отправьте все свои порции в это местоположение.
Каждую порцию данных требуется отправлять, строго соблюдая порядок их расположения в файле.
Если после получения каждой порции данных ошибок не произошло, сервер отправит ответ с текущей информацией о сеансе загрузки.
Когда количество загруженных байтов равно количеству байтов, отправленных вами в начальном запросе, сервер отправит ответ "201 Created", а также отправит вам сведения о загруженном файле.
]]>
</remarks>
<returns>
<![CDATA[
Информация о созданной сессии. А именно:
<ul>
<li><b>id:</b> уникальный ИД этой сессии загрузки</li>
<li><b>created:</b> время создания сессии в формате UTC</li>
<li><b>expired:</b> время окончания сессии в формате UTC, которое происходит, если к этому моменту не были отправлены порции данных</li>
<li><b>location:</b> URL-адрес, по которому вам нужно отправить следующую порцию данных</li>
<li><b>bytes_uploaded:</b> Если параметр существует, он содержит количество байтов, загруженное для определенного ИД загрузки</li>
<li><b>bytes_total:</b> Количество загружаемых байтов</li>
</ul>
]]>
</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFileInMy(System.String,System.String)">
<summary>Создает в разделе &quot;Мои документы&quot; текстовый файл (.txt) с названием и содержимым из отправленного запроса</summary>
<short>Создать txt в &quot;Моих&quot;</short>
<category>Создание файла</category>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFileInCommon(System.String,System.String)">
<summary>Создает в разделе &quot;Общие документы&quot; текстовый файл (.txt) с названием и содержимым из отправленного запроса</summary>
<short>Создать txt в &quot;Общих&quot;</short>
<category>Создание файла</category>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFile(System.String,System.String,System.String)">
<summary>Создает в выбранной папке текстовый файл (.txt) с названием и содержимым из отправленного запроса</summary>
<short>Создать txt</short>
<category>Создание файла</category>
<param name="folderId">ИД папки</param>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFile(System.String,System.String,System.String)">
<summary>Создает в выбранной папке файл HTML (.html) с названием и содержимым из отправленного запроса</summary>
<short>Создать html</short>
<category>Создание файла</category>
<param name="folderId">ИД папки</param>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFileInMy(System.String,System.String)">
<summary>Создает в папке &quot;Мои документы&quot; файл HTML (.html) с названием и содержимым из отправленного запроса</summary>
<short>Создать html в &quot;Моих&quot;</short>
<category>Создание файла</category>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFileInCommon(System.String,System.String)">
<summary>Создает в папке &quot;Общие документы&quot; файл HTML (.html) с названием и содержимым из отправленного запроса</summary>
<short>Создать html в &quot;Общих&quot;</short>
<category>Создание файла</category>
<param name="title">Название файла</param>
<param name="content">Содержимое файла</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFolder(System.String,System.String)">
<summary>Создает новую папку с названием из отправленного запроса. Можно также указать ИД родительской папки.</summary>
<short>Новая папка</short>
<category>Папки</category>
<param name="folderId">ИД родительской папки</param>
<param name="title">Название новой папки</param>
<returns>Содержимое новой папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFile(System.String)">
<summary>Создает в разделе &quot;Мои документы&quot; новый файл с названием из отправленного запроса</summary>
<short>Создать файл</short>
<category>Создание файла</category>
<param name="title" remark="Allowed values: the file must have one of the following extensions: DOCX, XLSX, PPTX">Название файла</param>
<remarks>В том случае, когда расширение файла отличается от DOCX, XLSX и PPTX, принадлежит к одному из известных форматов текста, электронной таблицы или презентации, оно будет заменено расширениями DOCX, XLSX и PPTX соответственно. Если расширение файла не задано или неизвестно, к названию файла будет добавлено расширение DOCX.</remarks>
<returns>Сведения о новом файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFile(System.String,System.String)">
<summary>Создает новый файл в указанной папке с названием из отправленного запроса</summary>
<short>Создать файл</short>
<category>Создание файла</category>
<param name="folderId">ИД папки</param>
<param name="title" remark="Allowed values: the file must have one of the following extensions: DOCX, XLSX, PPTX">Название файла</param>
<remarks>В том случае, когда расширение файла отличается от DOCX, XLSX и PPTX, принадлежит к одному из известных форматов текста, электронной таблицы или презентации, оно будет заменено расширениями DOCX, XLSX и PPTX соответственно. Если расширение файла не задано или неизвестно, к названию файла будет добавлено расширение DOCX.</remarks>
<returns>Сведения о новом файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.RenameFolder(System.String,System.String)">
<summary>Переименовывает выбранную папку, присваивая новое название, указанное в запросе</summary>
<short>Переименовать папку</short>
<category>Папки</category>
<param name="folderId">ИД папки</param>
<param name="title">Новое название</param>
<returns>Содержимое папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderInfo(System.String)">
<summary>Возвращает подробные сведения о папке с указанным в запросе ИД</summary>
<short>Информация о папке</short>
<category>Папки</category>
<returns>Сведения о папке</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderPath(System.String)">
<summary>Возвращает родительские папки</summary>
<param name="folderId"></param>
<category>Папки</category>
<returns>Родительские папки</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileInfo(System.String,System.Int32)">
<summary>Возвращает подробные сведения о файле с указанным в запросе ИД</summary>
<short>Информация о файле</short>
<category>Файлы</category>
<returns>Сведения о файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UpdateFile(System.String,System.String,System.Int32)">
<summary>Обновляет информацию о выбранном файле, изменяя указанные в запросе параметры</summary>
<short>Обновить сведения о файле</short>
<category>Файлы</category>
<param name="fileId">ИД файла</param>
<param name="title">Новое название</param>
<param name="lastVersion">Номер последней версии файла</param>
<returns>Сведения о файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteFile(System.String,System.Boolean,System.Boolean)">
<summary>Удаляет файл с указанным в запросе ИД</summary>
<short>Удалить файл</short>
<category>Файлы</category>
<param name="fileId">ИД файла</param>
<param name="deleteAfter">Удалить после завершения</param>
<param name="immediately">Не перемещать в &quot;Корзину&quot;</param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.StartConversion(System.String)">
<summary>Начать беседу</summary>
<short>Преобразовать</short>
<category>Операции с файлом</category>
<param name="fileId"></param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CheckConversion(System.String,System.Boolean)">
<summary>Проверить результат преобразования</summary>
<short>Преобразовать</short>
<category>Операции с файлом</category>
<param name="fileId"></param>
<param name="start"></param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetPresignedUri(System.String)">
<summary>Получить предварительно подписанный универсальный код ресурса (URI)</summary>
<param name="fileId">ИД файла</param>
<returns>URL-адрес</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteFolder(System.String,System.Boolean,System.Boolean)">
<summary>Удаляет папку с указанным в запросе ИД</summary>
<short>Удалить папку</short>
<category>Папки</category>
<param name="folderId">ИД папки</param>
<param name="deleteAfter">Удалить после завершения</param>
<param name="immediately">Не перемещать в &quot;Корзину&quot;</param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.MoveOrCopyBatchCheck(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>Проверка наличия конфликтов</summary>
<category>Операции с файлом</category>
<param name="destFolderId">ИД папки назначения</param>
<param name="folderIds">Список ИД папок</param>
<param name="fileIds">Список ИД файлов</param>
<returns>ИД файла конфликтов</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.MoveBatchItems(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},ASC.Web.Files.Services.WCFService.FileOperations.FileConflictResolveType,System.Boolean)">
<summary>Перемещает все выбранные файлы и папки в папку с указанным в запросе ИД</summary>
<short>Переместить в папку</short>
<category>Операции с файлом</category>
<param name="destFolderId">ИД папки назначения</param>
<param name="folderIds">Список ИД папок</param>
<param name="fileIds">Список ИД файлов</param>
<param name="conflictResolveType">Поведение при перезаписи: пропустить(0), перезаписать(1) или дублировать(2)</param>
<param name="deleteAfter">Удалить после завершения</param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CopyBatchItems(System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},ASC.Web.Files.Services.WCFService.FileOperations.FileConflictResolveType,System.Boolean)">
<summary>Копирует все выбранные файлы и папки в папку с указанным в запросе ИД</summary>
<short>Копировать в папку</short>
<category>Операции с файлом</category>
<param name="destFolderId">ИД папки назначения</param>
<param name="folderIds">Список ИД папок</param>
<param name="fileIds">Список ИД файлов</param>
<param name="conflictResolveType">Поведение при перезаписи: пропустить(0), перезаписать(1) или дублировать(2)</param>
<param name="deleteAfter">Удалить после завершения</param>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.MarkAsRead(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>Помечает все файлы и папки как прочтенные</summary>
<short>Пометить как прочтенные</short>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.TerminateTasks">
<summary>Завершает все активные операции с файлом</summary>
<short>Завершить все</short>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetOperationStatuses">
<summary>Возвращает список всех активных операций с файлом</summary>
<short>Получить список операций с файлом</short>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.BulkDownload(System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>Начать процесс загрузки файлов и папок с ИД</summary>
<short>Завершить операции с файлом</short>
<param name="fileConvertIds" visible="false">Список ИД файлов для загрузки и преобразования в тот или иной формат</param>
<param name="fileIds">Список ИД файлов</param>
<param name="folderIds">Список ИД папок</param>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteBatchItems(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Boolean)">
<summary>Удаляет файлы и папки, ИД которых указаны в запросе</summary>
<param name="folderIds">Список ИД папок</param>
<param name="fileIds">Список ИД файлов</param>
<param name="deleteAfter">Удалить после завершения</param>
<param name="immediately">Не перемещать в &quot;Корзину&quot;</param>
<short>Удалить файлы и папки</short>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.EmptyTrash">
<summary>Удаляет все файлы и папки из корзины</summary>
<short>Очистить корзину</short>
<category>Операции с файлом</category>
<returns>Результат операции</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileVersionInfo(System.String)">
<summary>Возвращает подробные сведения обо всех доступных версиях файла с указанным в запросе ИД</summary>
<short>Версии файла</short>
<category>Файлы</category>
<param name="fileId">ИД файла</param>
<returns>Сведения о файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.ChangeHistory(System.String,System.Int32,System.Boolean)">
<summary>Изменить журнал версий</summary>
<param name="fileId">ИД файла</param>
<param name="version">Версия журнала</param>
<param name="continueVersion">Пометить как версию или редакцию</param>
<category>Файлы</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileSecurityInfo(System.String)">
<summary>Возвращает подробные сведения об общем файле с указанным в запросе ИД</summary>
<short>Общий доступ к файлам</short>
<category>Доступ</category>
<param name="fileId">ИД файла</param>
<returns>Информация об общем файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderSecurityInfo(System.String)">
<summary>Возвращает подробные сведения об общей папке с указанным в запросе ИД</summary>
<short>Общий доступ к папке</short>
<param name="folderId">ИД папки</param>
<category>Доступ</category>
<returns>Информация об общей папке</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.SetFileSecurityInfo(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Documents.FileShareParams},System.Boolean,System.String)">
<summary>Задает настройки общего доступа к файлу с указанным в запросе ИД</summary>
<param name="fileId">ИД файла</param>
<param name="share">Коллекция прав общего доступа</param>
<param name="notify">Людей нужно уведомлять</param>
<param name="sharingMessage">Отправляемое в ходе уведомления сообщение об общем доступе</param>
<short>Поделиться файлом</short>
<category>Доступ</category>
<remarks>Каждый из параметров FileShareParams должен содержать по два параметра: &quot;ShareTo&quot; — ИД пользователя, с которым мы хотим поделиться, и &quot;Access&quot; — тип доступа, который мы хотим предоставить пользователю (для чтения, для чтения и записи и т. д.)</remarks>
<returns>Информация об общем файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.SetFolderSecurityInfo(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Documents.FileShareParams},System.Boolean,System.String)">
<summary>Задает настройки общего доступа к папке с указанным в запросе ИД</summary>
<short>Поделиться папкой</short>
<param name="folderId">ИД папки</param>
<param name="share">Коллекция прав общего доступа</param>
<param name="notify">Людей нужно уведомлять</param>
<param name="sharingMessage">Отправляемое в ходе уведомления сообщение об общем доступе</param>
<remarks>Каждый из параметров FileShareParams должен содержать по два параметра: &quot;ShareTo&quot; — ИД пользователя, с которым мы хотим поделиться, и &quot;Access&quot; — тип доступа, который мы хотим предоставить пользователю (для чтения, для чтения и записи и т. д.)</remarks>
<category>Доступ</category>
<returns>Информация об общей папке</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.RemoveSecurityInfo(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>Лишает группу с указанным в запросе ИД прав общего доступа</summary>
<param name="folderIds">ИД папок</param>
<param name="fileIds">ИД файлов</param>
<short>Лишить группу прав общего доступа</short>
<category>Доступ</category>
<returns>Информация об общем файле</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GenerateSharedLink(System.String,ASC.Files.Core.Security.FileShare)">
<summary>Возвращает внешнюю ссылку на общий файл с указанным в запросе ИД</summary>
<summary>Внешняя ссылка на файл</summary>
<param name="fileId">ИД файла</param>
<param name="share">Право доступа</param>
<category>Файлы</category>
<returns>Ссылка на общий файл</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.SaveThirdParty(System.String,System.String,System.String,System.String,System.Boolean,System.String,System.String,System.String)">
<summary>Сохраняет учетную запись сторонней службы хранилища файлов</summary>
<short>Сохранить стороннюю учетную запись</short>
<param name="url">URL-адрес подключения к SharePoint</param>
<param name="login">Логин</param>
<param name="password">Пароль</param>
<param name="token">Токен аутентификации</param>
<param name="isCorporate"></param>
<param name="customerTitle">Название</param>
<param name="providerKey">Ключ поставщика</param>
<param name="providerId">ИД поставщика</param>
<category>Интеграция со сторонними службами</category>
<returns>Содержимое папки</returns>
<remarks>Список ключей поставщиков: DropboxV2, Box, WebDav, Yandex, OneDrive, SharePoint, GoogleDrive</remarks>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetThirdPartyAccounts">
<summary>Возвращает список всех подключенных сторонних служб</summary>
<category>Интеграция со сторонними службами</category>
<short>Получить список сторонних служб</short>
<returns>Подключенные поставщики</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetCommonThirdPartyFolders">
<summary>Возвращает список сторонних служб, подключенных в разделе &quot;Общие документы&quot;</summary>
<category>Интеграция со сторонними службами</category>
<short>Получить папку сторонних служб</short>
<returns>Папка подключенных поставщиков</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteThirdParty(System.Int32)">
<summary>Удаляет учетную запись сторонней службы хранилища файлов с указанным в запросе ИД</summary>
<param name="providerId">ИД поставщика. ИД поставщика входит в состав ИД папки. Например, если ИД папки — &quot;sbox-123&quot;, то ИД поставщика — &quot;123&quot;</param>
<short>Удалить стороннюю учетную запись</short>
<category>Интеграция со сторонними службами</category>
<returns>ИД папки</returns>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.Search(System.String)">
<summary>
</summary>
<param name="query"></param>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.StoreOriginal(System.Boolean)">
<summary>
</summary>
<param name="set"></param>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UpdateIfExist(System.Boolean)">
<summary>
</summary>
<param name="set"></param>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CheckDocServiceUrl(System.String,System.String,System.String)">
<summary>Проверка местоположения службы документов</summary>
<param name="docServiceUrl">Домен службы редактирования документов</param>
<param name="docServiceUrlInternal">Домен службы управления документами</param>
<param name="docServiceUrlPortal">Адрес сервера сообществ</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetDocServiceUrl(System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetThirdpartyProvider">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetWordpressInfo">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteWordpressInfo">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.WordpressSave(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateWordpressPost(System.String,System.String,System.String,System.Int32)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetEasybibCitationList(System.Int32,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetEasybibStyles">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.EasyBibCitationBook(System.String)">
<visible>false</visible>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.Name">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.DocumentsApi.ConversationResult">
<summary>Результат операции преобразования файла.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Id">
<summary>ИД операции.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.OperationType">
<summary>Тип операции.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Progress">
<summary>Ход выполнения операции.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Source">
<summary>Исходные файлы для операции.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.File">
<summary>Файл результата операции.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Error">
<summary>Ошибка во время беседы.</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Processed">
<summary>Сведения об обработке операции.</summary>
</member>
<member name="T:ASC.Api.Documents.FileEntryWrapper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileEntryWrapper.#ctor(ASC.Files.Core.FileEntry)">
<summary>
</summary>
<param name="entry"></param>
</member>
<member name="M:ASC.Api.Documents.FileEntryWrapper.#ctor">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Id">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Title">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Access">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Shared">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Created">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.CreatedBy">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.Updated">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.RootFolderType">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.UpdatedBy">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.ProviderItem">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileEntryWrapper.ProviderKey">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FileShareParams">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileShareParams.ToAceObject">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FileShareParams.ShareTo">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileShareParams.Access">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FileShareWrapper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileShareWrapper.#ctor(ASC.Web.Files.Services.WCFService.AceWrapper)">
<summary>
</summary>
<param name="aceWrapper"></param>
</member>
<member name="M:ASC.Api.Documents.FileShareWrapper.GetSample">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FileShareWrapper.Access">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileShareWrapper.SharedTo">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileShareWrapper.IsLocked">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileShareWrapper.IsOwner">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FileShareLink">
<summary>
</summary>
</member>
<member name="F:ASC.Api.Documents.FileShareLink.Id">
<summary>
</summary>
</member>
<member name="F:ASC.Api.Documents.FileShareLink.ShareLink">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FileWrapper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileWrapper.#ctor(ASC.Files.Core.File)">
<summary>
</summary>
<param name="file"></param>
</member>
<member name="M:ASC.Api.Documents.FileWrapper.GetSample">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.FolderId">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.Version">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.VersionGroup">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.ContentLength">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.PureContentLength">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.FileStatus">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.ViewUrl">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.WebUrl">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.FileType">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.FileExst">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.Comment">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.Encrypted">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FolderContentWrapper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FolderContentWrapper.#ctor(ASC.Web.Files.Services.WCFService.DataWrapper,System.Int32)">
<summary>
</summary>
<param name="folderItems"></param>
<param name="startIndex"></param>
</member>
<member name="M:ASC.Api.Documents.FolderContentWrapper.GetSample">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.Files">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.Folders">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.Current">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.PathParts">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.StartIndex">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.Count">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderContentWrapper.Total">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FileOperationWraper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileOperationWraper.#ctor">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FileOperationWraper.#ctor(ASC.Web.Files.Services.WCFService.FileOperations.FileOperationResult)">
<summary>
</summary>
<param name="o"></param>
</member>
<member name="M:ASC.Api.Documents.FileOperationWraper.GetSample">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Id">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.OperationType">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Progress">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Error">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Processed">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Finished">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Url">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Files">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileOperationWraper.Folders">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FolderWrapper">
<summary>
</summary>
</member>
<member name="M:ASC.Api.Documents.FolderWrapper.#ctor(ASC.Files.Core.Folder)">
<summary>
</summary>
<param name="folder"></param>
</member>
<member name="M:ASC.Api.Documents.FolderWrapper.GetSample">
<summary>
</summary>
<returns></returns>
</member>
<member name="P:ASC.Api.Documents.FolderWrapper.ParentId">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderWrapper.FilesCount">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderWrapper.FoldersCount">
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FolderWrapper.IsShareable">
<summary>
</summary>
</member>
</members>
</doc>