Class FileCabinetExtensionsBase
Extensions for the file cabinet.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public static class FileCabinetExtensionsBase : object
Methods
AddDocumentSections(Document, IFileUploadInfo[])
Appends one or more new sections to the specified document.
Declaration
public static Document AddDocumentSections(Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Document | The modified document. |
AddDocumentSectionsAsync(Document, IFileUploadInfo[])
Appends one or more new sections to the specified document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> AddDocumentSectionsAsync(Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
ChunkAddSection(Document, IFileUploadInfo, Int32)
Adds a section to a document using chunked upload.
Declaration
public static Section ChunkAddSection(Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk in bytes. |
Returns
Type | Description |
---|---|
Section | The new section's metadata. |
ChunkAddSectionAsync(Document, IFileUploadInfo, Int32)
Adds a section to a document asynchronously using chunked upload.
Declaration
public static Task<DeserializedHttpResponse<Section>> ChunkAddSectionAsync(Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk in bytes. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Section>> | The new section's metadata. |
ChunkImportArchive(FileCabinet, ImportSettings, IFileUploadInfo, Int32)
Uploads the import package in chunks.
Declaration
public static ImportResult ChunkImportArchive(FileCabinet fileCabinet, ImportSettings importSettings, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
ImportSettings | importSettings | The settings of the import. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
ImportResult | Returns the result of the import operation. |
ChunkImportArchiveAsync(FileCabinet, ImportSettings, IFileUploadInfo, Int32)
Uploads the import package asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> ChunkImportArchiveAsync(FileCabinet fileCabinet, ImportSettings importSettings, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
ImportSettings | importSettings | The settings of the import. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<ImportResult>> | Returns the result of the import operation. |
ChunkSynchronize(FileCabinet, SynchronizationSettings, IFileUploadInfo, Int32)
Uploads the specified synchronization package in chunks.
Declaration
public static ImportResult ChunkSynchronize(FileCabinet fileCabinet, SynchronizationSettings synchronizationSettings, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
SynchronizationSettings | synchronizationSettings | The settings of the synchronization. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
ImportResult | Returns the result of the synchronization operation. |
ChunkSynchronizeAsync(FileCabinet, SynchronizationSettings, IFileUploadInfo, Int32)
Uploads the specified synchronization package asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> ChunkSynchronizeAsync(FileCabinet fileCabinet, SynchronizationSettings synchronizationSettings, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
SynchronizationSettings | synchronizationSettings | The settings of the synchronization. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<ImportResult>> | Returns the result of the synchronization operation. |
ChunkUploadDocument(DialogInfo, Document, IFileUploadInfo, Int32)
Upload the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(DialogInfo dialog, Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
ChunkUploadDocument(DialogInfo, Document, IFileUploadInfo[], Int32)
Upload the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(DialogInfo dialog, Document document, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document |
ChunkUploadDocument(FileCabinet, Document, IFileUploadInfo, Int32)
Upload the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(FileCabinet fileCabinet, Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
ChunkUploadDocument(FileCabinet, Document, IFileUploadInfo[], Int32)
Upload the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(FileCabinet fileCabinet, Document document, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
ChunkUploadDocument(FileCabinet, IFileUploadInfo, Int32)
Uploads the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(FileCabinet fileCabinet, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
ChunkUploadDocument(FileCabinet, IFileUploadInfo[], Int32)
Upload the specified document in chunks.
Declaration
public static Document ChunkUploadDocument(FileCabinet fileCabinet, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
ChunkUploadDocumentAsync(DialogInfo, Document, IFileUploadInfo, Int32)
Upload the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(DialogInfo dialog, Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(DialogInfo, Document, IFileUploadInfo[], Int32)
Upload the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(DialogInfo dialog, Document document, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> |
ChunkUploadDocumentAsync(DialogInfo, InputDocument, Int32)
Uploads the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(DialogInfo dialogInfo, InputDocument inputDocument, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialogInfo | The store dialog. |
InputDocument | inputDocument | The data for the stored document |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo, Int32)
Upload the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, Document document, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo, Int32, CancellationToken)
Upload the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, Document document, IFileUploadInfo file, int chunkSize, CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
CancellationToken | token | Cancellation token. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo[], Int32)
Upload the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, Document document, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, InputDocument, Int32)
Uploads the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, InputDocument inputDocument, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
InputDocument | inputDocument | The data for the stored document |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, IFileUploadInfo, Int32)
Uploads the specified document asynchronously in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadDocumentAsync(FileCabinet, IFileUploadInfo[], Int32)
Uploads the specified asynchronously document in chunks.
Declaration
public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo[] files, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo[] | files | The files. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | The uploaded document's metadata. |
ChunkUploadSection(Section, IFileUploadInfo, Int32)
Replaces the content of a section with the passed file Uploads the specified file in chunks.
Declaration
public static Section ChunkUploadSection(Section section, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
Section | section | The section whose content is replaced. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Section | The changed section's metadata. |
ChunkUploadSectionAsync(Section, IFileUploadInfo, Int32)
Replaces the content of a section with the passed file asynchronously. Uploads the specified file in chunks.
Declaration
public static Task<DeserializedHttpResponse<Section>> ChunkUploadSectionAsync(Section section, IFileUploadInfo file, int chunkSize = 0)
Parameters
Type | Name | Description |
---|---|---|
Section | section | The section whose content is replaced. |
IFileUploadInfo | file | The file. |
System.Int32 | chunkSize | Size of the chunk. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Section>> | The changed section's metadata. |
GetMultipart(IStringContent, IFileUploadInfo[])
Declaration
public static MultipartFormDataContent GetMultipart(IStringContent stringContent, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
IStringContent | stringContent | |
IFileUploadInfo[] | file |
Returns
Type | Description |
---|---|
MultipartFormDataContent |
ImportArchive(FileCabinet, ImportSettings, IFileUploadInfo)
Imports an archive in Docuware.
Declaration
public static ImportResult ImportArchive(FileCabinet fileCabinet, ImportSettings settings, IFileUploadInfo file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet in which the document will be imported. |
ImportSettings | settings | The settings of the import. |
IFileUploadInfo | file | The file which represnets the archive. |
Returns
Type | Description |
---|---|
ImportResult | Returns an import result information. |
ImportArchiveAsync(FileCabinet, ImportSettings, IFileUploadInfo)
Imports asynchronously an archive in Docuware.
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> ImportArchiveAsync(FileCabinet fileCabinet, ImportSettings settings, IFileUploadInfo file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet in which the document will be imported. |
ImportSettings | settings | The settings of the import. |
IFileUploadInfo | file | The file which represnets the archive. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<ImportResult>> | Returns an import result information. |
Synchronize(FileCabinet, SynchronizationSettings, IFileUploadInfo)
Synchronizes a document with external version.
Declaration
public static ImportResult Synchronize(FileCabinet fileCabinet, SynchronizationSettings settings, IFileUploadInfo file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet which contains the document that will be synchronized. |
SynchronizationSettings | settings | The settings of the synchronization. |
IFileUploadInfo | file | The file which represnets the archive. |
Returns
Type | Description |
---|---|
ImportResult | Returns an import result information from the synchronization. |
SynchronizeAsync(FileCabinet, SynchronizationSettings, IFileUploadInfo)
Synchronizes a document with external version.
Declaration
public static Task<DeserializedHttpResponse<ImportResult>> SynchronizeAsync(FileCabinet fileCabinet, SynchronizationSettings settings, IFileUploadInfo file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet which contains the document that will be synchronized. |
SynchronizationSettings | settings | The settings of the synchronization. |
IFileUploadInfo | file | The file which represnets the archive. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<ImportResult>> | Returns an import result information from the synchronization. |
UploadDocument(DialogInfo, Document, IFileUploadInfo[])
Uploads the document.
Declaration
public static Document UploadDocument(DialogInfo dialog, Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
UploadDocument(FileCabinet, Document, IFileUploadInfo[])
Uploads the specified document.
Declaration
public static Document UploadDocument(FileCabinet fileCabinet, Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
UploadDocument(FileCabinet, InputDocument)
Uploads the specified document.
Declaration
public static Document UploadDocument(this FileCabinet fileCabinet, InputDocument inputDocument)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
InputDocument | inputDocument | The file. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
UploadDocument(FileCabinet, IFileUploadInfo[])
Uploads the specified document.
Declaration
public static Document UploadDocument(FileCabinet fileCabinet, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Document | The uploaded document's metadata. |
UploadDocumentAsync(DialogInfo, Document, IFileUploadInfo[])
Uploads the document asynchronous.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(DialogInfo dialog, Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialog | The store dialog which is used to fill index data. |
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadDocumentAsync(DialogInfo, InputDocument)
Uploads the specified document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(this DialogInfo dialogInfo, InputDocument inputDocument)
Parameters
Type | Name | Description |
---|---|---|
DialogInfo | dialogInfo | The store dialog. |
InputDocument | inputDocument | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadDocumentAsync(FileCabinet, Document, IFileUploadInfo[])
Uploads the document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(FileCabinet fileCabinet, Document document, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadDocumentAsync(FileCabinet, Document, IFileUploadInfo[], CancellationToken)
Uploads the document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(FileCabinet fileCabinet, Document document, IFileUploadInfo[] file, CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
Document | document | The document. |
IFileUploadInfo[] | file | The file. |
CancellationToken | token | Cancellation token. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadDocumentAsync(FileCabinet, InputDocument)
Uploads the specified document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(this FileCabinet fileCabinet, InputDocument inputDocument)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
InputDocument | inputDocument | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadDocumentAsync(FileCabinet, IFileUploadInfo[])
Uploads the specified document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo[] file)
Parameters
Type | Name | Description |
---|---|---|
FileCabinet | fileCabinet | The file cabinet. |
IFileUploadInfo[] | file | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Document>> | A task which uploads the document and returns the uploaded document's metadata. |
UploadSectionAsync(Document, IFileUploadInfo)
Appends one section to the specified document asynchronously.
Declaration
public static Task<DeserializedHttpResponse<Section>> UploadSectionAsync(Document document, IFileUploadInfo file)
Parameters
Type | Name | Description |
---|---|---|
Document | document | The document. |
IFileUploadInfo | file | The file. |
Returns
Type | Description |
---|---|
Task<DeserializedHttpResponse<Section>> | A task which uploads the document and returns the uploaded section's metadata. |