Class EasyFileUploadExtensionsBase

Some extensions for simple file uploads.

Inheritance

System.Object

EasyFileUploadExtensionsBase

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

[Eagle]
public static class EasyFileUploadExtensionsBase

Methods

EasyImportArchive(FileCabinet, IFileUploadInfo, ImportSettings)

Imports the specified file into a file cabinet.

Declaration

public static ImportResult EasyImportArchive(FileCabinet fileCabinet, IFileUploadInfo file, ImportSettings importSettings)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
ImportSettings	importSettings	The settings of the import.

Returns

Type	Description
ImportResult	Returns the result of the import operation

EasyImportArchiveAsync(FileCabinet, IFileUploadInfo, ImportSettings)

Imports asynchronously the specified file into a file cabinet.

Declaration

public static Task<DeserializedHttpResponse<ImportResult>> EasyImportArchiveAsync(FileCabinet fileCabinet, IFileUploadInfo file, ImportSettings importSettings)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
ImportSettings	importSettings	The settings of the import.

Returns

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

EasyReplaceFile(Section, IFileUploadInfo)

Uploads the specified file as new section to the specified document.

Declaration

[Eagle]
public static Section EasyReplaceFile(Section section, IFileUploadInfo file)

Parameters

Type	Name	Description
Section	section	The section to modify.
IFileUploadInfo	file	The file marking the new content of the section.

Returns

Type	Description
Section	The metadata of the modified section.

EasyReplaceFileAsync(Section, IFileUploadInfo)

Uploads the specified file as new section to the specified document asynchronously.

Declaration

[Eagle]
public static Task<DeserializedHttpResponse<Section>> EasyReplaceFileAsync(Section section, IFileUploadInfo file)

Parameters

Type	Name	Description
Section	section	The section to modify.
IFileUploadInfo	file	The file marking the new content of the section.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>>	The metadata of the modified section.

EasySynchronize(FileCabinet, IFileUploadInfo, SynchronizationSettings)

Synchronizes the specified file into a file cabinet.

Declaration

public static ImportResult EasySynchronize(FileCabinet fileCabinet, IFileUploadInfo file, SynchronizationSettings synchronizeSettings)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
SynchronizationSettings	synchronizeSettings	The settings of the synchronization.

Returns

Type	Description
ImportResult	Returns the result of the synchronization operation.

EasySynchronizeAsync(FileCabinet, IFileUploadInfo, SynchronizationSettings)

Synchronizes asynchronously the specified file into a file cabinet.

Declaration

public static Task<DeserializedHttpResponse<ImportResult>> EasySynchronizeAsync(FileCabinet fileCabinet, IFileUploadInfo file, SynchronizationSettings synchronizeSettings)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
SynchronizationSettings	synchronizeSettings	The settings of the synchronization.

Returns

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

EasyUploadDocument(DialogInfo, InputDocument)

Uploads a new document.

Declaration

[Lobster]
public static Document EasyUploadDocument(this DialogInfo dialogInfo, InputDocument inputDocument)

Parameters

Type	Name	Description
DialogInfo	dialogInfo	The store dialog.
InputDocument	inputDocument	The input document meta data.

Returns

Type	Description
Document	The uploaded document's metadata and its files.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocument(DialogInfo, IFileUploadInfo[], Document)

Uploads array of files as new document via a store dialog.

Declaration

[Gecko]
public static Document EasyUploadDocument(DialogInfo dialogInfo, IFileUploadInfo[] files, Document documentMetaData)

Parameters

Type	Name	Description
DialogInfo	dialogInfo	The store dialog.
IFileUploadInfo[]	files	The array of files.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

Type	Description
Document	The uploaded document's metadata.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocument(FileCabinet, InputDocument)

Uploads a new document.

Declaration

[Lobster]
public static Document EasyUploadDocument(this FileCabinet fileCabinet, InputDocument inputDocument)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
InputDocument	inputDocument	The input document meta data.

Returns

Type	Description
Document	The uploaded document's metadata and its files.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocument(FileCabinet, IFileUploadInfo[], Document)

Uploads array of files as new document.

Declaration

[Gecko]
public static Document EasyUploadDocument(FileCabinet fileCabinet, IFileUploadInfo[] files, Document documentMetaData)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo[]	files	The files.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

Type	Description
Document	The uploaded document's metadata.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocument(FileCabinet, IFileUploadInfo[], DocumentIndexField[])

Uploads array of files as new document.

Declaration

[Gecko]
public static Document EasyUploadDocument(FileCabinet fileCabinet, IFileUploadInfo[] files, params DocumentIndexField[] indexFields)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo[]	files	The files.
DocumentIndexField[]	indexFields	The index fields.

Returns

Type	Description
Document	The uploaded document's metadata.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(DialogInfo, InputDocument)

Uploads a new document asynchronously.

Declaration

[Lobster]
public static Task<DeserializedHttpResponse<Document>> EasyUploadDocumentAsync(this DialogInfo dialogInfo, InputDocument inputDocument)

Parameters

