Class Document

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public class Document : IChunkable, IStringContent, IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Document

Implements

IChunkable

IStringContent

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

Document()

Creates a new instance of this class

public Document()

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.

AnnotationRelationLink

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

public string AnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

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

AppPropertiesRelationLink

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

public string AppPropertiesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ApplicationProperties

Defines application specific properties. Different applications store specific application here

public List<DocumentApplicationProperty> ApplicationProperties { get; set; }

Property Value

Type	Description
List<DocumentApplicationProperty>

AuditInformationRelationLink

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

public string AuditInformationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

CheckInFromFileSystemRelationLink

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

public string CheckInFromFileSystemRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

CheckoutDocumentRelationLink

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

public string CheckoutDocumentRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

CheckoutToFileSystemRelationLink

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

public string CheckoutToFileSystemRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ChecksumInfo

Contains the information about the checksum

public ChecksumInfo ChecksumInfo { get; set; }

Property Value

Type	Description
ChecksumInfo

ChecksumStatusRelationLink

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

public string ChecksumStatusRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

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.

ContentDivideOperationRelationLink

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

public string ContentDivideOperationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ContentRelationLink

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

public string ContentRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ContentType

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

public string ContentType { get; set; }

Property Value

Type	Description
string

CreatedAt

Contains creation date of the document

public DateTime CreatedAt { get; set; }

Property Value

Type	Description
DateTime

CreatedAtSpecified

public bool CreatedAtSpecified { get; set; }

Property Value

Type	Description
bool

DeepZoomImageRelationLink

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

public string DeepZoomImageRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

DeepZoomImageWithAnnotationRelationLink

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

public string DeepZoomImageWithAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

DocumentLinksRelationLink

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

public string DocumentLinksRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

DownloadAsArchiveRelationLink

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

public string DownloadAsArchiveRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ExternalContentLocation

Defines the location of the document if it is stored outside of the system

[Moose]
public string ExternalContentLocation { get; set; }

Property Value

Type	Description
string

Fields

Fields of a document

public List<DocumentIndexField> Fields { get; set; }

Property Value

Type	Description
List<DocumentIndexField>

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.

FileCabinetId

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

public string FileCabinetId { get; set; }

Property Value

Type	Description
string

FileChunk

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

public UploadedFileChunk FileChunk { get; set; }

Property Value

Type	Description
UploadedFileChunk

FileDownloadRelationLink

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

public string FileDownloadRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

FileSize

The sum of the size of all section files and document header.

public long FileSize { get; set; }

Property Value

Type	Description
long

Flags

Flags of a document

public DocumentFlags Flags { get; set; }

Property Value

Type	Description
DocumentFlags

HasTextAnnotation

Contains true if document has a text annotation (the first section of the document has text annotation)

public bool HasTextAnnotation { get; set; }

Property Value

Type	Description
bool

HasXmlDigitalSignatures

Contains true if document contains at least one XML Digital signature

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

Property Value

Type	Description
bool

HaveMoreTotalPages

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

public bool HaveMoreTotalPages { get; set; }

Property Value

Type	Description
bool

Id

Document identity

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.

IntellixTrust

Intellix status

public IntellixTrust IntellixTrust { get; set; }

Property Value

Type	Description
IntellixTrust

this[string]

Gets or sets the DocumentIndexField with the specified field name.

public DocumentIndexField this[string fieldName] { get; set; }

Parameters

Type	Name	Description
string	fieldName	Name of the field.

Property Value

Type	Description
DocumentIndexField	The DocumentIndexField.

Exceptions

Type	Condition
ArgumentException	The field with the name ' + fieldName + ' is not part of the fields.

LastModified

Contains last modification date of the document

public DateTime LastModified { get; set; }

Property Value

Type	Description
DateTime

LastModifiedSpecified

public bool LastModifiedSpecified { get; set; }

Property Value

Type	Description
bool

LatestVersionRelationLink

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

public string LatestVersionRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

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.

MediaType

public string MediaType { get; }

Property Value

Type	Description
string

OrganizationGuid

The guid of the organization

public string OrganizationGuid { get; set; }

Property Value

Type	Description
string

PositionsRelationLink

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

public string PositionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Preview

public XElementWrapper Preview { get; set; }

Property Value

Type	Description
XElementWrapper

