Class FileCabinet

Models a DocuWare file cabinet or a web basket(document tray).

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

Constructors

FileCabinet()

Creates a new instance of this class

Declaration
public FileCabinet()

Properties

AddIndexEntriesInUpperCase

Gets whether all letters are input in upper case, regardless of how they were entered on the keyboard

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

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

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

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

AssignedCabinetId

Gets or sets a flag indicating whether this cabinet is default or not.

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

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

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

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

Color

Gets or sets the color of the file cabinet icon.

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

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

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

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

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

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

Default

Gets or sets a flag indicating whether this cabinet is default or not.

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

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

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

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

DocumentAuditingEnabled

Gets or sets a value indicating whether the document auditing is enabled for that file cabinet.

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

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

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

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

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

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

ExtendedUserRights

Gets a sets the extended user rights.

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

Fields

List of the fields of the cabinet.

Declaration
public List<FileCabinetField> Fields { get; set; }
Property Value
Type Description
List<FileCabinetField>

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

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

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

HasFullTextSupport

Gets or sets a value indicating whether the cabinet has fulltext search support.

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

Id

Gets or sets the id of the file.

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

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

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

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

IntellixDialogId

Gets or sets a flag indicating whether this cabinet is default or not.

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

IsBasket

Gets or sets a flag indicating whether this file cabinet is a basket or not.

Declaration
public bool IsBasket { get; set; }
Property Value
Type Description
System.Boolean
Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

Name

Gets or sets the name of the file cabinet.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Rights

List of the rights that the current user has for this cabinet.

Declaration
public List<Right> Rights { get; set; }
Property Value
Type Description
List<Right>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Usable

Gets or sets if user has usage right for web basket. For file cabinets it's always true

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

VersionHistoryResultListId

Gets the id of version history result list.

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

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

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

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

VersionManagement

Version management mode.

Declaration
public VersionManagementMode VersionManagement { get; set; }
Property Value
Type Description
VersionManagementMode

WindowsExplorerClientAccess

Gets whether the file cabinet can be accessed by windows explorer client.

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

Methods

GetDialogFromCustomSearchRelation()

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

Declaration
public Dialog GetDialogFromCustomSearchRelation()
Returns
Type Description
Dialog

The content of the response.

GetDialogFromCustomSearchRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromCustomSearchRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>>

A task which runs the request.
Remarks

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

GetDialogFromCustomSearchRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromCustomSearchRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfoFromVersionHistoryResultListRelation()

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

Declaration
public DialogInfo GetDialogInfoFromVersionHistoryResultListRelation()
Returns
Type Description
DialogInfo

The content of the response.

GetDialogInfoFromVersionHistoryResultListRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfo>> GetDialogInfoFromVersionHistoryResultListRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfo>>

A task which runs the request.
Remarks

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

GetDialogInfoFromVersionHistoryResultListRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfo>> GetDialogInfoFromVersionHistoryResultListRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfosFromDialogsRelation()

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

Declaration
public DialogInfos GetDialogInfosFromDialogsRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromDialogsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

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

GetDialogInfosFromDialogsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfosFromResultTreesRelation()

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

Declaration
public DialogInfos GetDialogInfosFromResultTreesRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromResultTreesRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromResultTreesRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

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

GetDialogInfosFromResultTreesRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromResultTreesRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfosFromSearchesRelation()

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

Declaration
public DialogInfos GetDialogInfosFromSearchesRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromSearchesRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromSearchesRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

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

GetDialogInfosFromSearchesRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromSearchesRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfosFromStoresRelation()

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

Declaration
public DialogInfos GetDialogInfosFromStoresRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromStoresRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromStoresRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

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

GetDialogInfosFromStoresRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromStoresRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDialogInfosFromTaskListsRelation()

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

Declaration
public DialogInfos GetDialogInfosFromTaskListsRelation()
Returns
Type Description
DialogInfos

The content of the response.

GetDialogInfosFromTaskListsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromTaskListsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>>

A task which runs the request.
Remarks

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

GetDialogInfosFromTaskListsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromTaskListsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDocumentsQueryResultFromDocumentsRelation()

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

