Class Section

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Define a single section of a document

public class Section : IChunkable, IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Section

Implements

IChunkable

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PartialDownloadExtensionBase.DownloadContentAsync(Section, int, int)

Constructors

Section()

Creates a new instance of this class

public Section()

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.

AnnotationsPreview

Contains true if the section may contain any annotations on the first page. If this is false there is no need the AnnotationsAsImage link to be called.

[Lobster]
public bool AnnotationsPreview { get; set; }

Property Value

Type	Description
bool

AppPropertiesRelationLink

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

public string AppPropertiesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ContentModified

Time when content is last modified

[Dolphin]
public DateTime ContentModified { get; set; }

Property Value

Type	Description
DateTime

ContentRelationLink

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

public string ContentRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ContentType

The Internet media type of the section. If there is no section this value is missing.

public string ContentType { get; set; }

Property Value

Type	Description
string

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.

DocumentRelationLink

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

public string DocumentRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

FileChunk

Contains data for a file chunk during a big file upload. This data is created on the server of every chunk request.

[Eagle]
public UploadedFileChunk FileChunk { get; set; }

Property Value

Type	Description
UploadedFileChunk

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.

FileSize

The size of the file in bytes.

public long FileSize { get; set; }

Property Value

Type	Description
long

HasTextAnnotation

Contains true if the section has text annotation.

[Eagle]
public bool HasTextAnnotation { get; set; }

Property Value

Type	Description
bool

HaveMorePages

Contains true if all pages are known so PageCount contains exact number the pages in section. If the value is set to false there are more pagesm but at least the number set in PageCount

