Class FileCabinetExtensionsBase

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Extensions for the file cabinet.

public static class FileCabinetExtensionsBase

Inheritance

object

FileCabinetExtensionsBase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddDocumentSections(Document, IFileUploadInfo[])

Appends one or more new sections to the specified document.

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.

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, int)

Adds a section to a document using chunked upload.

public static Section ChunkAddSection(Document document, IFileUploadInfo file, int chunkSize = 0)

Parameters

Type	Name	Description
Document	document	The document.
IFileUploadInfo	file	The file.
int	chunkSize	Size of the chunk in bytes.

Returns

Type	Description
Section	The new section's metadata.

ChunkAddSectionAsync(Document, IFileUploadInfo, int)

Adds a section to a document asynchronously using chunked upload.

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.
int	chunkSize	Size of the chunk in bytes.

Returns

Type	Description
Task<DeserializedHttpResponse<Section>>	The new section's metadata.

ChunkImportArchive(FileCabinet, ImportSettings, IFileUploadInfo, int)

Uploads the import package in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
ImportResult	Returns the result of the import operation.

ChunkImportArchiveAsync(FileCabinet, ImportSettings, IFileUploadInfo, int)

Uploads the import package asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<ImportResult>>	Returns the result of the import operation.

ChunkSynchronize(FileCabinet, SynchronizationSettings, IFileUploadInfo, int)

Uploads the specified synchronization package in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
ImportResult	Returns the result of the synchronization operation.

ChunkSynchronizeAsync(FileCabinet, SynchronizationSettings, IFileUploadInfo, int)

Uploads the specified synchronization package asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<ImportResult>>	Returns the result of the synchronization operation.

ChunkUploadDocument(DialogInfo, Document, IFileUploadInfo, int)

Upload the specified document in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document	The uploaded document's metadata.

ChunkUploadDocument(DialogInfo, Document, IFileUploadInfo[], int)

Upload the specified document in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document

ChunkUploadDocument(FileCabinet, Document, IFileUploadInfo, int)

Upload the specified document in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document	The uploaded document's metadata.

ChunkUploadDocument(FileCabinet, Document, IFileUploadInfo[], int)

Upload the specified document in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document	The uploaded document's metadata.

ChunkUploadDocument(FileCabinet, IFileUploadInfo, int)

Uploads the specified document in chunks.

public static Document ChunkUploadDocument(FileCabinet fileCabinet, IFileUploadInfo file, int chunkSize = 0)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document	The uploaded document's metadata.

ChunkUploadDocument(FileCabinet, IFileUploadInfo[], int)

Upload the specified document in chunks.

public static Document ChunkUploadDocument(FileCabinet fileCabinet, IFileUploadInfo[] files, int chunkSize = 0)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo[]	files	The files.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Document	The uploaded document's metadata.

ChunkUploadDocumentAsync(DialogInfo, Document, IFileUploadInfo, int)

Upload the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(DialogInfo, Document, IFileUploadInfo[], int)

Upload the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>

ChunkUploadDocumentAsync(DialogInfo, InputDocument, int)

Uploads the specified document asynchronously in chunks.

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
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo, int)

Upload the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo, int, CancellationToken)

Upload the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.
CancellationToken	token	Cancellation token.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, Document, IFileUploadInfo[], int)

Upload the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, InputDocument, int)

Uploads the specified document asynchronously in chunks.

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
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, IFileUploadInfo, int)

Uploads the specified document asynchronously in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(FileCabinet, IFileUploadInfo[], int)

Uploads the specified asynchronously document in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadDocumentAsync(ServiceConnection, FileCabinet, string, IFileUploadInfo[], Document, int)

Upload the specified document asynchronously in chunks.

public static Task<DeserializedHttpResponse<Document>> ChunkUploadDocumentAsync(this ServiceConnection serviceConnection, FileCabinet fileCabinet, string storeDialogId, IFileUploadInfo[] files, Document documentMetaData, int chunkSize = 0)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
FileCabinet	fileCabinet	The file cabinet.
string	storeDialogId	The store dialog.
IFileUploadInfo[]	files	The files.
Document	documentMetaData	The document metadata.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata.

ChunkUploadSection(Section, IFileUploadInfo, int)

Replaces the content of a section with the passed file Uploads the specified file in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Section	The changed section's metadata.

ChunkUploadSectionAsync(Section, IFileUploadInfo, int)

Replaces the content of a section with the passed file asynchronously. Uploads the specified file in chunks.

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.
int	chunkSize	Size of the chunk.

Returns

Type	Description
Task<DeserializedHttpResponse<Section>>	The changed section's metadata.

GetMultipart(IStringContent, IFileUploadInfo[])

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

UploadDocumentAsync(ServiceConnection, FileCabinet, Document, IFileUploadInfo[], string)

Uploads the document asynchronously.

public static Task<DeserializedHttpResponse<Document>> UploadDocumentAsync(this ServiceConnection serviceConnection, FileCabinet fileCabinet, Document documentMetaData, IFileUploadInfo[] files, string storeDialogId)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
FileCabinet	fileCabinet	The file cabinet.
Document	documentMetaData	The document.
IFileUploadInfo[]	files	The file.
string	storeDialogId	The store dialog's id.

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.

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.