Declaration
public DocumentsQueryResult GetDocumentsQueryResultFromDocumentsRelation()
Returns
Type Description
DocumentsQueryResult

The content of the response.

GetDocumentsQueryResultFromDocumentsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromDocumentsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>

A task which runs the request.
Remarks

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

GetDocumentsQueryResultFromDocumentsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromDocumentsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDocumentsQueryResultFromQueryRelation()

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

Declaration
public DocumentsQueryResult GetDocumentsQueryResultFromQueryRelation()
Returns
Type Description
DocumentsQueryResult

The content of the response.

GetDocumentsQueryResultFromQueryRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromQueryRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>

A task which runs the request.
Remarks

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

GetDocumentsQueryResultFromQueryRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromQueryRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetDocumentsQueryTableResultFromDocumentsTableRelation()

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

Declaration
public DocumentsQueryTableResult GetDocumentsQueryTableResultFromDocumentsTableRelation()
Returns
Type Description
DocumentsQueryTableResult

The content of the response.

GetDocumentsQueryTableResultFromDocumentsTableRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetDocumentsQueryTableResultFromDocumentsTableRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>>

A task which runs the request.
Remarks

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

GetDocumentsQueryTableResultFromDocumentsTableRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetDocumentsQueryTableResultFromDocumentsTableRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetFileCabinetFromSelfRelation()

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

Declaration
public FileCabinet GetFileCabinetFromSelfRelation()
Returns
Type Description
FileCabinet

The content of the response.

GetFileCabinetFromSelfRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromSelfRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>>

A task which runs the request.
Remarks

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

GetFileCabinetFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetNotificationsFromNotificationsRelation()

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

Declaration
public Notifications GetNotificationsFromNotificationsRelation()
Returns
Type Description
Notifications

The content of the response.

GetNotificationsFromNotificationsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>> GetNotificationsFromNotificationsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>>

A task which runs the request.
Remarks

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

GetNotificationsFromNotificationsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>> GetNotificationsFromNotificationsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetStampsFromStampsRelation()

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

Declaration
public Stamps GetStampsFromStampsRelation()
Returns
Type Description
Stamps

The content of the response.

GetStampsFromStampsRelationAsync()

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Stamps>> GetStampsFromStampsRelationAsync()
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Stamps>>

A task which runs the request.
Remarks

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

GetStampsFromStampsRelationAsync(System.Threading.CancellationToken)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Stamps>> GetStampsFromStampsRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

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

A task which runs the request.
Remarks

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

GetStreamFromReplicationInfoRelation()

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

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

The content of the response.

GetStreamFromReplicationInfoRelationAsync()

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

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

GetStreamFromReplicationInfoRelationAsync(System.Threading.CancellationToken)

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

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

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

A task which runs the request.
Remarks

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

PostToAdvancedDocumentUploadRelationForDocument(String, System.IO.Stream)

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

Declaration
public Document PostToAdvancedDocumentUploadRelationForDocument(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

The content of the response.

PostToAdvancedDocumentUploadRelationForDocumentAsync(String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToAdvancedDocumentUploadRelationForDocumentAsync(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

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

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToAdvancedDocumentUploadRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcess)

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

Declaration
public BatchUpdateIndexFieldsResult PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcess dataToSend)
Parameters
Type Name Description
BatchUpdateProcess dataToSend

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

The content of the response.

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcess)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcess dataToSend)
Parameters
Type Name Description
BatchUpdateProcess dataToSend

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

A task which runs the request.
Remarks

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

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(System.Threading.CancellationToken, BatchUpdateProcess)

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

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

The cancellation token to cancel the request.
BatchUpdateProcess dataToSend

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

A task which runs the request.
Remarks

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

PostToDocumentsRelationForDocument(Document)

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

Declaration
public Document PostToDocumentsRelationForDocument(Document dataToSend)
Parameters
Type Name Description
Document dataToSend

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

The content of the response.

PostToDocumentsRelationForDocumentAsync(Document)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToDocumentsRelationForDocumentAsync(Document dataToSend)
Parameters
Type Name Description
Document 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 “documents”.