ProcessDocumentActionRelationLink

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

public string ProcessDocumentActionRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ReorderSectionsRelationLink

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

public string ReorderSectionsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

ResultListIconRelationLink

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

public string ResultListIconRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

SectionCount

The number of sections of this document. This number is equal to the sequence length of the Sections element.

public int SectionCount { get; set; }

Property Value

Type	Description
int

Sections

Sections of the document. Contain no sections if document is DBRecord

public List<Section> Sections { get; set; }

Property Value

Type	Description
List<Section>

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.

TextAnnotationRelationLink

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

public string TextAnnotationRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

TextShot

Obsolete. Use TextShots property. Content textshot (OCR) of the document

[Dolphin]
public List<DocumentContent> TextShot { get; set; }

Property Value

Type	Description
List<DocumentContent>

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.

Title

The title of the document, if it exists.

public string Title { get; set; }

Property Value

Type	Description
string

TotalPages

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

public int TotalPages { get; set; }

Property Value

Type	Description
int

UnclipRelationLink

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

public string UnclipRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Version

Version of a document

public DocumentVersion Version { get; set; }

Property Value

Type	Description
DocumentVersion

VersionHistoryRelationLink

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

public string VersionHistoryRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

VersionStatus

Version management status of the document

public VersionManagementStatus VersionStatus { get; set; }

Property Value

Type	Description
VersionManagementStatus

WorkflowHistoryRelationLink

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

public string WorkflowHistoryRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

XmlDSigContentRelationLink

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

public string XmlDSigContentRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

GetDocumentAnnotationsFromAnnotationRelation()

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

public DocumentAnnotations GetDocumentAnnotationsFromAnnotationRelation()

Returns

Type	Description
DocumentAnnotations	The content of the response.

GetDocumentAnnotationsFromAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentAnnotations>> GetDocumentAnnotationsFromAnnotationRelationAsync()

Returns

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

Remarks

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

GetDocumentAnnotationsFromAnnotationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentAnnotations>> GetDocumentAnnotationsFromAnnotationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentApplicationPropertiesFromAppPropertiesRelation()

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

public DocumentApplicationProperties GetDocumentApplicationPropertiesFromAppPropertiesRelation()

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

Returns

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

Remarks

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

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

GetDocumentAuditInformationFromAuditInformationRelation()

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

public DocumentAuditInformation GetDocumentAuditInformationFromAuditInformationRelation()

Returns

Type	Description
DocumentAuditInformation	The content of the response.

GetDocumentAuditInformationFromAuditInformationRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromAuditInformationRelationAsync()

Returns

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

Remarks

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

GetDocumentAuditInformationFromAuditInformationRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromAuditInformationRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentFromLatestVersionRelation()

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

public Document GetDocumentFromLatestVersionRelation()

Returns

Type	Description
Document	The content of the response.

GetDocumentFromLatestVersionRelationAsync()

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

public Task<DeserializedHttpResponse<Document>> GetDocumentFromLatestVersionRelationAsync()

Returns

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

Remarks

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

GetDocumentFromLatestVersionRelationAsync(CancellationToken)

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

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

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

GetDocumentLinksFromDocumentLinksRelation()

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

public DocumentLinks GetDocumentLinksFromDocumentLinksRelation()

Returns

Type	Description
DocumentLinks	The content of the response.

GetDocumentLinksFromDocumentLinksRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentLinks>> GetDocumentLinksFromDocumentLinksRelationAsync()

Returns

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

Remarks

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

GetDocumentLinksFromDocumentLinksRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentLinks>> GetDocumentLinksFromDocumentLinksRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentWordSearchResultFromPositionsRelation()

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

public DocumentWordSearchResult GetDocumentWordSearchResultFromPositionsRelation()

Returns

Type	Description
DocumentWordSearchResult	The content of the response.

GetDocumentWordSearchResultFromPositionsRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentWordSearchResult>> GetDocumentWordSearchResultFromPositionsRelationAsync()

Returns

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

Remarks

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

GetDocumentWordSearchResultFromPositionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentWordSearchResult>> GetDocumentWordSearchResultFromPositionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentsQueryResultFromVersionHistoryRelation()

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

public DocumentsQueryResult GetDocumentsQueryResultFromVersionHistoryRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromVersionHistoryRelationAsync()

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromVersionHistoryRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromVersionHistoryRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromVersionHistoryRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

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

