Class TableResultRow

Define a row of the table result from document query

Inheritance
System.Object
TableResultRow
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class TableResultRow : IRelationsWithProxy

Constructors

TableResultRow()

Creates a new instance of this class

Declaration
public TableResultRow()

Properties

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

Declaration
public string AnnotationAsSvgRelationLink { get; }
Property Value
Type Description
System.String

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 document may contain any annotations on the first section and 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

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

Declaration
public string ClippedDocumentsRelationLink { get; }
Property Value
Type Description
System.String

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

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

Declaration
public string FieldsRelationLink { get; }
Property Value
Type Description
System.String

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

Id of the document represented by the current row.

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

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

Declaration
public string IntellixRelationLink { get; }
Property Value
Type Description
System.String

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

Items

Declaration
public List<object> Items { get; set; }
Property Value
Type Description
List<System.Object>
Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

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

Declaration
public string LockRelationLink { get; }
Property Value
Type Description
System.String

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

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

Declaration
public string LowQualityImageRelationLink { get; }
Property Value
Type Description
System.String

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.

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

Declaration
public string RightsRelationLink { get; }
Property Value
Type Description
System.String

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

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

Declaration
public string SectionsRelationLink { get; }
Property Value
Type Description
System.String

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

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

Declaration
public string SelfRelationLink { get; }
Property Value
Type Description
System.String

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.

Suggestions

Suggestions for the simple fields of a document

Declaration
public List<SuggestionField> Suggestions { get; set; }
Property Value
Type Description
List<SuggestionField>

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

Declaration
public string SuggestionsRelationLink { get; }
Property Value
Type Description
System.String

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

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

Declaration
public string TableFieldsSuggestionsRelationLink { get; }
Property Value
Type Description
System.String

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

TableFieldSuggestions

Suggestions for the table fields of a document

Declaration
public List<SuggestionTableField> TableFieldSuggestions { get; set; }
Property Value
Type Description
List<SuggestionTableField>

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

Declaration
public string ThumbnailRelationLink { get; }
Property Value
Type Description
System.String

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.

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

Declaration
public string ThumbnailWithoutAnnotationRelationLink { get; }
Property Value
Type Description
System.String

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

DeleteLockRelation()

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

Declaration
public string DeleteLockRelation()
Returns
Type Description
System.String

The content of the response.

DeleteLockRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync()
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 “lock”.

DeleteLockRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync(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 “lock”.

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

GetDocumentFromSelfRelation()

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

Declaration
public Document GetDocumentFromSelfRelation()
Returns
Type Description
Document

The content of the response.

GetDocumentFromSelfRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>

A task which runs the request.
Remarks

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

GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync(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 “self”.

GetDocumentIndexFieldsFromFieldsRelation()

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

Declaration
public DocumentIndexFields GetDocumentIndexFieldsFromFieldsRelation()
Returns
Type Description
DocumentIndexFields

The content of the response.

GetDocumentIndexFieldsFromFieldsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>>

A task which runs the request.
Remarks

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

GetDocumentIndexFieldsFromFieldsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync(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<DocumentIndexFields>>

A task which runs the request.
Remarks

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

GetSectionsFromSectionsRelation()

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

Declaration
public Sections GetSectionsFromSectionsRelation()
Returns
Type Description
Sections

The content of the response.

GetSectionsFromSectionsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Sections>>

A task which runs the request.
Remarks

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

GetSectionsFromSectionsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync(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<Sections>>

A task which runs the request.
Remarks

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

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

GetStreamFromLowQualityImageRelation()

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

Declaration
public System.IO.Stream GetStreamFromLowQualityImageRelation()
Returns
Type Description
System.IO.Stream

The content of the response.

GetStreamFromLowQualityImageRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync()
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 “lowQualityImage”.

GetStreamFromLowQualityImageRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync(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 “lowQualityImage”.

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

GetStreamFromThumbnailWithoutAnnotationRelation()

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

Declaration
public System.IO.Stream GetStreamFromThumbnailWithoutAnnotationRelation()
Returns
Type Description
System.IO.Stream

The content of the response.

GetStreamFromThumbnailWithoutAnnotationRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailWithoutAnnotationRelationAsync()
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 “thumbnailWithoutAnnotation”.

GetStreamFromThumbnailWithoutAnnotationRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailWithoutAnnotationRelationAsync(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 “thumbnailWithoutAnnotation”.

GetSuggestionFieldsFromSuggestionsRelation()

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

Declaration
public SuggestionFields GetSuggestionFieldsFromSuggestionsRelation()
Returns
Type Description
SuggestionFields

The content of the response.

GetSuggestionFieldsFromSuggestionsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionFields>>

A task which runs the request.
Remarks

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

GetSuggestionFieldsFromSuggestionsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync(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<SuggestionFields>>

A task which runs the request.
Remarks

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

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelation()

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

Declaration
public SuggestionTableFields GetSuggestionTableFieldsFromTableFieldsSuggestionsRelation()
Returns
Type Description
SuggestionTableFields

The content of the response.

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionTableFields>>

A task which runs the request.
Remarks

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

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(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<SuggestionTableFields>>

A task which runs the request.
Remarks

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

PostToLockRelationForString(LockInfo)

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

Declaration
public string PostToLockRelationForString(LockInfo dataToSend)
Parameters
Type Name Description
LockInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.String

The content of the response.

PostToLockRelationForStringAsync(LockInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(LockInfo dataToSend)
Parameters
Type Name Description
LockInfo 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 “lock”.

PostToLockRelationForStringAsync(System.Threading.CancellationToken, LockInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(System.Threading.CancellationToken cancellationToken, LockInfo dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
LockInfo 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 “lock”.

PostToRightsRelationForSection(String, System.IO.Stream)

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

Declaration
public Section PostToRightsRelationForSection(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.

PostToRightsRelationForSectionAsync(String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(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 “rights”.

PostToRightsRelationForSectionAsync(System.Threading.CancellationToken, String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(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 “rights”.

PostToSectionsRelationForSection(String, System.IO.Stream)

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

Declaration
public Section PostToSectionsRelationForSection(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.

PostToSectionsRelationForSectionAsync(String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(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 “sections”.

PostToSectionsRelationForSectionAsync(System.Threading.CancellationToken, String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(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 “sections”.

PostToSelfRelationForDocument(String, System.IO.Stream)

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

Declaration
public Document PostToSelfRelationForDocument(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
Document

The content of the response.

PostToSelfRelationForDocumentAsync(String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(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<Document>>

A task which runs the request.
Remarks

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

PostToSelfRelationForDocumentAsync(System.Threading.CancellationToken, String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(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<Document>>

A task which runs the request.
Remarks

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

PutToClippedDocumentsRelationForDocument(IntegerList)

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

Declaration
public Document PutToClippedDocumentsRelationForDocument(IntegerList dataToSend)
Parameters
Type Name Description
IntegerList dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
Document

The content of the response.

PutToClippedDocumentsRelationForDocumentAsync(IntegerList)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(IntegerList dataToSend)
Parameters
Type Name Description
IntegerList dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>

A task which runs the request.
Remarks

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

PutToClippedDocumentsRelationForDocumentAsync(System.Threading.CancellationToken, IntegerList)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, IntegerList dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
IntegerList dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>

A task which runs the request.
Remarks

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

PutToFieldsRelationForDocumentIndexFields(DocumentIndexFields)

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

Declaration
public DocumentIndexFields PutToFieldsRelationForDocumentIndexFields(DocumentIndexFields dataToSend)
Parameters
Type Name Description
DocumentIndexFields dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
DocumentIndexFields

The content of the response.

PutToFieldsRelationForDocumentIndexFields(UpdateIndexFieldsInfo)

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

Declaration
public DocumentIndexFields PutToFieldsRelationForDocumentIndexFields(UpdateIndexFieldsInfo dataToSend)
Parameters
Type Name Description
UpdateIndexFieldsInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
DocumentIndexFields

The content of the response.

PutToFieldsRelationForDocumentIndexFieldsAsync(DocumentIndexFields)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(DocumentIndexFields dataToSend)
Parameters
Type Name Description
DocumentIndexFields dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>>

A task which runs the request.
Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(UpdateIndexFieldsInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(UpdateIndexFieldsInfo dataToSend)
Parameters
Type Name Description
UpdateIndexFieldsInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>>

A task which runs the request.
Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken, DocumentIndexFields)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken cancellationToken, DocumentIndexFields dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
DocumentIndexFields dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>>

A task which runs the request.
Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken, UpdateIndexFieldsInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken cancellationToken, UpdateIndexFieldsInfo dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
UpdateIndexFieldsInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>>

A task which runs the request.
Remarks

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

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration
public void SetProxy(HttpClientProxy proxy)
Parameters
Type Name Description
HttpClientProxy proxy

The instance which is used in further HTTP communication.
Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.