PostToDocumentsRelationForDocumentAsync(System.Threading.CancellationToken, Document)

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

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

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

PostToFieldValueStatisticsRelationForFieldValueStatisticsResult(FieldValueStatisticsExpression)

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

Declaration
public FieldValueStatisticsResult PostToFieldValueStatisticsRelationForFieldValueStatisticsResult(FieldValueStatisticsExpression dataToSend)
Parameters
Type Name Description
FieldValueStatisticsExpression dataToSend

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

The content of the response.

PostToFieldValueStatisticsRelationForFieldValueStatisticsResultAsync(FieldValueStatisticsExpression)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FieldValueStatisticsResult>> PostToFieldValueStatisticsRelationForFieldValueStatisticsResultAsync(FieldValueStatisticsExpression dataToSend)
Parameters
Type Name Description
FieldValueStatisticsExpression dataToSend

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

A task which runs the request.
Remarks

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

PostToFieldValueStatisticsRelationForFieldValueStatisticsResultAsync(System.Threading.CancellationToken, FieldValueStatisticsExpression)

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

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

The cancellation token to cancel the request.
FieldValueStatisticsExpression dataToSend

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

A task which runs the request.
Remarks

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

PostToImportDocumentsRelationForImportResult(ImportSettings)

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

Declaration
public ImportResult PostToImportDocumentsRelationForImportResult(ImportSettings dataToSend)
Parameters
Type Name Description
ImportSettings dataToSend

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

The content of the response.

PostToImportDocumentsRelationForImportResult(SynchronizationSettings)

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

Declaration
public ImportResult PostToImportDocumentsRelationForImportResult(SynchronizationSettings dataToSend)
Parameters
Type Name Description
SynchronizationSettings dataToSend

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

The content of the response.

PostToImportDocumentsRelationForImportResultAsync(ImportSettings)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentsRelationForImportResultAsync(ImportSettings dataToSend)
Parameters
Type Name Description
ImportSettings dataToSend

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

A task which runs the request.
Remarks

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

PostToImportDocumentsRelationForImportResultAsync(SynchronizationSettings)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<ImportResult>> PostToImportDocumentsRelationForImportResultAsync(SynchronizationSettings dataToSend)
Parameters
Type Name Description
SynchronizationSettings dataToSend

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

A task which runs the request.
Remarks

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

PostToImportDocumentsRelationForImportResultAsync(System.Threading.CancellationToken, ImportSettings)

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

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

The cancellation token to cancel the request.
ImportSettings dataToSend

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

A task which runs the request.
Remarks

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

PostToImportDocumentsRelationForImportResultAsync(System.Threading.CancellationToken, SynchronizationSettings)

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

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

The cancellation token to cancel the request.
SynchronizationSettings dataToSend

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

A task which runs the request.
Remarks

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

PostToNextSequenceElementRelationForSequenceResult(SequenceRequest)

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

Declaration
public SequenceResult PostToNextSequenceElementRelationForSequenceResult(SequenceRequest dataToSend)
Parameters
Type Name Description
SequenceRequest dataToSend

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

The content of the response.

PostToNextSequenceElementRelationForSequenceResultAsync(SequenceRequest)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SequenceResult>> PostToNextSequenceElementRelationForSequenceResultAsync(SequenceRequest dataToSend)
Parameters
Type Name Description
SequenceRequest dataToSend

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

A task which runs the request.
Remarks

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

PostToNextSequenceElementRelationForSequenceResultAsync(System.Threading.CancellationToken, SequenceRequest)

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

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

The cancellation token to cancel the request.
SequenceRequest dataToSend

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

A task which runs the request.
Remarks

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

PostToNotificationsRelationForNotifications(Notifications)

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

Declaration
public Notifications PostToNotificationsRelationForNotifications(Notifications dataToSend)
Parameters
Type Name Description
Notifications dataToSend

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

The content of the response.

PostToNotificationsRelationForNotificationsAsync(Notifications)

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

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

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

A task which runs the request.
Remarks

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

