Class EasyCheckoutCheckinExtensionsBase

Some extensions for handling responses which can be stored as files.

Inheritance

System.Object

EasyCheckoutCheckinExtensionsBase

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public static class EasyCheckoutCheckinExtensionsBase : object

Methods

CreateEasyCheckoutFileName(DeserializedHttpResponse<Stream>, String, Int32)

Creates the name of the easy-checkout file.

Declaration

public static string CreateEasyCheckoutFileName(DeserializedHttpResponse<Stream> checkoutResponse, string fileCabinetId, int docId)

Parameters

Type	Name	Description
DeserializedHttpResponse<Stream>	checkoutResponse	The checkout operation response.
System.String	fileCabinetId	The file cabinet identifier.
System.Int32	docId	The document identifier.

Returns

Type	Description
System.String	The file name which contains all information encoded in order to check in the file again.

EasyCheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo)

Checks the specified file in.

Declaration

public static Task<DeserializedHttpResponse<Document>> EasyCheckInFromFileSystemAsync(this ServiceConnection serviceConnection, IFileUploadInfo fileToCheckin)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
IFileUploadInfo	fileToCheckin	The file to checkin.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	A task producing the checked-in response of the check-in operation.

Remarks

The name of fileToCheckin must be taken from EasyCheckOutToFileSystemAsync(ServiceConnection, String, Int32).

EasyCheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo, CheckInActionParameters)

Checks the specified file in.

Declaration

public static Task<DeserializedHttpResponse<Document>> EasyCheckInFromFileSystemAsync(this ServiceConnection serviceConnection, IFileUploadInfo fileToCheckin, CheckInActionParameters checkInParams)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
IFileUploadInfo	fileToCheckin	The file to checkin.
CheckInActionParameters	checkInParams	The check in parameters.

Returns

Type	Description
Task<DeserializedHttpResponse<Document>>	A task producing the checked-in response of the check-in operation.

Remarks

The name of fileToCheckin must be taken from EasyCheckOutToFileSystemAsync(ServiceConnection, String, Int32).

EasyCheckOutToFileSystemAsync(ServiceConnection, String, Int32)

Checks out the specified file and saves it to the file system asynchronously.

Declaration

public static Task<EasyCheckoutResult> EasyCheckOutToFileSystemAsync(this ServiceConnection serviceConnection, string fileCabinetId, int docId)

Parameters

Type	Name	Description
ServiceConnection	serviceConnection	The service connection.
System.String	fileCabinetId	The file cabinet identifier.
System.Int32	docId	The document identifier.

Returns

Type	Description
Task<EasyCheckoutResult>	A task producung an instance of EasyCheckoutResult.