Type	Name	Description
DialogInfo	dialogInfo	The store dialog.
InputDocument	inputDocument	The document meta data.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata and its files.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(DialogInfo, IFileUploadInfo[], Document)

Uploads array of files as new document via a store dialog asynchronously.

Declaration

[Gecko]
public static Task<DeserializedHttpResponse<Document>> EasyUploadDocumentAsync(DialogInfo dialogInfo, IFileUploadInfo[] files, Document documentMetaData)

Parameters

Type	Name	Description
DialogInfo	dialogInfo	The store dialog.
IFileUploadInfo[]	files	The array of files.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(FileCabinet, InputDocument)

Uploads a new document asynchronously.

Declaration

[Lobster]
public static Task<DeserializedHttpResponse<Document>> EasyUploadDocumentAsync(this FileCabinet fileCabinet, InputDocument inputDocument)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
InputDocument	inputDocument	The document meta data.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>	The uploaded document's metadata and its files.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(FileCabinet, IFileUploadInfo[], Document)

Uploads array of files as new document asynchronously.

Declaration

[Gecko]
public static Task<DeserializedHttpResponse<Document>> EasyUploadDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo[] files, Document documentMetaData)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo[]	files	The files.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(FileCabinet, IFileUploadInfo[], DocumentIndexField[])

Uploads array of files as new document asynchronously.

Declaration

[Gecko]
public static Task<DeserializedHttpResponse<Document>> EasyUploadDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo[] files, params DocumentIndexField[] indexFields)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo[]	files	The files.
DocumentIndexField[]	indexFields	The index fields.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadDocumentAsync(ServiceConnection, FileCabinet, String, IFileUploadInfo[], Document)

Uploads array of files as new document asynchronously.

Declaration

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

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection
FileCabinet	fileCabinet	The document tray.
System.String	storeDialogId	The id of the store dialog
IFileUploadInfo[]	files	The files.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadFile(Document, IFileUploadInfo)

Uploads the specified file as new section to the specified document.

Declaration

[Eagle]
public static Section EasyUploadFile(Document document, IFileUploadInfo file)

Parameters

Type	Name	Description
Document	document	The document.
IFileUploadInfo	file	The file.

Returns

Type	Description
Section	The metadata of the added section.

EasyUploadFileAsync(Document, IFileUploadInfo)

Uploads the specified file as new section to the specified document asynchronously.

Declaration

[Eagle]
public static Task<DeserializedHttpResponse<Section>> EasyUploadFileAsync(Document document, IFileUploadInfo file)

Parameters

Type	Name	Description
Document	document	The document.
IFileUploadInfo	file	The file.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>>	The metadata of the added section.

EasyUploadSingleDocument(FileCabinet, IFileUploadInfo, Document)

Uploads the specified file as new document to a basket.

Declaration

[Eagle]
public static Document EasyUploadSingleDocument(FileCabinet fileCabinet, IFileUploadInfo file, Document documentMetaData)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

Type	Description
Document	The uploaded document's metadata.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadSingleDocument(FileCabinet, IFileUploadInfo, DocumentIndexField[])

Uploads the specified file as new document to a basket or to a file cabinet.

Declaration

[Eagle]
public static Document EasyUploadSingleDocument(FileCabinet fileCabinet, IFileUploadInfo file, params DocumentIndexField[] indexFields)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
DocumentIndexField[]	indexFields	The index fields.

Returns

Type	Description
Document	The uploaded document's metadata.

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadSingleDocumentAsync(FileCabinet, IFileUploadInfo, Document)

Uploads the specified file as new document to a basket asynchronously.

Declaration

[Eagle]
public static Task<DeserializedHttpResponse<Document>> EasyUploadSingleDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo file, Document documentMetaData)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
Document	documentMetaData	The document meta data. Currently only the fields are used.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadSingleDocumentAsync(FileCabinet, IFileUploadInfo, Document, CancellationToken)

Uploads the specified file as new document to a basket asynchronously.

Declaration

[Eagle]
public static Task<DeserializedHttpResponse<Document>> EasyUploadSingleDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo file, Document documentMetaData, CancellationToken token)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
Document	documentMetaData	The document meta data. Currently only the fields are used.
System.Threading.CancellationToken	token	Cancellation token.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.

EasyUploadSingleDocumentAsync(FileCabinet, IFileUploadInfo, DocumentIndexField[])

Uploads the specified file as new document to a basket or to a file cabinet asynchronously.

Declaration

[Eagle]
public static Task<DeserializedHttpResponse<Document>> EasyUploadSingleDocumentAsync(FileCabinet fileCabinet, IFileUploadInfo file, params DocumentIndexField[] indexFields)

Parameters

Type	Name	Description
FileCabinet	fileCabinet	The file cabinet.
IFileUploadInfo	file	The file.
DocumentIndexField[]	indexFields	The index fields.

Returns

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

Remarks

The document is uploaded as optimal as possible. That is, if the document is small enough it is uploaded with a single request. If the file is large, the upload is done chunkwise.