PostToNotificationsRelationForNotificationsAsync(System.Threading.CancellationToken, Notifications)

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

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

The cancellation token to cancel the request.
Notifications dataToSend

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

A task which runs the request.
Remarks

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

PostToReplicationDataRelationForStream(System.IO.Stream)

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

Declaration
public System.IO.Stream PostToReplicationDataRelationForStream(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

The content of the response.

PostToReplicationDataRelationForStreamAsync(System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToReplicationDataRelationForStreamAsync(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

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

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

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

The cancellation token to cancel the request.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

PostToReplicationDeleteDataRelationForStream(System.IO.Stream)

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

Declaration
public System.IO.Stream PostToReplicationDeleteDataRelationForStream(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

The content of the response.

PostToReplicationDeleteDataRelationForStreamAsync(System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToReplicationDeleteDataRelationForStreamAsync(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

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

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

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

The cancellation token to cancel the request.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

PostToSetupReplicationRelationForString(System.IO.Stream)

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

Declaration
public string PostToSetupReplicationRelationForString(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

The content of the response.

PostToSetupReplicationRelationForStringAsync(System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToSetupReplicationRelationForStringAsync(System.IO.Stream dataToSend)
Parameters
Type Name Description
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

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

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

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

The cancellation token to cancel the request.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

PostToTransferRelationForDocumentsQueryResult(DocumentsTransferInfo)

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

Declaration
public DocumentsQueryResult PostToTransferRelationForDocumentsQueryResult(DocumentsTransferInfo dataToSend)
Parameters
Type Name Description
DocumentsTransferInfo dataToSend

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

The content of the response.

PostToTransferRelationForDocumentsQueryResult(FileCabinetTransferInfo)

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

Declaration
public DocumentsQueryResult PostToTransferRelationForDocumentsQueryResult(FileCabinetTransferInfo dataToSend)
Parameters
Type Name Description
FileCabinetTransferInfo dataToSend

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

The content of the response.

PostToTransferRelationForDocumentsQueryResultAsync(DocumentsTransferInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferRelationForDocumentsQueryResultAsync(DocumentsTransferInfo dataToSend)
Parameters
Type Name Description
DocumentsTransferInfo 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 “transfer”.

PostToTransferRelationForDocumentsQueryResultAsync(FileCabinetTransferInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferRelationForDocumentsQueryResultAsync(FileCabinetTransferInfo dataToSend)
Parameters
Type Name Description
FileCabinetTransferInfo 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 “transfer”.

PostToTransferRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, DocumentsTransferInfo)

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

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

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

PostToTransferRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, FileCabinetTransferInfo)

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

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

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

PostToUnprocessedDocumentUploadRelationForDocument(String, System.IO.Stream)

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

Declaration
public Document PostToUnprocessedDocumentUploadRelationForDocument(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

The content of the response.

PostToUnprocessedDocumentUploadRelationForDocumentAsync(String, System.IO.Stream)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToUnprocessedDocumentUploadRelationForDocumentAsync(string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

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

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToUnprocessedDocumentUploadRelationForDocumentAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
System.String requestedContentType

Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream dataToSend

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

A task which runs the request.
Remarks

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

PutToContentMergeOperationRelationForDocument(ContentMergeOperationInfo)

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

Declaration
public Document PutToContentMergeOperationRelationForDocument(ContentMergeOperationInfo dataToSend)
Parameters
Type Name Description
ContentMergeOperationInfo dataToSend

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

The content of the response.

PutToContentMergeOperationRelationForDocumentAsync(ContentMergeOperationInfo)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PutToContentMergeOperationRelationForDocumentAsync(ContentMergeOperationInfo dataToSend)
Parameters
Type Name Description
ContentMergeOperationInfo 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 “contentMergeOperation”.

PutToContentMergeOperationRelationForDocumentAsync(System.Threading.CancellationToken, ContentMergeOperationInfo)

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

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

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

SetProxy(HttpClientProxy)

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

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

The instance which is used in further HTTP communication.
Remarks

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

Extension Methods