Class TableResultRow

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Define a row of the table result from document query

[Hawk]
public class TableResultRow : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

TableResultRow

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TableResultRow()

Creates a new instance of this class

public TableResultRow()

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

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

Property Value

Type	Description
bool

ClippedDocumentsRelationLink

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

public string ClippedDocumentsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

FieldsRelationLink

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

public string FieldsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

public int Id { get; set; }

Property Value

Type	Description
int

IntellixRelationLink

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

public string IntellixRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

public List<object> Items { get; set; }

Property Value

Type	Description
List<object>

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LockRelationLink

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

public string LockRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

LowQualityImageRelationLink

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

public string LowQualityImageRelationLink { get; }

Property Value

Type	Description
string

Remarks

Returns the uri of the link for the relation “lowQualityImage” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

RightsRelationLink

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

public string RightsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

SectionsRelationLink

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

public string SectionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

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.

Suggestions

Suggestions for the simple fields of a document

public List<SuggestionField> Suggestions { get; set; }

Property Value

Type	Description
List<SuggestionField>

SuggestionsRelationLink

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

public string SuggestionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

TableFieldSuggestions

Suggestions for the table fields of a document

public List<SuggestionTableField> TableFieldSuggestions { get; set; }

Property Value

Type	Description
List<SuggestionTableField>

TableFieldsSuggestionsRelationLink

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

public string TableFieldsSuggestionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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.

TextshotPreviewRelationLink

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

public string TextshotPreviewRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ThumbnailWithoutAnnotationRelationLink

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

public string ThumbnailWithoutAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

public string DeleteLockRelation()

Returns

Type	Description
string	The content of the response.

DeleteLockRelationAsync()

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

public Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync()

Returns

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

Remarks

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

DeleteLockRelationAsync(CancellationToken)

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

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

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

GetDocumentFromSelfRelation()

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

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.

public Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync()

Returns

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

Remarks

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

GetDocumentFromSelfRelationAsync(CancellationToken)

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

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

GetDocumentIndexFieldsFromFieldsRelation()

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

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.

public Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync()

Returns

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

Remarks

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

GetDocumentIndexFieldsFromFieldsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync()

Returns

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

Remarks

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

GetSectionsFromSectionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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

GetStreamFromLowQualityImageRelation()

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

public Stream GetStreamFromLowQualityImageRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromLowQualityImageRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageRelationAsync()

Returns

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

Remarks

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

GetStreamFromLowQualityImageRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

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

GetStreamFromThumbnailWithoutAnnotationRelation()

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

public Stream GetStreamFromThumbnailWithoutAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromThumbnailWithoutAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromThumbnailWithoutAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromThumbnailWithoutAnnotationRelationAsync(CancellationToken)

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

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

GetStringFromTextshotPreviewRelation()

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

public string GetStringFromTextshotPreviewRelation()

Returns

Type	Description
string	The content of the response.

GetStringFromTextshotPreviewRelationAsync()

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

public Task<DeserializedHttpResponse<string>> GetStringFromTextshotPreviewRelationAsync()

Returns

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

Remarks

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

GetStringFromTextshotPreviewRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<string>> GetStringFromTextshotPreviewRelationAsync(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 “textshotPreview”.

GetSuggestionFieldsFromSuggestionsRelation()

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

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.

public Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync()

Returns

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

Remarks

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

GetSuggestionFieldsFromSuggestionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync()

Returns

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

Remarks

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

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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

PostToLockRelationForStringAsync(LockInfo)

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

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

Remarks

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

PostToLockRelationForStringAsync(CancellationToken, LockInfo)

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

public Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(CancellationToken cancellationToken, LockInfo dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

PostToRightsRelationForRights(Rights)

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

public Rights PostToRightsRelationForRights(Rights dataToSend)

Parameters

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

Returns

Type	Description
Rights	The content of the response.

PostToRightsRelationForRightsAsync(Rights)

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

public Task<DeserializedHttpResponse<Rights>> PostToRightsRelationForRightsAsync(Rights dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToRightsRelationForRightsAsync(CancellationToken, Rights)

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

public Task<DeserializedHttpResponse<Rights>> PostToRightsRelationForRightsAsync(CancellationToken cancellationToken, Rights dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSectionsRelationForSection(string, Stream)

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

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

PostToSectionsRelationForSectionAsync(string, Stream)

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

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

PostToSectionsRelationForSectionAsync(CancellationToken, string, Stream)

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

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

PostToSelfRelationForDocument(string, Stream)

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

public Document PostToSelfRelationForDocument(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
Document	The content of the response.

PostToSelfRelationForDocumentAsync(string, Stream)

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

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

Remarks

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

PostToSelfRelationForDocumentAsync(CancellationToken, string, Stream)

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

public Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(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<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”.

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.

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

Remarks

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

PutToClippedDocumentsRelationForDocumentAsync(CancellationToken, IntegerList)

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

public Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(CancellationToken cancellationToken, IntegerList dataToSend)

Parameters

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

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

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.

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

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

Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(CancellationToken, DocumentIndexFields)

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

public Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(CancellationToken cancellationToken, DocumentIndexFields dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<DocumentIndexFields>>	A task which runs the request.

Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(CancellationToken, UpdateIndexFieldsInfo)

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

public Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(CancellationToken cancellationToken, UpdateIndexFieldsInfo dataToSend)

Parameters

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

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.