GetStreamFromContentRelation()

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

public Stream GetStreamFromContentRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromContentRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromContentRelationAsync()

Returns

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

Remarks

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

GetStreamFromContentRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

GetStreamFromDeepZoomImageRelation()

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

public Stream GetStreamFromDeepZoomImageRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromDeepZoomImageRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageRelationAsync()

Returns

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

Remarks

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

GetStreamFromDeepZoomImageRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelation()

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

public Stream GetStreamFromDeepZoomImageWithAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

GetStreamFromFileDownloadRelation()

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

public Stream GetStreamFromFileDownloadRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromFileDownloadRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromFileDownloadRelationAsync()

Returns

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

Remarks

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

GetStreamFromFileDownloadRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

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

GetStreamFromResultListIconRelation()

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

public Stream GetStreamFromResultListIconRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromResultListIconRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromResultListIconRelationAsync()

Returns

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

Remarks

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

GetStreamFromResultListIconRelationAsync(CancellationToken)

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

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

GetStreamFromTextAnnotationRelation()

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

public Stream GetStreamFromTextAnnotationRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromTextAnnotationRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromTextAnnotationRelationAsync()

Returns

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

Remarks

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

GetStreamFromTextAnnotationRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

GetStreamFromThumbnailRelation()

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

public Stream GetStreamFromThumbnailRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromThumbnailRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromThumbnailRelationAsync()

Returns

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

Remarks

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

GetStreamFromThumbnailRelationAsync(CancellationToken)

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

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

Parameters

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

Returns

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

Remarks

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

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

GetStringFromChecksumStatusRelation()

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

public string GetStringFromChecksumStatusRelation()

Returns

Type	Description
string	The content of the response.

GetStringFromChecksumStatusRelationAsync()

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

public Task<DeserializedHttpResponse<string>> GetStringFromChecksumStatusRelationAsync()

Returns

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

Remarks

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

GetStringFromChecksumStatusRelationAsync(CancellationToken)

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

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

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

GetWorkflowDocumentHistoryFromWorkflowHistoryRelation()

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

public WorkflowDocumentHistory GetWorkflowDocumentHistoryFromWorkflowHistoryRelation()

Returns

Type	Description
WorkflowDocumentHistory	The content of the response.

GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync()

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

public Task<DeserializedHttpResponse<WorkflowDocumentHistory>> GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync()

Returns

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

Remarks

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

GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowDocumentHistory>> GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetXmlDSigContentTypeFromXmlDSigContentRelation()

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

public XmlDSigContentType GetXmlDSigContentTypeFromXmlDSigContentRelation()

Returns

Type	Description
XmlDSigContentType	The content of the response.

GetXmlDSigContentTypeFromXmlDSigContentRelationAsync()

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

public Task<DeserializedHttpResponse<XmlDSigContentType>> GetXmlDSigContentTypeFromXmlDSigContentRelationAsync()

Returns

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

Remarks

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

GetXmlDSigContentTypeFromXmlDSigContentRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<XmlDSigContentType>> GetXmlDSigContentTypeFromXmlDSigContentRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForDocumentAnnotations(DocumentAnnotationsPlacement)

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

public DocumentAnnotations PostToAnnotationRelationForDocumentAnnotations(DocumentAnnotationsPlacement dataToSend)

Parameters

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

Returns

Type	Description
DocumentAnnotations	The content of the response.

PostToAnnotationRelationForDocumentAnnotationsAsync(DocumentAnnotationsPlacement)

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

