Class Document

Inheritance

System.Object

Document

Implements

IChunkable

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Document : IRelationsWithProxy, IChunkable, IStringContent

Constructors

Document()

Creates a new instance of this class

Declaration

public Document()

Properties

AnnotationAsSvgRelationLink

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

Declaration

public string AnnotationAsSvgRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “annotationAsSvg” if it exists, or 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”.

Declaration

public string AnnotationRelationLink { get; }

Property Value

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

Declaration

public bool AnnotationsPreview { get; set; }

Property Value

Type	Description
System.Boolean

ApplicationProperties

Define application specific properties. Different applications store specific application here

Declaration

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

Property Value

Type	Description
List<DocumentApplicationProperty>

AppPropertiesRelationLink

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

Declaration

public string AppPropertiesRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “appProperties” if it exists, or 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.

AuditInformationRelationLink

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

Declaration

public string AuditInformationRelationLink { get; }

Property Value

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

Declaration

public string CheckInFromFileSystemRelationLink { get; }

Property Value

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

Declaration

public string CheckoutDocumentRelationLink { get; }

Property Value

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

Declaration

public string CheckoutToFileSystemRelationLink { get; }

Property Value

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

ChecksumStatusRelationLink

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

Declaration

public string ChecksumStatusRelationLink { get; }

Property Value

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

Declaration

public string ClippedDocumentsRelationLink { get; }

Property Value

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

Declaration

public string ContentDivideOperationRelationLink { get; }

Property Value

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

Declaration

public string ContentRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “content” if it exists, or 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.

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
System.String

CreatedAt

Contains creation date of the document

Declaration

public System.DateTime CreatedAt { get; set; }

Property Value

Type	Description
System.DateTime

CreatedAtSpecified

Declaration

public bool CreatedAtSpecified { get; set; }

Property Value

Type	Description
System.Boolean

DeepZoomImageRelationLink

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

Declaration

public string DeepZoomImageRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “deepZoomImage” if it exists, or 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”.

Declaration

public string DeepZoomImageWithAnnotationRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “deepZoomImageWithAnnotation” if it exists, or 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”.

Declaration

public string DocumentLinksRelationLink { get; }

Property Value

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

Declaration

public string DownloadAsArchiveRelationLink { get; }

Property Value

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

Fields

Fields of a document

Declaration

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

Property Value

Type	Description
List<DocumentIndexField>

FieldsRelationLink

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

Declaration

public string FieldsRelationLink { get; }

Property Value

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

FileChunk

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

Declaration

public UploadedFileChunk FileChunk { get; set; }

Property Value

Type	Description
UploadedFileChunk

FileDownloadRelationLink

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

Declaration

public string FileDownloadRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “fileDownload” if it exists, or 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.

Declaration

public long FileSize { get; set; }

Property Value

Type	Description
System.Int64

Flags

Flags of a document

Declaration

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)

Declaration

public bool HasTextAnnotation { get; set; }

Property Value

Type	Description
System.Boolean

HasXmlDigitalSignatures

Contains true if document contains at least one XML Digital signature

Declaration

public bool HasXmlDigitalSignatures { get; set; }

Property Value

Type	Description
System.Boolean

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

Declaration

public bool HaveMoreTotalPages { get; set; }

Property Value

Type	Description
System.Boolean

Id

Document identity

Declaration

public int Id { get; set; }

Property Value

Type	Description
System.Int32

IntellixRelationLink

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

Declaration

public string IntellixRelationLink { get; }

Property Value

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

Declaration

public IntellixTrust IntellixTrust { get; set; }

Property Value

Type	Description
IntellixTrust

Item[String]

Gets or sets the DocumentIndexField with the specified field name.

Declaration

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

Parameters

Type	Name	Description
System.String	fieldName	Name of the field.

Property Value

Type	Description
DocumentIndexField	The DocumentIndexField.

LastModified

Contains last modification date of the document

Declaration

public System.DateTime LastModified { get; set; }

Property Value

Type	Description
System.DateTime

LastModifiedSpecified

Declaration

public bool LastModifiedSpecified { get; set; }

Property Value

Type	Description
System.Boolean

LatestVersionRelationLink

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

Declaration

