Class Section
Define a single section of a document
Inheritance
Implements
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class Section : IRelationsWithProxy, IChunkable
Constructors
Section()
Creates a new instance of this class
Declaration
public Section()
Properties
AnnotationAsSvgRelationLink
Gets the Uri of the link for the relation “annotationAsSvg”.
Declaration
public string AnnotationAsSvgRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “annotationAsSvg” if it exists, or
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.
Declaration
public bool AnnotationsPreview { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AppPropertiesRelationLink
Gets the Uri of the link for the relation “appProperties”.
Declaration
public string AppPropertiesRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “appProperties” if it exists, or
ContentModified
Time when content is last modified
Declaration
public System.DateTime ContentModified { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
ContentRelationLink
Gets the Uri of the link for the relation “content”.
Declaration
public string ContentRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “content” if it exists, or
ContentType
The Internet media type of the section. If there is no section this value is missing.
Declaration
public string ContentType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DeepZoomImageRelationLink
Gets the Uri of the link for the relation “deepZoomImage”.
Declaration
public string DeepZoomImageRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “deepZoomImage” if it exists, or
DeepZoomImageWithAnnotationRelationLink
Gets the Uri of the link for the relation “deepZoomImageWithAnnotation”.
Declaration
public string DeepZoomImageWithAnnotationRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “deepZoomImageWithAnnotation” if it exists, or
DocumentRelationLink
Gets the Uri of the link for the relation “document”.
Declaration
public string DocumentRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “document” if it exists, or
FileChunk
Contains data for a file chunk during a big file upload. This data is created on the server of every chunk request.
Declaration
public UploadedFileChunk FileChunk { get; set; }
Property Value
Type | Description |
---|---|
UploadedFileChunk |
FileDownloadRelationLink
Gets the Uri of the link for the relation “fileDownload”.
Declaration
public string FileDownloadRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “fileDownload” if it exists, or
FileSize
The size of the file in bytes.
Declaration
public long FileSize { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
HasTextAnnotation
Contains true if the section has text annotation.
Declaration
public bool HasTextAnnotation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
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
Declaration
public bool HaveMorePages { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IconRelationLink
Gets the Uri of the link for the relation “icon”.
Declaration
public string IconRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “icon” if it exists, or
Id
Identity of the section
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
OriginalFileName
Original file name with extension
Declaration
public string OriginalFileName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PageCount
The number of pages of this section, if known. If it is unknown, this value is -1.
Declaration
public int PageCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Pages
Contains one or more pages of the document, if there are pages available.
Declaration
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”.
Declaration
public string PagesBlockRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “pagesBlock” if it exists, or
PositionsRelationLink
Gets the Uri of the link for the relation “positions”.
Declaration
public string PositionsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “positions” if it exists, or
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
SignatureStatus
Define allowed operations when there is signature
Declaration
public List<SignatureStatus> SignatureStatus { get; set; }
Property Value
Type | Description |
---|---|
List<SignatureStatus> |
TextAnnotationRelationLink
Gets the Uri of the link for the relation “textAnnotation”.
Declaration
public string TextAnnotationRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “textAnnotation” if it exists, or
TextshotRelationLink
Gets the Uri of the link for the relation “textshot”.
Declaration
public string TextshotRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “textshot” if it exists, or
ThumbnailRelationLink
Gets the Uri of the link for the relation “thumbnail”.
Declaration
public string ThumbnailRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “thumbnail” if it exists, or
Thumbnails
Similar to Pages, but contains only links and page number.
Declaration
public Pages Thumbnails { get; set; }
Property Value
Type | Description |
---|---|
Pages |
Methods
DeleteSelfRelation()
Calls the HTTP Delete method on the link for the relation “self”.
Declaration
public string DeleteSelfRelation()
Returns
Type | Description |
---|---|
System.String | The content of the response. |
DeleteSelfRelationAsync()
Calls the HTTP Delete method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
DeleteSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Delete method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(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<System.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> | A task which runs the request. |
Remarks
This method follows the link for the relation “appProperties”.
GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “appProperties” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentContent>> GetDocumentContentFromTextshotRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentContent>> | A task which runs the request. |
Remarks
This method follows the link for the relation “textshot”.
GetDocumentContentFromTextshotRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “textshot” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentContent>> GetDocumentContentFromTextshotRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> | A task which runs the request. |
Remarks
This method follows the link for the relation “document”.
GetDocumentFromDocumentRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “document” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> GetSectionFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetSectionFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> GetSectionFromSelfRelationAsync(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<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”.
Declaration
public System.IO.Stream GetStreamFromAnnotationAsSvgRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromAnnotationAsSvgRelationAsync()
Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync()
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 “annotationAsSvg”.
GetStreamFromAnnotationAsSvgRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromContentRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromContentRelationAsync()
Calls the HTTP Get method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync()
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 “content”.
GetStreamFromContentRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromDeepZoomImageRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromDeepZoomImageRelationAsync()
Calls the HTTP Get method on the link for the relation “deepZoomImage” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageRelationAsync()
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 “deepZoomImage”.
GetStreamFromDeepZoomImageRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “deepZoomImage” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromDeepZoomImageWithAnnotationRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromDeepZoomImageWithAnnotationRelationAsync()
Calls the HTTP Get method on the link for the relation “deepZoomImageWithAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync()
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 “deepZoomImageWithAnnotation”.
GetStreamFromDeepZoomImageWithAnnotationRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “deepZoomImageWithAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromFileDownloadRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromFileDownloadRelationAsync()
Calls the HTTP Get method on the link for the relation “fileDownload” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromFileDownloadRelationAsync()
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 “fileDownload”.
GetStreamFromFileDownloadRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “fileDownload” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromFileDownloadRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromIconRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromIconRelationAsync()
Calls the HTTP Get method on the link for the relation “icon” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromIconRelationAsync()
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 “icon”.
GetStreamFromIconRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “icon” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromIconRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromTextAnnotationRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromTextAnnotationRelationAsync()
Calls the HTTP Get method on the link for the relation “textAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTextAnnotationRelationAsync()
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 “textAnnotation”.
GetStreamFromTextAnnotationRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “textAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTextAnnotationRelationAsync(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<System.IO.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”.
Declaration
public System.IO.Stream GetStreamFromThumbnailRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromThumbnailRelationAsync()
Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync()
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 “thumbnail”.
GetStreamFromThumbnailRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync(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<System.IO.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromPositionsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “positions”.
GetWordSearchResultFromPositionsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “positions” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromPositionsRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> | A task which runs the request. |
Remarks
This method follows the link for the relation “appProperties”.
PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(System.Threading.CancellationToken, DocumentApplicationProperties)
Calls the HTTP Post method on the link for the relation “appProperties” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(System.Threading.CancellationToken cancellationToken, DocumentApplicationProperties dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> | A task which runs the request. |
Remarks
This method follows the link for the relation “appProperties”.
PostToContentRelationForSection(String, System.IO.Stream)
Calls the HTTP Post method on the link for the relation “content”.
Declaration
public Section PostToContentRelationForSection(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.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, System.IO.Stream)
Calls the HTTP Post method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToContentRelationForSectionAsync(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.Stream | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> | A task which runs the request. |
Remarks
This method follows the link for the relation “content”.
PostToContentRelationForSectionAsync(System.Threading.CancellationToken, String, System.IO.Stream)
Calls the HTTP Post method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToContentRelationForSectionAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.Stream | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.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”.
Declaration
public System.IO.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 |
---|---|
System.IO.Stream | The content of the response. |
PostToFileDownloadRelationForStreamAsync(FileDownload)
Calls the HTTP Post method on the link for the relation “fileDownload” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> | A task which runs the request. |
Remarks
This method follows the link for the relation “fileDownload”.
PostToFileDownloadRelationForStreamAsync(System.Threading.CancellationToken, FileDownload)
Calls the HTTP Post method on the link for the relation “fileDownload” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToFileDownloadRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, FileDownload dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Pages>> | A task which runs the request. |
Remarks
This method follows the link for the relation “pagesBlock”.
PostToPagesBlockRelationForPagesAsync(System.Threading.CancellationToken, PagesBlockQuery)
Calls the HTTP Post method on the link for the relation “pagesBlock” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Pages>> PostToPagesBlockRelationForPagesAsync(System.Threading.CancellationToken cancellationToken, PagesBlockQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “positions”.
PostToPositionsRelationForWordSearchResultAsync(System.Threading.CancellationToken, SearchPositionQuery)
Calls the HTTP Post method on the link for the relation “positions” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> PostToPositionsRelationForWordSearchResultAsync(System.Threading.CancellationToken cancellationToken, SearchPositionQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WordSearchResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “positions”.
PostToTextAnnotationRelationForStream(System.IO.Stream)
Calls the HTTP Post method on the link for the relation “textAnnotation”.
Declaration
public System.IO.Stream PostToTextAnnotationRelationForStream(System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
PostToTextAnnotationRelationForStreamAsync(System.IO.Stream)
Calls the HTTP Post method on the link for the relation “textAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTextAnnotationRelationForStreamAsync(System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | 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 “textAnnotation”.
PostToTextAnnotationRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)
Calls the HTTP Post method on the link for the relation “textAnnotation” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTextAnnotationRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
System.IO.Stream | 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 “textAnnotation”.
PutToContentRelationForSection(String, System.IO.Stream)
Calls the HTTP Put method on the link for the relation “content”.
Declaration
public Section PutToContentRelationForSection(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.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, System.IO.Stream)
Calls the HTTP Put method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PutToContentRelationForSectionAsync(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.Stream | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> | A task which runs the request. |
Remarks
This method follows the link for the relation “content”.
PutToContentRelationForSectionAsync(System.Threading.CancellationToken, String, System.IO.Stream)
Calls the HTTP Put method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PutToContentRelationForSectionAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
System.String | requestedContentType | Mime type of the requested body content, i.e. application/pdf. |
System.IO.Stream | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.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”.
Declaration
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 |
---|---|
System.String | The content of the response. |
PutToTextshotRelationForStringAsync(DocumentContent)
Calls the HTTP Put method on the link for the relation “textshot” asynchronously.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>> | A task which runs the request. |
Remarks
This method follows the link for the relation “textshot”.
PutToTextshotRelationForStringAsync(System.Threading.CancellationToken, DocumentContent)
Calls the HTTP Put method on the link for the relation “textshot” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToTextshotRelationForStringAsync(System.Threading.CancellationToken cancellationToken, DocumentContent dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<System.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.
Declaration
public void SetProxy(HttpClientProxy proxy)
Parameters
Type | Name | Description |
---|---|---|
HttpClientProxy | proxy | The |
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.