Class UploadedFileChunk

Inheritance

System.Object

UploadedFileChunk

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class UploadedFileChunk : IRelationsWithProxy

Constructors

UploadedFileChunk()

Creates a new instance of this class

Declaration

public UploadedFileChunk()

Properties

BytesWritten

The number of bytes written up to now.

Declaration

public long BytesWritten { get; set; }

Property Value

Type	Description
System.Int64

Finished

Indicates that the last chunk has been uploaded.

Declaration

public bool Finished { get; set; }

Property Value

Type	Description
System.Boolean

LastChunkId

The id of the last uploaded chunk.

Declaration

public string LastChunkId { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

Gets the Uri of the link for the relation “next”.

Declaration

public string NextRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “next” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Methods

GetUploadedFileChunkFromNextRelation()

Calls the HTTP Get method on the link for the relation “next”.

Declaration

public UploadedFileChunk GetUploadedFileChunkFromNextRelation()

Returns

Type	Description
UploadedFileChunk	The content of the response.

GetUploadedFileChunkFromNextRelationAsync()

Calls the HTTP Get method on the link for the relation “next” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<UploadedFileChunk>> GetUploadedFileChunkFromNextRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<UploadedFileChunk>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

GetUploadedFileChunkFromNextRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “next” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<UploadedFileChunk>> GetUploadedFileChunkFromNextRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<UploadedFileChunk>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.