public string LatestVersionRelationLink { get; }

Property Value

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

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LockRelationLink

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

Declaration

public string LockRelationLink { get; }

Property Value

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

Declaration

public string LowQualityImageRelationLink { get; }

Property Value

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

PositionsRelationLink

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

Declaration

public string PositionsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “positions” if it exists, or 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

Declaration

public XElementWrapper Preview { get; set; }

Property Value

Type	Description
XElementWrapper

ProcessDocumentActionRelationLink

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

Declaration

public string ProcessDocumentActionRelationLink { get; }

Property Value

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

ResultListIconRelationLink

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

Declaration

public string ResultListIconRelationLink { get; }

Property Value

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

Declaration

public string RightsRelationLink { get; }

Property Value

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

Declaration

public int SectionCount { get; set; }

Property Value

Type	Description
System.Int32

Sections

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

Declaration

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

Property Value

Type	Description
List<Section>

SectionsRelationLink

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

Declaration

public string SectionsRelationLink { get; }

Property Value

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

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Suggestions

Suggestions for the simple fields of a document

Declaration

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

Property Value

Type	Description
List<SuggestionField>

SuggestionsRelationLink

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

Declaration

public string SuggestionsRelationLink { get; }

Property Value

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

TableFieldsSuggestionsRelationLink

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

Declaration

public string TableFieldsSuggestionsRelationLink { get; }

Property Value

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

TableFieldSuggestions

Suggestions for the table fields of a document

Declaration

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

Property Value

Type	Description
List<SuggestionTableField>

TextAnnotationRelationLink

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

Declaration

public string TextAnnotationRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “textAnnotation” if it exists, or 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

Declaration

public List<DocumentContent> TextShot { get; set; }

Property Value

Type	Description
List<DocumentContent>

ThumbnailRelationLink

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

Declaration

public string ThumbnailRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “thumbnail” if it exists, or 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”.

Declaration

public string ThumbnailWithoutAnnotationRelationLink { get; }

Property Value

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

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

TotalPages

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

Declaration

public int TotalPages { get; set; }

Property Value

Type	Description
System.Int32

UnclipRelationLink

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

Declaration

public string UnclipRelationLink { get; }

Property Value

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

Declaration

public DocumentVersion Version { get; set; }

Property Value

Type	Description
DocumentVersion

VersionHistoryRelationLink

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

Declaration

public string VersionHistoryRelationLink { get; }

Property Value

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

Declaration

public VersionManagementStatus VersionStatus { get; set; }

Property Value

Type	Description
VersionManagementStatus

WorkflowHistoryRelationLink

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

Declaration

public string WorkflowHistoryRelationLink { get; }

Property Value

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

Declaration

public string XmlDSigContentRelationLink { get; }

Property Value

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

Declaration

public string DeleteLockRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteLockRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

DeleteLockRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

DeleteSelfRelation()

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

Declaration

public string DeleteSelfRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

DeleteSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

GetDocumentAnnotationsFromAnnotationRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAnnotations>> GetDocumentAnnotationsFromAnnotationRelationAsync()

Returns

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

Remarks

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

GetDocumentAnnotationsFromAnnotationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAnnotations>> GetDocumentAnnotationsFromAnnotationRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<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”.

Declaration

public DocumentApplicationProperties GetDocumentApplicationPropertiesFromAppPropertiesRelation()

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync()

Returns

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

Remarks

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

GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentAuditInformationFromAuditInformationRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromAuditInformationRelationAsync()

Returns

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

Remarks

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

GetDocumentAuditInformationFromAuditInformationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromAuditInformationRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<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”.

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromLatestVersionRelationAsync()

Returns

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

Remarks

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

GetDocumentFromLatestVersionRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromLatestVersionRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentFromSelfRelation()

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

Declaration

public Document GetDocumentFromSelfRelation()

Returns

Type	Description
Document	The content of the response.

GetDocumentFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync()

Returns

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

Remarks

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

GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentIndexFieldsFromFieldsRelation()

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

Declaration

public DocumentIndexFields GetDocumentIndexFieldsFromFieldsRelation()

Returns

Type	Description
DocumentIndexFields	The content of the response.

GetDocumentIndexFieldsFromFieldsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync()

Returns

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

Remarks

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

GetDocumentIndexFieldsFromFieldsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentLinksFromDocumentLinksRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentLinks>> GetDocumentLinksFromDocumentLinksRelationAsync()

Returns

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

Remarks

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

GetDocumentLinksFromDocumentLinksRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentLinks>> GetDocumentLinksFromDocumentLinksRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentsQueryResultFromVersionHistoryRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromVersionHistoryRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromVersionHistoryRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromVersionHistoryRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetDocumentWordSearchResultFromPositionsRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWordSearchResult>> GetDocumentWordSearchResultFromPositionsRelationAsync()

Returns

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

Remarks

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

GetDocumentWordSearchResultFromPositionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWordSearchResult>> GetDocumentWordSearchResultFromPositionsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetSectionsFromSectionsRelation()

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

Declaration

public Sections GetSectionsFromSectionsRelation()

Returns

Type	Description
Sections	The content of the response.

GetSectionsFromSectionsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync()

Returns

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

Remarks

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

GetSectionsFromSectionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetStreamFromAnnotationAsSvgRelation()

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

Declaration

public System.IO.Stream GetStreamFromAnnotationAsSvgRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromAnnotationAsSvgRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromAnnotationAsSvgRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromChecksumStatusRelation()

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

Declaration

public System.IO.Stream GetStreamFromChecksumStatusRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromChecksumStatusRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromChecksumStatusRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromChecksumStatusRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromChecksumStatusRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromContentRelation()

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

Declaration

public System.IO.Stream GetStreamFromContentRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromContentRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromContentRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromDeepZoomImageRelation()

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

Declaration

public System.IO.Stream GetStreamFromDeepZoomImageRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromDeepZoomImageRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromDeepZoomImageRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelation()

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

Declaration

public System.IO.Stream GetStreamFromDeepZoomImageWithAnnotationRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromDeepZoomImageWithAnnotationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromFileDownloadRelation()

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

Declaration

public System.IO.Stream GetStreamFromFileDownloadRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromFileDownloadRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromFileDownloadRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromFileDownloadRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromFileDownloadRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromLowQualityImageRelation()

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

Declaration

public System.IO.Stream GetStreamFromLowQualityImageRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromLowQualityImageRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromLowQualityImageRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromResultListIconRelation()

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

Declaration

public System.IO.Stream GetStreamFromResultListIconRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromResultListIconRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromResultListIconRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromResultListIconRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromResultListIconRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromTextAnnotationRelation()

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

Declaration

public System.IO.Stream GetStreamFromTextAnnotationRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromTextAnnotationRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTextAnnotationRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromTextAnnotationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromTextAnnotationRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromThumbnailRelation()

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

Declaration

public System.IO.Stream GetStreamFromThumbnailRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromThumbnailRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromThumbnailRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromThumbnailWithoutAnnotationRelation()

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

Declaration

public System.IO.Stream GetStreamFromThumbnailWithoutAnnotationRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromThumbnailWithoutAnnotationRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailWithoutAnnotationRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromThumbnailWithoutAnnotationRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailWithoutAnnotationRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromXmlDSigContentRelation()

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

Declaration

public System.IO.Stream GetStreamFromXmlDSigContentRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromXmlDSigContentRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromXmlDSigContentRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromXmlDSigContentRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromXmlDSigContentRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetSuggestionFieldsFromSuggestionsRelation()

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

Declaration

public SuggestionFields GetSuggestionFieldsFromSuggestionsRelation()

Returns

Type	Description
SuggestionFields	The content of the response.

GetSuggestionFieldsFromSuggestionsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync()

Returns

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

Remarks

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

GetSuggestionFieldsFromSuggestionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelation()

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

Declaration

public SuggestionTableFields GetSuggestionTableFieldsFromTableFieldsSuggestionsRelation()

Returns

Type	Description
SuggestionTableFields	The content of the response.

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync()

Returns

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

Remarks

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

GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetWorkflowDocumentHistoryFromWorkflowHistoryRelation()

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

Declaration

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.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowDocumentHistory>> GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync()

Returns

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

Remarks

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

GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowDocumentHistory>> GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToAnnotationRelationForDocumentAnnotations(DocumentAnnotationsPlacement)

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

Declaration

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.

Declaration

public System.Threading.Tasks.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
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAnnotations>>	A task which runs the request.

Remarks

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

PostToAnnotationRelationForDocumentAnnotationsAsync(System.Threading.CancellationToken, DocumentAnnotationsPlacement)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAnnotations>> PostToAnnotationRelationForDocumentAnnotationsAsync(System.Threading.CancellationToken cancellationToken, DocumentAnnotationsPlacement dataToSend)

Parameters

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

Declaration

public DocumentApplicationProperties PostToAppPropertiesRelationForDocumentApplicationProperties(DocumentApplicationProperties dataToSend)

Parameters

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

Returns

Type	Description
DocumentApplicationProperties	The content of the response.

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(DocumentApplicationProperties)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(DocumentApplicationProperties dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(System.Threading.CancellationToken, DocumentApplicationProperties)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(System.Threading.CancellationToken cancellationToken, DocumentApplicationProperties dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToAuditInformationRelationForDocumentAuditInformation(DocumentAuditQuery)

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

Declaration

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.

Declaration

public System.Threading.Tasks.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
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

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

PostToAuditInformationRelationForDocumentAuditInformationAsync(System.Threading.CancellationToken, DocumentAuditQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> PostToAuditInformationRelationForDocumentAuditInformationAsync(System.Threading.CancellationToken cancellationToken, DocumentAuditQuery dataToSend)

Parameters

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

Remarks

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

PostToCheckInFromFileSystemRelationForDocument(System.IO.Stream)

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

Declaration

public Document PostToCheckInFromFileSystemRelationForDocument(System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
Document	The content of the response.

PostToCheckInFromFileSystemRelationForDocumentAsync(System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToCheckInFromFileSystemRelationForDocumentAsync(System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCheckInFromFileSystemRelationForDocumentAsync(System.Threading.CancellationToken, System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToCheckInFromFileSystemRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<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”.

Declaration

public System.IO.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
System.IO.Stream	The content of the response.

PostToCheckoutDocumentRelationForStreamAsync(CheckOutToFileSystemInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToCheckoutDocumentRelationForStreamAsync(System.Threading.CancellationToken, CheckOutToFileSystemInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToCheckoutDocumentRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, CheckOutToFileSystemInfo dataToSend)

Parameters

Type	Name	Description
System.Threading.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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”.

Declaration

public System.IO.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
System.IO.Stream	The content of the response.

PostToCheckoutToFileSystemRelationForStreamAsync(CheckOutToFileSystemInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToCheckoutToFileSystemRelationForStreamAsync(System.Threading.CancellationToken, CheckOutToFileSystemInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToCheckoutToFileSystemRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, CheckOutToFileSystemInfo dataToSend)

Parameters

Type	Name	Description
System.Threading.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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”.

Declaration

public System.IO.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
System.IO.Stream	The content of the response.

PostToContentRelationForStreamAsync(IntegerList)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToContentRelationForStreamAsync(System.Threading.CancellationToken, IntegerList)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToContentRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, IntegerList dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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”.

Declaration

public System.IO.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
System.IO.Stream	The content of the response.

PostToDownloadAsArchiveRelationForStreamAsync(ExportSettings)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToDownloadAsArchiveRelationForStreamAsync(System.Threading.CancellationToken, ExportSettings)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToDownloadAsArchiveRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, ExportSettings dataToSend)

Parameters

Type	Name	Description
System.Threading.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
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.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”.

Declaration

public System.IO.Stream PostToFileDownloadRelationForStream(FileDownload dataToSend)

Parameters

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

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToFileDownloadRelationForStreamAsync(FileDownload)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToFileDownloadRelationForStreamAsync(FileDownload dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToFileDownloadRelationForStreamAsync(System.Threading.CancellationToken, FileDownload)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToFileDownloadRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, FileDownload dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToLockRelationForString(LockInfo)

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

Declaration

public string PostToLockRelationForString(LockInfo dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PostToLockRelationForStringAsync(LockInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(LockInfo dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

PostToLockRelationForStringAsync(System.Threading.CancellationToken, LockInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(System.Threading.CancellationToken cancellationToken, LockInfo dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>	A task which runs the request.

Remarks

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

PostToPositionsRelationForDocumentWordSearchResult(SearchPositionQuery)

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

Declaration

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.

Declaration

public System.Threading.Tasks.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
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWordSearchResult>>	A task which runs the request.

Remarks

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

PostToPositionsRelationForDocumentWordSearchResultAsync(System.Threading.CancellationToken, SearchPositionQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWordSearchResult>> PostToPositionsRelationForDocumentWordSearchResultAsync(System.Threading.CancellationToken cancellationToken, SearchPositionQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToRightsRelationForSection(String, System.IO.Stream)

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

Declaration

public Section PostToRightsRelationForSection(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
Section	The content of the response.

PostToRightsRelationForSectionAsync(String, System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

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

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSectionsRelationForSection(String, System.IO.Stream)

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

Declaration

public Section PostToSectionsRelationForSection(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
Section	The content of the response.

PostToSectionsRelationForSectionAsync(String, System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

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

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSelfRelationForDocument(String, System.IO.Stream)

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

Declaration

public Document PostToSelfRelationForDocument(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
Document	The content of the response.

PostToSelfRelationForDocumentAsync(String, System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

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

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToTextAnnotationRelationForStream(System.IO.Stream)

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

Declaration

public System.IO.Stream PostToTextAnnotationRelationForStream(System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToTextAnnotationRelationForStreamAsync(System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTextAnnotationRelationForStreamAsync(System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToTextAnnotationRelationForStreamAsync(System.Threading.CancellationToken, System.IO.Stream)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToTextAnnotationRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToVersionHistoryRelationForDocumentsQueryResult(ResultListQuery)

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

Declaration

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.

Declaration

public System.Threading.Tasks.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
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PostToVersionHistoryRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, ResultListQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToVersionHistoryRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken cancellationToken, ResultListQuery dataToSend)

Parameters

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

Declaration

public Document PutToClippedDocumentsRelationForDocument(IntegerList dataToSend)

Parameters

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

Returns

Type	Description
Document	The content of the response.

PutToClippedDocumentsRelationForDocumentAsync(IntegerList)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(IntegerList dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToClippedDocumentsRelationForDocumentAsync(System.Threading.CancellationToken, IntegerList)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, IntegerList dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToContentDivideOperationRelationForDocumentsQueryResult(ContentDivideOperationInfo)

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

Declaration

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.

Declaration

public System.Threading.Tasks.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
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PutToContentDivideOperationRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, ContentDivideOperationInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideOperationRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken cancellationToken, ContentDivideOperationInfo dataToSend)

Parameters

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

Declaration

public DocumentIndexFields PutToFieldsRelationForDocumentIndexFields(DocumentIndexFields dataToSend)

Parameters

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

Returns

Type	Description
DocumentIndexFields	The content of the response.

PutToFieldsRelationForDocumentIndexFields(UpdateIndexFieldsInfo)

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

Declaration

public DocumentIndexFields PutToFieldsRelationForDocumentIndexFields(UpdateIndexFieldsInfo dataToSend)

Parameters

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

Returns

Type	Description
DocumentIndexFields	The content of the response.

PutToFieldsRelationForDocumentIndexFieldsAsync(DocumentIndexFields)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(DocumentIndexFields dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(UpdateIndexFieldsInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(UpdateIndexFieldsInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken, DocumentIndexFields)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken cancellationToken, DocumentIndexFields dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken, UpdateIndexFieldsInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(System.Threading.CancellationToken cancellationToken, UpdateIndexFieldsInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToProcessDocumentActionRelationForDocument(DocumentActionInfo)

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

Declaration

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.

Declaration

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

Remarks

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

PutToProcessDocumentActionRelationForDocumentAsync(System.Threading.CancellationToken, DocumentActionInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, DocumentActionInfo dataToSend)

Parameters

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

Remarks

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

SetProxy(HttpClientProxy)

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

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

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

ToString()

Returns a that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A that represents this instance.

Implements

IChunkable