helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.xml
2019-02-14 15:43:24 +03:00

1097 lines
51 KiB
XML

<?xml version="1.0"?>
<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>
Provides access to documents
</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>
Returns the detailed list of files and folders located in the current user 'My Documents' section
</summary>
<short>
My folder
</short>
<category>Folders</category>
<returns>My folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetProjectsFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>
Returns the detailed list of files and folders located in the current user 'Projects Documents' section
</summary>
<short>
Projects folder
</short>
<category>Folders</category>
<returns>Projects folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetCommonFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>
Returns the detailed list of files and folders located in the 'Common Documents' section
</summary>
<short>
Common folder
</short>
<category>Folders</category>
<returns>Common folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetShareFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>
Returns the detailed list of files and folders located in the 'Shared with Me' section
</summary>
<short>
Shared folder
</short>
<category>Folders</category>
<returns>Shared folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetTrashFolder(System.Guid,ASC.Files.Core.FilterType)">
<summary>
Returns the detailed list of files and folders located in the 'Recycle Bin' section
</summary>
<short>
Trash folder
</short>
<category>Folders</category>
<returns>Trash folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolder(System.String,System.Guid,ASC.Files.Core.FilterType)">
<summary>
Returns the detailed list of files and folders located in the folder with the ID specified in the request
</summary>
<short>
Folder by ID
</short>
<category>Folders</category>
<param name="folderId">Folder ID</param>
<param name="userIdOrGroupId" optional="true">User or group ID</param>
<param name="filterType" optional="true" remark="Allowed values: None (0), FilesOnly (1), FoldersOnly (2), DocumentsOnly (3), PresentationsOnly (4), SpreadsheetsOnly (5) or ImagesOnly (7)">Filter type</param>
<returns>Folder contents</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>
Uploads the file specified with single file upload or standart multipart/form-data method to 'My Documents' section
</summary>
<short>Upload to My</short>
<category>Uploads</category>
<remarks>
<![CDATA[
Upload can be done in 2 different ways:
<ol>
<li>Single file upload. You should set Content-Type &amp; Content-Disposition header to specify filename and content type, and send file in request body</li>
<li>Using standart multipart/form-data method</li>
</ol>]]>
</remarks>
<param name="file" visible="false">Request Input stream</param>
<param name="contentType" visible="false">Content-Type Header</param>
<param name="contentDisposition" visible="false">Content-Disposition Header</param>
<param name="files" visible="false">List of files when posted as multipart/form-data</param>
<returns>Uploaded file</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>
Uploads the file specified with single file upload or standart multipart/form-data method to 'Common Documents' section
</summary>
<short>Upload to Common</short>
<category>Uploads</category>
<remarks>
<![CDATA[
Upload can be done in 2 different ways:
<ol>
<li>Single file upload. You should set Content-Type &amp; Content-Disposition header to specify filename and content type, and send file in request body</li>
<li>Using standart multipart/form-data method</li>
</ol>]]>
</remarks>
<param name="file" visible="false">Request Input stream</param>
<param name="contentType" visible="false">Content-Type Header</param>
<param name="contentDisposition" visible="false">Content-Disposition Header</param>
<param name="files" visible="false">List of files when posted as multipart/form-data</param>
<returns>Uploaded file</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>
Uploads the file specified with single file upload or standart multipart/form-data method to the selected folder
</summary>
<short>Upload to folder</short>
<category>Uploads</category>
<remarks>
<![CDATA[
Upload can be done in 2 different ways:
<ol>
<li>Single file upload. You should set Content-Type &amp; Content-Disposition header to specify filename and content type, and send file in request body</li>
<li>Using standart multipart/form-data method</li>
</ol>]]>
</remarks>
<param name="folderId">Folder ID to upload to</param>
<param name="file" visible="false">Request Input stream</param>
<param name="contentType" visible="false">Content-Type Header</param>
<param name="contentDisposition" visible="false">Content-Disposition Header</param>
<param name="files" visible="false">List of files when posted as multipart/form-data</param>
<param name="createNewIfExist" visible="false">Create New If Exist</param>
<param name="storeOriginalFileFlag" visible="false">If True, upload documents in original formats as well</param>
<param name="keepConvertStatus" visible="false">Keep status conversation after finishing</param>
<returns>Uploaded file</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToMy(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>
Uploads the file specified with single file upload to 'Common Documents' section
</summary>
<param name="file" visible="false">Request Input stream</param>
<param name="title">Name of file which has to be uploaded</param>
<param name="createNewIfExist" visible="false">Create New If Exist</param>
<param name="keepConvertStatus" visible="false">Keep status conversation after finishing</param>
<category>Uploads</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToCommon(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>
Uploads the file specified with single file upload to 'Common Documents' section
</summary>
<param name="file" visible="false">Request Input stream</param>
<param name="title">Name of file which has to be uploaded</param>
<param name="createNewIfExist" visible="false">Create New If Exist</param>
<param name="keepConvertStatus" visible="false">Keep status conversation after finishing</param>
<category>Uploads</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>
Uploads the file specified with single file upload
</summary>
<param name="folderId">Folder ID to upload to</param>
<param name="file" visible="false">Request Input stream</param>
<param name="title">Name of file which has to be uploaded</param>
<param name="createNewIfExist" visible="false">Create New If Exist</param>
<param name="keepConvertStatus" visible="false">Keep status conversation after finishing</param>
<category>Uploads</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">File ID</param>
<param name="fileExtension"></param>
<param name="downloadUri"></param>
<param name="stream"></param>
<param name="doc"></param>
<category>Files</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.StartEdit(System.String,System.Boolean,System.String)">
<summary>
</summary>
<param name="fileId">File ID</param>
<param name="editingAlone"></param>
<param name="doc"></param>
<category>Files</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">File ID</param>
<param name="tabId"></param>
<param name="docKeyForTrack"></param>
<param name="doc"></param>
<param name="isFinish"></param>
<category>Files</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.OpenEdit(System.String,System.Int32,System.String)">
<summary>
</summary>
<param name="fileId">File ID</param>
<param name="version"></param>
<param name="doc"></param>
<category>Files</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateUploadSession(System.String,System.String,System.Int64,System.String)">
<summary>
Creates session to upload large files in multiple chunks.
</summary>
<short>Chunked upload</short>
<category>Uploads</category>
<param name="folderId">Id of the folder in which file will be uploaded</param>
<param name="fileName">Name of file which has to be uploaded</param>
<param name="fileSize">Length in bytes of file which has to be uploaded</param>
<param name="relativePath">Relative folder from folderId</param>
<remarks>
<![CDATA[
Each chunk can have different length but its important what length is multiple of <b>512</b> and greater or equal than <b>5 mb</b>. Last chunk can have any size.
After initial request respond with status 200 OK you must obtain value of 'location' field from the response. Send all your chunks to that location.
Each chunk must be sent in strict order in which chunks appears in file.
After receiving each chunk if no errors occured server will respond with current information about upload session.
When number of uploaded bytes equal to the number of bytes you send in initial request server will respond with 201 Created and will send you info about uploaded file.
]]>
</remarks>
<returns>
<![CDATA[
Information about created session. Which includes:
<ul>
<li><b>id:</b> unique id of this upload session</li>
<li><b>created:</b> UTC time when session was created</li>
<li><b>expired:</b> UTC time when session will be expired if no chunks will be sent until that time</li>
<li><b>location:</b> URL to which you must send your next chunk</li>
<li><b>bytes_uploaded:</b> If exists contains number of bytes uploaded for specific upload id</li>
<li><b>bytes_total:</b> Number of bytes which has to be uploaded</li>
</ul>
]]>
</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFileInMy(System.String,System.String)">
<summary>
Creates a text (.txt) file in 'My Documents' section with the title and contents sent in the request
</summary>
<short>Create txt in 'My'</short>
<category>File Creation</category>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFileInCommon(System.String,System.String)">
<summary>
Creates a text (.txt) file in 'Common Documents' section with the title and contents sent in the request
</summary>
<short>Create txt in 'Common'</short>
<category>File Creation</category>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateTextFile(System.String,System.String,System.String)">
<summary>
Creates a text (.txt) file in the selected folder with the title and contents sent in the request
</summary>
<short>Create txt</short>
<category>File Creation</category>
<param name="folderId">Folder ID</param>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFile(System.String,System.String,System.String)">
<summary>
Creates an html (.html) file in the selected folder with the title and contents sent in the request
</summary>
<short>Create html</short>
<category>File Creation</category>
<param name="folderId">Folder ID</param>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFileInMy(System.String,System.String)">
<summary>
Creates an html (.html) file in 'My Documents' section with the title and contents sent in the request
</summary>
<short>Create html in 'My'</short>
<category>File Creation</category>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateHtmlFileInCommon(System.String,System.String)">
<summary>
Creates an html (.html) file in 'Common Documents' section with the title and contents sent in the request
</summary>
<short>Create html in 'Common'</short>
<category>File Creation</category>
<param name="title">File title</param>
<param name="content">File contents</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFolder(System.String,System.String)">
<summary>
Creates a new folder with the title sent in the request. The ID of a parent folder can be also specified.
</summary>
<short>
New folder
</short>
<category>Folders</category>
<param name="folderId">Parent folder ID</param>
<param name="title">Title of new folder</param>
<returns>New folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFile(System.String)">
<summary>
Creates a new file in the 'My Documents' section with the title sent in the request
</summary>
<short>Create file</short>
<category>File Creation</category>
<param name="title" remark="Allowed values: the file must have one of the following extensions: DOCX, XLSX, PPTX">File title</param>
<remarks>In case the extension for the file title differs from DOCX/XLSX/PPTX and belongs to one of the known text, spreadsheet or presentation formats, it will be changed to DOCX/XLSX/PPTX accordingly. If the file extension is not set or is unknown, the DOCX extension will be added to the file title.</remarks>
<returns>New file info</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CreateFile(System.String,System.String)">
<summary>
Creates a new file in the specified folder with the title sent in the request
</summary>
<short>Create file</short>
<category>File Creation</category>
<param name="folderId">Folder ID</param>
<param name="title" remark="Allowed values: the file must have one of the following extensions: DOCX, XLSX, PPTX">File title</param>
<remarks>In case the extension for the file title differs from DOCX/XLSX/PPTX and belongs to one of the known text, spreadsheet or presentation formats, it will be changed to DOCX/XLSX/PPTX accordingly. If the file extension is not set or is unknown, the DOCX extension will be added to the file title.</remarks>
<returns>New file info</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.RenameFolder(System.String,System.String)">
<summary>
Renames the selected folder to the new title specified in the request
</summary>
<short>
Rename folder
</short>
<category>Folders</category>
<param name="folderId">Folder ID</param>
<param name="title">New title</param>
<returns>Folder contents</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderInfo(System.String)">
<summary>
Returns a detailed information about the folder with the ID specified in the request
</summary>
<short>Folder information</short>
<category>Folders</category>
<returns>Folder info</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderPath(System.String)">
<summary>
Returns parent folders
</summary>
<param name="folderId"></param>
<category>Folders</category>
<returns>Parent folders</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileInfo(System.String,System.Int32)">
<summary>
Returns a detailed information about the file with the ID specified in the request
</summary>
<short>File information</short>
<category>Files</category>
<returns>File info</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UpdateFile(System.String,System.String,System.Int32)">
<summary>
Updates the information of the selected file with the parameters specified in the request
</summary>
<short>Update file info</short>
<category>Files</category>
<param name="fileId">File ID</param>
<param name="title">New title</param>
<param name="lastVersion">File last version number</param>
<returns>File info</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteFile(System.String,System.Boolean,System.Boolean)">
<summary>
Deletes the file with the ID specified in the request
</summary>
<short>Delete file</short>
<category>Files</category>
<param name="fileId">File ID</param>
<param name="deleteAfter">Delete after finished</param>
<param name="immediately">Don't move to the Recycle Bin</param>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.StartConversion(System.String)">
<summary>
Start conversion
</summary>
<short>Convert</short>
<category>File operations</category>
<param name="fileId"></param>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.CheckConversion(System.String,System.Boolean)">
<summary>
Check conversion status
</summary>
<short>Convert</short>
<category>File operations</category>
<param name="fileId"></param>
<param name="start"></param>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetPresignedUri(System.String)">
<summary>
Get presigned Uri
</summary>
<param name="fileId">File ID</param>
<returns>Url</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteFolder(System.String,System.Boolean,System.Boolean)">
<summary>
Deletes the folder with the ID specified in the request
</summary>
<short>Delete folder</short>
<category>Folders</category>
<param name="folderId">Folder ID</param>
<param name="deleteAfter">Delete after finished</param>
<param name="immediately">Don't move to the Recycle Bin</param>
<returns>Operation result</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>
Checking for conflicts
</summary>
<category>File operations</category>
<param name="destFolderId">Destination folder ID</param>
<param name="folderIds">Folder ID list</param>
<param name="fileIds">File ID list</param>
<returns>Conflicts file ids</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>
Moves all the selected files and folders to the folder with the ID specified in the request
</summary>
<short>Move to folder</short>
<category>File operations</category>
<param name="destFolderId">Destination folder ID</param>
<param name="folderIds">Folder ID list</param>
<param name="fileIds">File ID list</param>
<param name="conflictResolveType">Overwriting behavior: skip(0), overwrite(1) or duplicate(2)</param>
<param name="deleteAfter">Delete after finished</param>
<returns>Operation result</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>
Copies all the selected files and folders to the folder with the ID specified in the request
</summary>
<short>Copy to folder</short>
<category>File operations</category>
<param name="destFolderId">Destination folder ID</param>
<param name="folderIds">Folder ID list</param>
<param name="fileIds">File ID list</param>
<param name="conflictResolveType">Overwriting behavior: skip(0), overwrite(1) or duplicate(2)</param>
<param name="deleteAfter">Delete after finished</param>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.MarkAsRead(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Marks all files and folders as read
</summary>
<short>Mark as read</short>
<category>File operations</category>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.TerminateTasks">
<summary>
Finishes all the active file operations
</summary>
<short>Finish all</short>
<category>File operations</category>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetOperationStatuses">
<summary>
Returns the list of all active file operations
</summary>
<short>Get file operations list</short>
<category>File operations</category>
<returns>Operation result</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>
Start downlaod process of files and folders with ID
</summary>
<short>Finish file operations</short>
<param name="fileConvertIds" visible="false">File ID list for download with convert to format</param>
<param name="fileIds">File ID list</param>
<param name="folderIds">Folder ID list</param>
<category>File operations</category>
<returns>Operation result</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>
Deletes the files and folders with the IDs specified in the request
</summary>
<param name="folderIds">Folder ID list</param>
<param name="fileIds">File ID list</param>
<param name="deleteAfter">Delete after finished</param>
<param name="immediately">Don't move to the Recycle Bin</param>
<short>Delete files and folders</short>
<category>File operations</category>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.EmptyTrash">
<summary>
Deletes all files and folders from the recycle bin
</summary>
<short>Clear recycle bin</short>
<category>File operations</category>
<returns>Operation result</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileVersionInfo(System.String)">
<summary>
Returns the detailed information about all the available file versions with the ID specified in the request
</summary>
<short>File versions</short>
<category>Files</category>
<param name="fileId">File ID</param>
<returns>File information</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.ChangeHistory(System.String,System.Int32,System.Boolean)">
<summary>
Change version history
</summary>
<param name="fileId">File ID</param>
<param name="version">Version of history</param>
<param name="continueVersion">Mark as version or revision</param>
<category>Files</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFileSecurityInfo(System.String)">
<summary>
Returns the detailed information about shared file with the ID specified in the request
</summary>
<short>File sharing</short>
<category>Sharing</category>
<param name="fileId">File ID</param>
<returns>Shared file information</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetFolderSecurityInfo(System.String)">
<summary>
Returns the detailed information about shared folder with the ID specified in the request
</summary>
<short>Folder sharing</short>
<param name="folderId">Folder ID</param>
<category>Sharing</category>
<returns>Shared folder information</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>
Sets sharing settings for the file with the ID specified in the request
</summary>
<param name="fileId">File ID</param>
<param name="share">Collection of sharing rights</param>
<param name="notify">Should notify people</param>
<param name="sharingMessage">Sharing message to send when notifying</param>
<short>Share file</short>
<category>Sharing</category>
<remarks>
Each of the FileShareParams must contain two parameters: 'ShareTo' - ID of the user with whom we want to share and 'Access' - access type which we want to grant to the user (Read, ReadWrite, etc)
</remarks>
<returns>Shared file information</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>
Sets sharing settings for the folder with the ID specified in the request
</summary>
<short>Share folder</short>
<param name="folderId">Folder ID</param>
<param name="share">Collection of sharing rights</param>
<param name="notify">Should notify people</param>
<param name="sharingMessage">Sharing message to send when notifying</param>
<remarks>
Each of the FileShareParams must contain two parameters: 'ShareTo' - ID of the user with whom we want to share and 'Access' - access type which we want to grant to the user (Read, ReadWrite, etc)
</remarks>
<category>Sharing</category>
<returns>Shared folder information</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.RemoveSecurityInfo(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Removes sharing rights for the group with the ID specified in the request
</summary>
<param name="folderIds">Folders ID</param>
<param name="fileIds">Files ID</param>
<short>Remove group sharing rights</short>
<category>Sharing</category>
<returns>Shared file information</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GenerateSharedLink(System.String,ASC.Files.Core.Security.FileShare)">
<summary>
Returns the external link to the shared file with the ID specified in the request
</summary>
<summary>
File external link
</summary>
<param name="fileId">File ID</param>
<param name="share">Access right</param>
<category>Files</category>
<returns>Shared file link</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>
Saves the third party file storage service account
</summary>
<short>Save third party account</short>
<param name="url">Connection url for SharePoint</param>
<param name="login">Login</param>
<param name="password">Password</param>
<param name="token">Authentication token</param>
<param name="isCorporate"></param>
<param name="customerTitle">Title</param>
<param name="providerKey">Provider Key</param>
<param name="providerId">Provider ID</param>
<category>Third-Party Integration</category>
<returns>Folder contents</returns>
<remarks> List of provider key: DropboxV2, Box, WebDav, Yandex, OneDrive, SharePoint, GoogleDrive</remarks>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetThirdPartyAccounts">
<summary>
Returns the list of all connected third party services
</summary>
<category>Third-Party Integration</category>
<short>Get third party list</short>
<returns>Connected providers</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.GetCommonThirdPartyFolders">
<summary>
Returns the list of third party services connected in the 'Common Documents' section
</summary>
<category>Third-Party Integration</category>
<short>Get third party folder</short>
<returns>Connected providers folder</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.DeleteThirdParty(System.Int32)">
<summary>
Removes the third party file storage service account with the ID specified in the request
</summary>
<param name="providerId">Provider ID. Provider id is part of folder id.
Example, folder id is "sbox-123", then provider id is "123"
</param>
<short>Remove third party account</short>
<category>Third-Party Integration</category>
<returns>Folder id</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>
Checking document service location
</summary>
<param name="docServiceUrl">Document editing service Domain</param>
<param name="docServiceUrlInternal">Document command service Domain</param>
<param name="docServiceUrlPortal">Community Server Address</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>
Result of file conversation operation.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Id">
<summary>
Operation Id.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.OperationType">
<summary>
Operation type.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Progress">
<summary>
Operation progress.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Source">
<summary>
Source files for operation.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.File">
<summary>
Result file of operation.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Error">
<summary>
Error during conversation.
</summary>
</member>
<member name="P:ASC.Api.Documents.DocumentsApi.ConversationResult.Processed">
<summary>
Is operation processed.
</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>