public Task<DeserializedHttpResponse<DocumentAnnotations>> PostToAnnotationRelationForDocumentAnnotationsAsync(DocumentAnnotationsPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForDocumentAnnotationsAsync(CancellationToken, DocumentAnnotationsPlacement)

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

public Task<DeserializedHttpResponse<DocumentAnnotations>> PostToAnnotationRelationForDocumentAnnotationsAsync(CancellationToken cancellationToken, DocumentAnnotationsPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAppPropertiesRelationForDocumentApplicationProperties(DocumentApplicationProperties)

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

public DocumentApplicationProperties PostToAppPropertiesRelationForDocumentApplicationProperties(DocumentApplicationProperties dataToSend)

Parameters

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

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(DocumentApplicationProperties)

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

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

Parameters

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

Returns

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

Remarks

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

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(CancellationToken, DocumentApplicationProperties)

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

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

Parameters

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

Returns

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

Remarks

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

PostToAuditInformationRelationForDocumentAuditInformation(DocumentAuditQuery)

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

public DocumentAuditInformation PostToAuditInformationRelationForDocumentAuditInformation(DocumentAuditQuery dataToSend)

Parameters

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

Returns

Type	Description
DocumentAuditInformation	The content of the response.

PostToAuditInformationRelationForDocumentAuditInformationAsync(DocumentAuditQuery)

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

public Task<DeserializedHttpResponse<DocumentAuditInformation>> PostToAuditInformationRelationForDocumentAuditInformationAsync(DocumentAuditQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAuditInformationRelationForDocumentAuditInformationAsync(CancellationToken, DocumentAuditQuery)

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

public Task<DeserializedHttpResponse<DocumentAuditInformation>> PostToAuditInformationRelationForDocumentAuditInformationAsync(CancellationToken cancellationToken, DocumentAuditQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCheckInFromFileSystemRelationForDocument(Stream)

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

public Document PostToCheckInFromFileSystemRelationForDocument(Stream dataToSend)

Parameters

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

Returns

Type	Description
Document	The content of the response.

PostToCheckInFromFileSystemRelationForDocumentAsync(Stream)

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

public Task<DeserializedHttpResponse<Document>> PostToCheckInFromFileSystemRelationForDocumentAsync(Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCheckInFromFileSystemRelationForDocumentAsync(CancellationToken, Stream)

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

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

Parameters

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

Returns

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

Remarks

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

PostToCheckoutDocumentRelationForStream(CheckOutToFileSystemInfo)

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

public Stream PostToCheckoutDocumentRelationForStream(CheckOutToFileSystemInfo dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToCheckoutDocumentRelationForStreamAsync(CheckOutToFileSystemInfo)

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

public Task<DeserializedHttpResponse<Stream>> PostToCheckoutDocumentRelationForStreamAsync(CheckOutToFileSystemInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCheckoutDocumentRelationForStreamAsync(CancellationToken, CheckOutToFileSystemInfo)

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

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

Parameters

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

Returns

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

Remarks

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

PostToCheckoutToFileSystemRelationForStream(CheckOutToFileSystemInfo)

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

public Stream PostToCheckoutToFileSystemRelationForStream(CheckOutToFileSystemInfo dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToCheckoutToFileSystemRelationForStreamAsync(CheckOutToFileSystemInfo)

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

public Task<DeserializedHttpResponse<Stream>> PostToCheckoutToFileSystemRelationForStreamAsync(CheckOutToFileSystemInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCheckoutToFileSystemRelationForStreamAsync(CancellationToken, CheckOutToFileSystemInfo)

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

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

Parameters

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

Returns

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

Remarks

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

PostToContentRelationForStream(IntegerList)

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

public Stream PostToContentRelationForStream(IntegerList dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToContentRelationForStreamAsync(IntegerList)

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

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

Remarks

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

PostToContentRelationForStreamAsync(CancellationToken, IntegerList)

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

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

Remarks

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

PostToDownloadAsArchiveRelationForStream(ExportSettings)

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

public Stream PostToDownloadAsArchiveRelationForStream(ExportSettings dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToDownloadAsArchiveRelationForStreamAsync(ExportSettings)

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

public Task<DeserializedHttpResponse<Stream>> PostToDownloadAsArchiveRelationForStreamAsync(ExportSettings dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToDownloadAsArchiveRelationForStreamAsync(CancellationToken, ExportSettings)

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

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

Parameters

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

Returns

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

Remarks

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

PostToFileDownloadRelationForStream(FileDownload)

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

public Stream PostToFileDownloadRelationForStream(FileDownload dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToFileDownloadRelationForStreamAsync(FileDownload)

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

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

Parameters

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

Returns

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

Remarks

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

PostToFileDownloadRelationForStreamAsync(CancellationToken, FileDownload)

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

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

Parameters

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

Returns

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

Remarks

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

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

PostToPositionsRelationForDocumentWordSearchResult(SearchPositionQuery)

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

public DocumentWordSearchResult PostToPositionsRelationForDocumentWordSearchResult(SearchPositionQuery dataToSend)

Parameters

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

Returns

Type	Description
DocumentWordSearchResult	The content of the response.

PostToPositionsRelationForDocumentWordSearchResultAsync(SearchPositionQuery)

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

public Task<DeserializedHttpResponse<DocumentWordSearchResult>> PostToPositionsRelationForDocumentWordSearchResultAsync(SearchPositionQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToPositionsRelationForDocumentWordSearchResultAsync(CancellationToken, SearchPositionQuery)

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

public Task<DeserializedHttpResponse<DocumentWordSearchResult>> PostToPositionsRelationForDocumentWordSearchResultAsync(CancellationToken cancellationToken, SearchPositionQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

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

PostToTextAnnotationRelationForStream(Stream)

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

public Stream PostToTextAnnotationRelationForStream(Stream dataToSend)

Parameters

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

Returns

Type	Description
Stream	The content of the response.

PostToTextAnnotationRelationForStreamAsync(Stream)

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

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

Parameters

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

Returns

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

Remarks

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

PostToTextAnnotationRelationForStreamAsync(CancellationToken, Stream)

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

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

Parameters

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

Returns

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

Remarks

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

PostToVersionHistoryRelationForDocumentsQueryResult(ResultListQuery)

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

public DocumentsQueryResult PostToVersionHistoryRelationForDocumentsQueryResult(ResultListQuery dataToSend)

Parameters

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

Returns

Type	Description
DocumentsQueryResult	The content of the response.

PostToVersionHistoryRelationForDocumentsQueryResultAsync(ResultListQuery)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToVersionHistoryRelationForDocumentsQueryResultAsync(ResultListQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToVersionHistoryRelationForDocumentsQueryResultAsync(CancellationToken, ResultListQuery)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToVersionHistoryRelationForDocumentsQueryResultAsync(CancellationToken cancellationToken, ResultListQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

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

PutToContentDivideOperationRelationForDocumentsQueryResult(ContentDivideOperationInfo)

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

public DocumentsQueryResult PutToContentDivideOperationRelationForDocumentsQueryResult(ContentDivideOperationInfo dataToSend)

Parameters

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

Returns

Type	Description
DocumentsQueryResult	The content of the response.

PutToContentDivideOperationRelationForDocumentsQueryResultAsync(ContentDivideOperationInfo)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideOperationRelationForDocumentsQueryResultAsync(ContentDivideOperationInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToContentDivideOperationRelationForDocumentsQueryResultAsync(CancellationToken, ContentDivideOperationInfo)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideOperationRelationForDocumentsQueryResultAsync(CancellationToken cancellationToken, ContentDivideOperationInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

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

PutToProcessDocumentActionRelationForDocument(DocumentActionInfo)

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

public Document PutToProcessDocumentActionRelationForDocument(DocumentActionInfo dataToSend)

Parameters

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

Returns

Type	Description
Document	The content of the response.

PutToProcessDocumentActionRelationForDocumentAsync(DocumentActionInfo)

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

public Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionRelationForDocumentAsync(DocumentActionInfo dataToSend)

Parameters

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

PutToProcessDocumentActionRelationForDocumentAsync(CancellationToken, DocumentActionInfo)

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

public Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionRelationForDocumentAsync(CancellationToken cancellationToken, DocumentActionInfo dataToSend)

Parameters

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

PutToReorderSectionsRelationForSections(ReorderSectionsRequest)

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

public Sections PutToReorderSectionsRelationForSections(ReorderSectionsRequest dataToSend)

Parameters

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

Returns

Type	Description
Sections	The content of the response.

PutToReorderSectionsRelationForSectionsAsync(ReorderSectionsRequest)

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

public Task<DeserializedHttpResponse<Sections>> PutToReorderSectionsRelationForSectionsAsync(ReorderSectionsRequest dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToReorderSectionsRelationForSectionsAsync(CancellationToken, ReorderSectionsRequest)

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

public Task<DeserializedHttpResponse<Sections>> PutToReorderSectionsRelationForSectionsAsync(CancellationToken cancellationToken, ReorderSectionsRequest dataToSend)

Parameters

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

Returns

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

Remarks

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

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.

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

Type	Description
string	A String that represents this instance.

Overrides

Object.ToString()