public bool HaveMorePages { 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.

Id

Identity of the section

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

OriginalFileName

Original file name with extension

public string OriginalFileName { get; set; }

Property Value

Type	Description
string

PageCount

The number of pages of this section, if known. If it is unknown, this value is -1.

public int PageCount { get; set; }

Property Value

Type	Description
int

Pages

Contains one or more pages of the document, if there are pages available.

public Pages Pages { get; set; }

Property Value

Type	Description
Pages

Remarks

Note that not all pages are necessarily listed here; it depends on the server's choice. However you still can get all pages of a document when you follow the links specified in the Pages date.

PagesBlockRelationLink

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

public string PagesBlockRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

PositionsRelationLink

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

public string PositionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

SignatureStatus

Define allowed operations when there is signature

public List<SignatureStatus> SignatureStatus { get; set; }

Property Value

Type	Description
List<SignatureStatus>

TextAnnotationRelationLink

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

public string TextAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Thumbnails

Similar to Pages, but contains only links and page number.

public Pages Thumbnails { get; set; }

Property Value

Type	Description
Pages

Methods

DeleteSelfRelation()

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

public string DeleteSelfRelation()

Returns

Type	Description
string	The content of the response.

DeleteSelfRelationAsync()

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

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

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

Remarks

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

DeleteSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentApplicationPropertiesFromAppPropertiesRelation()

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

public DocumentApplicationProperties GetDocumentApplicationPropertiesFromAppPropertiesRelation()

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

Returns

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

Remarks

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

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentContentFromTextshotRelation()

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

public DocumentContent GetDocumentContentFromTextshotRelation()

Returns

Type	Description
DocumentContent	The content of the response.

GetDocumentContentFromTextshotRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentContent>> GetDocumentContentFromTextshotRelationAsync()

Returns

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

Remarks

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

GetDocumentContentFromTextshotRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentContent>> GetDocumentContentFromTextshotRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentFromDocumentRelation()

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

public Document GetDocumentFromDocumentRelation()

Returns

Type	Description
Document	The content of the response.

GetDocumentFromDocumentRelationAsync()

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

public Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync()

Returns

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

Remarks

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

GetDocumentFromDocumentRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetSectionFromSelfRelation()

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

public Section GetSectionFromSelfRelation()

Returns

Type	Description
Section	The content of the response.

GetSectionFromSelfRelationAsync()

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

public Task<DeserializedHttpResponse<Section>> GetSectionFromSelfRelationAsync()

Returns

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

Remarks

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

GetSectionFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Section>> GetSectionFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

GetStreamFromContentRelation()

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

public Stream GetStreamFromContentRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromContentRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromContentRelationAsync()

Returns

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

Remarks

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

GetStreamFromContentRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromContentRelationAsync(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 “content”.

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

GetStreamFromTextAnnotationRelation()

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

public Stream GetStreamFromTextAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromTextAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromTextAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromTextAnnotationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromTextAnnotationRelationAsync(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 “textAnnotation”.

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

GetWordSearchResultFromPositionsRelation()

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

public WordSearchResult GetWordSearchResultFromPositionsRelation()

Returns

Type	Description
WordSearchResult	The content of the response.

GetWordSearchResultFromPositionsRelationAsync()

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

public Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromPositionsRelationAsync()

Returns

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

Remarks

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

GetWordSearchResultFromPositionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromPositionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToAppPropertiesRelationForDocumentApplicationProperties(DocumentApplicationProperties)

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

public DocumentApplicationProperties PostToAppPropertiesRelationForDocumentApplicationProperties(DocumentApplicationProperties dataToSend)

Parameters

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

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(DocumentApplicationProperties)

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

public Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(DocumentApplicationProperties dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(CancellationToken, DocumentApplicationProperties)

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

public Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(CancellationToken cancellationToken, DocumentApplicationProperties dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToContentRelationForSection(string, Stream)

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

public Section PostToContentRelationForSection(string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Section	The content of the response.

PostToContentRelationForSectionAsync(string, Stream)

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

public Task<DeserializedHttpResponse<Section>> PostToContentRelationForSectionAsync(string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToContentRelationForSectionAsync(CancellationToken, string, Stream)

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

public Task<DeserializedHttpResponse<Section>> PostToContentRelationForSectionAsync(CancellationToken cancellationToken, string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToFileDownloadRelationForStream(FileDownload)

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

public Stream PostToFileDownloadRelationForStream(FileDownload dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToFileDownloadRelationForStreamAsync(FileDownload)

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

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

Parameters

Type	Name	Description
FileDownload	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, FileDownload)

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

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

Parameters

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

PostToPagesBlockRelationForPages(PagesBlockQuery)

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

public Pages PostToPagesBlockRelationForPages(PagesBlockQuery dataToSend)

Parameters

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

Returns

Type	Description
Pages	The content of the response.

PostToPagesBlockRelationForPagesAsync(PagesBlockQuery)

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

public Task<DeserializedHttpResponse<Pages>> PostToPagesBlockRelationForPagesAsync(PagesBlockQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToPagesBlockRelationForPagesAsync(CancellationToken, PagesBlockQuery)

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

public Task<DeserializedHttpResponse<Pages>> PostToPagesBlockRelationForPagesAsync(CancellationToken cancellationToken, PagesBlockQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToPositionsRelationForWordSearchResult(SearchPositionQuery)

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

public WordSearchResult PostToPositionsRelationForWordSearchResult(SearchPositionQuery dataToSend)

Parameters

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

Returns

Type	Description
WordSearchResult	The content of the response.

PostToPositionsRelationForWordSearchResultAsync(SearchPositionQuery)

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

public Task<DeserializedHttpResponse<WordSearchResult>> PostToPositionsRelationForWordSearchResultAsync(SearchPositionQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToPositionsRelationForWordSearchResultAsync(CancellationToken, SearchPositionQuery)

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

public Task<DeserializedHttpResponse<WordSearchResult>> PostToPositionsRelationForWordSearchResultAsync(CancellationToken cancellationToken, SearchPositionQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToTextAnnotationRelationForStream(Stream)

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

public Stream PostToTextAnnotationRelationForStream(Stream dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToTextAnnotationRelationForStreamAsync(Stream)

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

public Task<DeserializedHttpResponse<Stream>> PostToTextAnnotationRelationForStreamAsync(Stream dataToSend)

Parameters

Type	Name	Description
Stream	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 “textAnnotation”.

PostToTextAnnotationRelationForStreamAsync(CancellationToken, Stream)

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

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

Parameters

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

PutToContentRelationForSection(string, Stream)

Calls the HTTP Put method on the link for the relation “content”.

public Section PutToContentRelationForSection(string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Section	The content of the response.

PutToContentRelationForSectionAsync(string, Stream)

Calls the HTTP Put method on the link for the relation “content” asynchronously.

public Task<DeserializedHttpResponse<Section>> PutToContentRelationForSectionAsync(string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PutToContentRelationForSectionAsync(CancellationToken, string, Stream)

Calls the HTTP Put method on the link for the relation “content” asynchronously.

public Task<DeserializedHttpResponse<Section>> PutToContentRelationForSectionAsync(CancellationToken cancellationToken, string requestedContentType, Stream dataToSend)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.
string	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PutToTextshotRelationForString(DocumentContent)

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

public string PutToTextshotRelationForString(DocumentContent dataToSend)

Parameters

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

Returns

Type	Description
string	The content of the response.

PutToTextshotRelationForStringAsync(DocumentContent)

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

public Task<DeserializedHttpResponse<string>> PutToTextshotRelationForStringAsync(DocumentContent dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToTextshotRelationForStringAsync(CancellationToken, DocumentContent)

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

public Task<DeserializedHttpResponse<string>> PutToTextshotRelationForStringAsync(CancellationToken cancellationToken, DocumentContent dataToSend)

Parameters

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

Returns

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

Remarks

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

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.