Class AdhocRenderingFile

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Main class for managing adhoc rendering file.

public class AdhocRenderingFile : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

AdhocRenderingFile

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Id

public string Id { get; set; }

Property Value

Type	Description
string

Links

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.

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

Property Value

Type	Description
List<KeyValuePair>

PageCount

Gets the number of pages of this file.

public int PageCount { get; set; }

Property Value

Type	Description
int

Pages

public Pages Pages { get; set; }

Property Value

Type	Description
Pages

RenderingRelationLink

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

public string RenderingRelationLink { get; }

Property Value

Type	Description
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”.

public string SelfRelationLink { get; }

Property Value

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<AdhocRenderingFile>> GetAdhocRenderingFileFromSelfRelationAsync()

Returns

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

Remarks

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

GetAdhocRenderingFileFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<AdhocRenderingFile>> GetAdhocRenderingFileFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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”.

public 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
Stream	The content of the response.

PostToRenderingRelationForStreamAsync(AdhocRenderingQuery)

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

public Task<DeserializedHttpResponse<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
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

PostToRenderingRelationForStreamAsync(CancellationToken, AdhocRenderingQuery)

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

public Task<DeserializedHttpResponse<Stream>> PostToRenderingRelationForStreamAsync(CancellationToken cancellationToken, AdhocRenderingQuery dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient 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.