Class AdhocRenderingFile

Main class for managing adhoc rendering file.

Inheritance

System.Object

AdhocRenderingFile

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class AdhocRenderingFile : IRelationsWithProxy

Properties

Id

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

MetaData

Gets the meta data for the file. This usually contains the entries from the user dictionary of a PDF file or the meta data settings from a MS word file.

Declaration

public List<KeyValuePair> MetaData { get; set; }

Property Value

Type	Description
List<KeyValuePair>

PageCount

Gets the number of pages of this file.

Declaration

public int PageCount { get; set; }

Property Value

Type	Description
System.Int32

Pages

Declaration

public Pages Pages { get; set; }

Property Value

Type	Description
Pages

RenderingRelationLink

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

Declaration

public string RenderingRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “rendering” 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.

SelfRelationLink

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

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “self” 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

GetAdhocRenderingFileFromSelfRelation()

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

Declaration

public AdhocRenderingFile GetAdhocRenderingFileFromSelfRelation()

Returns

Type	Description
AdhocRenderingFile	The content of the response.

GetAdhocRenderingFileFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>> GetAdhocRenderingFileFromSelfRelationAsync()

Returns

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

Remarks

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

GetAdhocRenderingFileFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<AdhocRenderingFile>> GetAdhocRenderingFileFromSelfRelationAsync(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<AdhocRenderingFile>>	A task which runs the request.

Remarks

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

PostToRenderingRelationForStream(AdhocRenderingQuery)

Calls the HTTP Post method on the link for the relation “rendering”.

Declaration

public System.IO.Stream PostToRenderingRelationForStream(AdhocRenderingQuery dataToSend)

Parameters

Type	Name	Description
AdhocRenderingQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToRenderingRelationForStreamAsync(AdhocRenderingQuery)

Calls the HTTP Post method on the link for the relation “rendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToRenderingRelationForStreamAsync(AdhocRenderingQuery dataToSend)

Parameters

Type	Name	Description
AdhocRenderingQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToRenderingRelationForStreamAsync(System.Threading.CancellationToken, AdhocRenderingQuery)

Calls the HTTP Post method on the link for the relation “rendering” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToRenderingRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, AdhocRenderingQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
AdhocRenderingQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

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.