Class Document

Inheritance
System.Object
Document
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

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

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

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

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

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

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
[Lobster]
public bool AnnotationsPreview { get; set; }
Property Value
Type Description
System.Boolean

ApplicationProperties

Defines application specific properties. Different applications store specific application here

Declaration
public List<DocumentApplicationProperty> ApplicationProperties { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DocumentApplicationProperty>

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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

ChecksumInfo

Contains the information about the checksum

Declaration
public ChecksumInfo ChecksumInfo { get; set; }
Property Value
Type Description
ChecksumInfo

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

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

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.

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

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

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

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

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

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.

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

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

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 DateTime CreatedAt { get; set; }
Property Value
Type Description
System.DateTime

CreatedAtSpecified

Declaration
public bool CreatedAtSpecified { get; set; }
Property Value
Type Description
System.Boolean

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

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

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.

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

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

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.

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

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

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.

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

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

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

ExternalContentLocation

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

Declaration
[Moose]
public string ExternalContentLocation { get; set; }
Property Value
Type Description
System.String

Fields

Fields of a document

Declaration
public List<DocumentIndexField> Fields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DocumentIndexField>

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

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

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

FileCabinetId

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

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

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

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

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

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
[Eagle]
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

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

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

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

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.
Exceptions
Type Condition
System.ArgumentException

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

LastModified

Contains last modification date of the document

Declaration
public DateTime LastModified { get; set; }
Property Value
Type Description
System.DateTime

LastModifiedSpecified

Declaration
public bool LastModifiedSpecified { get; set; }
Property Value
Type Description
System.Boolean

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

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

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.

Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

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

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

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

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

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

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

MediaType

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

OrganizationGuid

The guid of the organization

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

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

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

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

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

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

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.

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

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

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.

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

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

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

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
System.Collections.Generic.List<Section>

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

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

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

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

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

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

Suggestions

Suggestions for the simple fields of a document

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

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

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

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

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

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

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

TableFieldSuggestions

Suggestions for the table fields of a document

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

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

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

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
[Dolphin]
public List<DocumentContent> TextShot { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DocumentContent>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<string>> DeleteLockRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentAnnotations>> GetDocumentAnnotationsFromAnnotationRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentApplicationProperties>> GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromAuditInformationRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Document>> GetDocumentFromLatestVersionRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentIndexFields>> GetDocumentIndexFieldsFromFieldsRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentLinks>> GetDocumentLinksFromDocumentLinksRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromVersionHistoryRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<DocumentWordSearchResult>> GetDocumentWordSearchResultFromPositionsRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Sections>> GetSectionsFromSectionsRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromAnnotationAsSvgRelationAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>

A task which runs the request.
Remarks

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

GetStreamFromContentRelation()

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

Declaration
public 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromContentRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromDeepZoomImageWithAnnotationRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromFileDownloadRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromLowQualityImageRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromResultListIconRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromTextAnnotationRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> GetStreamFromThumbnailRelationAsync(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 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 Task<DeserializedHttpResponse<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(CancellationToken)

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

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

GetStringFromChecksumStatusRelation()

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

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

The content of the response.

GetStringFromChecksumStatusRelationAsync()

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

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

GetStringFromChecksumStatusRelationAsync(CancellationToken)

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

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

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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<SuggestionFields>> GetSuggestionFieldsFromSuggestionsRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<SuggestionTableFields>> GetSuggestionTableFieldsFromTableFieldsSuggestionsRelationAsync(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 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(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<WorkflowDocumentHistory>> GetWorkflowDocumentHistoryFromWorkflowHistoryRelationAsync(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”.

GetXmlDSigContentTypeFromXmlDSigContentRelation()

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

Declaration
public XmlDSigContentType GetXmlDSigContentTypeFromXmlDSigContentRelation()
Returns
Type Description
XmlDSigContentType

The content of the response.

GetXmlDSigContentTypeFromXmlDSigContentRelationAsync()

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

Declaration
public Task<DeserializedHttpResponse<XmlDSigContentType>> GetXmlDSigContentTypeFromXmlDSigContentRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<XmlDSigContentType>>

A task which runs the request.
Remarks

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

GetXmlDSigContentTypeFromXmlDSigContentRelationAsync(CancellationToken)

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

Declaration
public Task<DeserializedHttpResponse<XmlDSigContentType>> GetXmlDSigContentTypeFromXmlDSigContentRelationAsync(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<XmlDSigContentType>>

A task which runs the request.
Remarks

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

PostToAnnotationRelationForDocumentAnnotations(DocumentAnnotationsPlacement)

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

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 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(CancellationToken, DocumentAnnotationsPlacement)

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

Declaration
public Task<DeserializedHttpResponse<DocumentAnnotations>> PostToAnnotationRelationForDocumentAnnotationsAsync(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 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(CancellationToken, DocumentApplicationProperties)

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

Declaration
public Task<DeserializedHttpResponse<DocumentApplicationProperties>> PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync(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 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(CancellationToken, DocumentAuditQuery)

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

Declaration
public Task<DeserializedHttpResponse<DocumentAuditInformation>> PostToAuditInformationRelationForDocumentAuditInformationAsync(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(Stream)

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

Declaration
public Document PostToCheckInFromFileSystemRelationForDocument(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PostToCheckInFromFileSystemRelationForDocumentAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PostToCheckInFromFileSystemRelationForDocumentAsync(CancellationToken cancellationToken, 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 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 Task<DeserializedHttpResponse<Stream>> PostToCheckoutDocumentRelationForStreamAsync(CheckOutToFileSystemInfo dataToSend)
Parameters
Type Name Description
CheckOutToFileSystemInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
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(CancellationToken, CheckOutToFileSystemInfo)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToCheckoutDocumentRelationForStreamAsync(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 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 Task<DeserializedHttpResponse<Stream>> PostToCheckoutToFileSystemRelationForStreamAsync(CheckOutToFileSystemInfo dataToSend)
Parameters
Type Name Description
CheckOutToFileSystemInfo dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
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(CancellationToken, CheckOutToFileSystemInfo)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToCheckoutToFileSystemRelationForStreamAsync(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 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 Task<DeserializedHttpResponse<Stream>> PostToContentRelationForStreamAsync(IntegerList dataToSend)
Parameters
Type Name Description
IntegerList dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
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(CancellationToken, IntegerList)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToContentRelationForStreamAsync(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 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 Task<DeserializedHttpResponse<Stream>> PostToDownloadAsArchiveRelationForStreamAsync(ExportSettings dataToSend)
Parameters
Type Name Description
ExportSettings dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
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(CancellationToken, ExportSettings)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToDownloadAsArchiveRelationForStreamAsync(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 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 Task<DeserializedHttpResponse<Stream>> PostToFileDownloadRelationForStreamAsync(FileDownload dataToSend)
Parameters
Type Name Description
FileDownload dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
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(CancellationToken, FileDownload)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToFileDownloadRelationForStreamAsync(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 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(CancellationToken, LockInfo)

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

Declaration
public Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(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 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(CancellationToken, SearchPositionQuery)

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

Declaration
public Task<DeserializedHttpResponse<DocumentWordSearchResult>> PostToPositionsRelationForDocumentWordSearchResultAsync(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”.

PostToRightsRelationForRights(Rights)

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

Declaration
public Rights PostToRightsRelationForRights(Rights dataToSend)
Parameters
Type Name Description
Rights dataToSend

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

The content of the response.

PostToRightsRelationForRightsAsync(Rights)

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

Declaration
public Task<DeserializedHttpResponse<Rights>> PostToRightsRelationForRightsAsync(Rights dataToSend)
Parameters
Type Name Description
Rights dataToSend

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

A task which runs the request.
Remarks

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

PostToRightsRelationForRightsAsync(CancellationToken, Rights)

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

Declaration
public Task<DeserializedHttpResponse<Rights>> PostToRightsRelationForRightsAsync(CancellationToken cancellationToken, Rights dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
Rights dataToSend

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

A task which runs the request.
Remarks

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

PostToSectionsRelationForSection(String, Stream)

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

Declaration
public Section PostToSectionsRelationForSection(string requestedContentType, 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, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(string requestedContentType, 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(CancellationToken, String, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Section>> PostToSectionsRelationForSectionAsync(CancellationToken cancellationToken, string requestedContentType, 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, Stream)

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

Declaration
public Document PostToSelfRelationForDocument(string requestedContentType, 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, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(string requestedContentType, 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(CancellationToken, String, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PostToSelfRelationForDocumentAsync(CancellationToken cancellationToken, string requestedContentType, 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(Stream)

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

Declaration
public Stream PostToTextAnnotationRelationForStream(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(Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTextAnnotationRelationForStreamAsync(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(CancellationToken, Stream)

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

Declaration
public Task<DeserializedHttpResponse<Stream>> PostToTextAnnotationRelationForStreamAsync(CancellationToken cancellationToken, 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 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(CancellationToken, ResultListQuery)

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

Declaration
public Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToVersionHistoryRelationForDocumentsQueryResultAsync(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 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(CancellationToken, IntegerList)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PutToClippedDocumentsRelationForDocumentAsync(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 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(CancellationToken, ContentDivideOperationInfo)

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

Declaration
public Task<DeserializedHttpResponse<DocumentsQueryResult>> PutToContentDivideOperationRelationForDocumentsQueryResultAsync(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 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 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(CancellationToken, DocumentIndexFields)

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

Declaration
public Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(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(CancellationToken, UpdateIndexFieldsInfo)

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

Declaration
public Task<DeserializedHttpResponse<DocumentIndexFields>> PutToFieldsRelationForDocumentIndexFieldsAsync(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 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(CancellationToken, DocumentActionInfo)

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

Declaration
public Task<DeserializedHttpResponse<Document>> PutToProcessDocumentActionRelationForDocumentAsync(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 System.Net.Http.HttpClient instance which is used in further HTTP communication.
Remarks

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

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents this instance.

Explicit Interface Implementations

IStringContent.GetStringContent()

Declaration
StringContent IStringContent.GetStringContent()
Returns
Type Description
System.Net.Http.StringContent

Implements