Class Page

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Gets information about specific page.

public class Page : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Page

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()

Constructors

Page()

Creates a new instance of this class

public Page()

Properties

AnnotationAsSvgRelationLink

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

public string AnnotationAsSvgRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

AnnotationAsXamlRelationLink

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

public string AnnotationAsXamlRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

AnnotationRelationLink

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

public string AnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Data

public PageData Data { get; set; }

Property Value

Type	Description
PageData

DeepZoomImageRelationLink

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

public string DeepZoomImageRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

DeepZoomImageWithAnnotationRelationLink

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

public string DeepZoomImageWithAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

FileDownloadRelationLink

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

public string FileDownloadRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

HasAnnotation

True if the page contains at least one annotation.

public bool HasAnnotation { get; set; }

Property Value

Type	Description
bool

IconRelationLink

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

public string IconRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LowQualityImageRelationLink

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

public string LowQualityImageRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

LowQualityImageWithAnnotationRelationLink

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

public string LowQualityImageWithAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

PageNum

Zero based page number.

public int PageNum { get; set; }

Property Value

Type	Description
int

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.

StampBestPositionRelationLink

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

public string StampBestPositionRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

StampRelationLink

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

public string StampRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

TextshotRelationLink

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

public string TextshotRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ThumbnailRelationLink

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

public string ThumbnailRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

GetAnnotationFromAnnotationRelation()

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

public Annotation GetAnnotationFromAnnotationRelation()

Returns

Type	Description
Annotation	The content of the response.

GetAnnotationFromAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Annotation>> GetAnnotationFromAnnotationRelationAsync()

Returns

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

Remarks

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

GetAnnotationFromAnnotationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Annotation>> GetAnnotationFromAnnotationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetPageContentFromTextshotRelation()

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

public PageContent GetPageContentFromTextshotRelation()

Returns

Type	Description
PageContent	The content of the response.

GetPageContentFromTextshotRelationAsync()

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

public Task<DeserializedHttpResponse<PageContent>> GetPageContentFromTextshotRelationAsync()

Returns

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

Remarks

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

GetPageContentFromTextshotRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<PageContent>> GetPageContentFromTextshotRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetPageFromSelfRelation()

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

public Page GetPageFromSelfRelation()

Returns

Type	Description
Page	The content of the response.

GetPageFromSelfRelationAsync()

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

public Task<DeserializedHttpResponse<Page>> GetPageFromSelfRelationAsync()

Returns

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

Remarks

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

GetPageFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Page>> GetPageFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromAnnotationAsSvgRelation()

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

public Stream GetStreamFromAnnotationAsSvgRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromAnnotationAsSvgRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAnnotationAsSvgRelationAsync()

Returns

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

Remarks

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

GetStreamFromAnnotationAsSvgRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAnnotationAsSvgRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromDeepZoomImageRelation()

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

public Stream GetStreamFromDeepZoomImageRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromDeepZoomImageRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageRelationAsync()

Returns

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

Remarks

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

GetStreamFromDeepZoomImageRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelation()

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

public Stream GetStreamFromDeepZoomImageWithAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromFileDownloadRelation()

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

public Stream GetStreamFromFileDownloadRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromFileDownloadRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromFileDownloadRelationAsync()

Returns

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

Remarks

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

GetStreamFromFileDownloadRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromFileDownloadRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromIconRelation()

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

public Stream GetStreamFromIconRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromIconRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromIconRelationAsync()

Returns

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

Remarks

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

GetStreamFromIconRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromIconRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromLowQualityImageRelation()

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

public Stream GetStreamFromLowQualityImageRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromLowQualityImageRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageRelationAsync()

Returns

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

Remarks

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

GetStreamFromLowQualityImageRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromLowQualityImageWithAnnotationRelation()

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

public Stream GetStreamFromLowQualityImageWithAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromLowQualityImageWithAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageWithAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromLowQualityImageWithAnnotationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageWithAnnotationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromThumbnailRelation()

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

public Stream GetStreamFromThumbnailRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromThumbnailRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromThumbnailRelationAsync()

Returns

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

Remarks

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

GetStreamFromThumbnailRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromThumbnailRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetXElementWrapperFromAnnotationAsXamlRelation()

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

public XElementWrapper GetXElementWrapperFromAnnotationAsXamlRelation()

Returns

Type	Description
XElementWrapper	The content of the response.

GetXElementWrapperFromAnnotationAsXamlRelationAsync()

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

public Task<DeserializedHttpResponse<XElementWrapper>> GetXElementWrapperFromAnnotationAsXamlRelationAsync()

Returns

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

Remarks

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

GetXElementWrapperFromAnnotationAsXamlRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<XElementWrapper>> GetXElementWrapperFromAnnotationAsXamlRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForAnnotation(Annotation)

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

public Annotation PostToAnnotationRelationForAnnotation(Annotation dataToSend)

Parameters

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

Returns

Type	Description
Annotation	The content of the response.

PostToAnnotationRelationForAnnotation(AnnotationsPlacement)

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

public Annotation PostToAnnotationRelationForAnnotation(AnnotationsPlacement dataToSend)

Parameters

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

Returns

Type	Description
Annotation	The content of the response.

PostToAnnotationRelationForAnnotationAsync(Annotation)

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

public Task<DeserializedHttpResponse<Annotation>> PostToAnnotationRelationForAnnotationAsync(Annotation dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForAnnotationAsync(AnnotationsPlacement)

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

public Task<DeserializedHttpResponse<Annotation>> PostToAnnotationRelationForAnnotationAsync(AnnotationsPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForAnnotationAsync(CancellationToken, Annotation)

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

public Task<DeserializedHttpResponse<Annotation>> PostToAnnotationRelationForAnnotationAsync(CancellationToken cancellationToken, Annotation dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForAnnotationAsync(CancellationToken, AnnotationsPlacement)

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

public Task<DeserializedHttpResponse<Annotation>> PostToAnnotationRelationForAnnotationAsync(CancellationToken cancellationToken, AnnotationsPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToFileDownloadRelationForStream(FileDownloadPage)

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

public Stream PostToFileDownloadRelationForStream(FileDownloadPage dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToFileDownloadRelationForStreamAsync(FileDownloadPage)

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

public Task<DeserializedHttpResponse<Stream>> PostToFileDownloadRelationForStreamAsync(FileDownloadPage dataToSend)

Parameters

Type	Name	Description
FileDownloadPage	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 “fileDownload”.

PostToFileDownloadRelationForStreamAsync(CancellationToken, FileDownloadPage)

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

public Task<DeserializedHttpResponse<Stream>> PostToFileDownloadRelationForStreamAsync(CancellationToken cancellationToken, FileDownloadPage dataToSend)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.
FileDownloadPage	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 “fileDownload”.

PostToStampBestPositionRelationForDWPoint(StampFormFieldValues)

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

public DWPoint PostToStampBestPositionRelationForDWPoint(StampFormFieldValues dataToSend)

Parameters

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

Returns

Type	Description
DWPoint	The content of the response.

PostToStampBestPositionRelationForDWPointAsync(StampFormFieldValues)

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

public Task<DeserializedHttpResponse<DWPoint>> PostToStampBestPositionRelationForDWPointAsync(StampFormFieldValues dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToStampBestPositionRelationForDWPointAsync(CancellationToken, StampFormFieldValues)

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

public Task<DeserializedHttpResponse<DWPoint>> PostToStampBestPositionRelationForDWPointAsync(CancellationToken cancellationToken, StampFormFieldValues dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToStampRelationForAnnotation(StampPlacement)

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

public Annotation PostToStampRelationForAnnotation(StampPlacement dataToSend)

Parameters

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

Returns

Type	Description
Annotation	The content of the response.

PostToStampRelationForAnnotationAsync(StampPlacement)

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

public Task<DeserializedHttpResponse<Annotation>> PostToStampRelationForAnnotationAsync(StampPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToStampRelationForAnnotationAsync(CancellationToken, StampPlacement)

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

public Task<DeserializedHttpResponse<Annotation>> PostToStampRelationForAnnotationAsync(CancellationToken cancellationToken, StampPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

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.