FileCabinet Class

FileCabinet Class

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

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientFileCabinet

Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient (in DocuWare.Platform.ServerClient.dll) Version: Version 6.9

Syntax

Copy

[XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")]
[XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", 
	IsNullable = false)]
public class FileCabinet : IRelationsWithProxy, 
	IRelations, IHttpClientProxy

The FileCabinet type exposes the following members.

Constructors

	Name	Description
	FileCabinet	Creates a new instance of this class

Top

Properties

	Name	Description
	AddIndexEntriesInUpperCase	Gets whether all letters are input in upper case, regardless of how they were entered on the keyboard
	AdvancedDocumentUploadRelationLink	Gets the Uri of the link for the relation “advancedDocumentUpload”.
	AssignedCabinetId	Gets or sets a flag indicating whether this cabinet is default or not.
	BatchUpdateRelationLink	Gets the Uri of the link for the relation “batchUpdate”.
	Color	Gets or sets the color of the file cabinet icon.
	ContentMergeOperationRelationLink	Gets the Uri of the link for the relation “contentMergeOperation”.
	CustomSearchRelationLink	Gets the Uri of the link for the relation “customSearch”.
	Default	Gets or sets a flag indicating whether this cabinet is default or not.
	DialogsRelationLink	Gets the Uri of the link for the relation “dialogs”.
	DocumentReplicationStatusRelationLink	Gets the Uri of the link for the relation “documentReplicationStatus”.
	DocumentsRelationLink	Gets the Uri of the link for the relation “documents”.
	Fields	List of the fields of the cabinet.
	FieldValueStatisticsRelationLink	Gets the Uri of the link for the relation “fieldValueStatistics”.
	FinalizeReplicationRelationLink	Gets the Uri of the link for the relation “finalizeReplication”.
	Id	Gets or sets the id of the file.
	ImportDocumentsRelationLink	Gets the Uri of the link for the relation “importDocuments”.
	IntellixDialogId	Gets or sets a flag indicating whether this cabinet is default or not.
	IsBasket	Gets or sets a flag indicating whether this file cabinet is a basket or not.
	Links
	Name	Gets or sets the name of the file cabinet.
	NotificationsRelationLink	Gets the Uri of the link for the relation “notifications”.
	QueryRelationLink	Gets the Uri of the link for the relation “query”.
	ReplicationDataRelationLink	Gets the Uri of the link for the relation “replicationData”.
	ResultTreesRelationLink	Gets the Uri of the link for the relation “resultTrees”.
	Rights	List of the rights that the current user has for this cabinet.
	SearchesRelationLink	Gets the Uri of the link for the relation “searches”.
	SelfRelationLink	Gets the Uri of the link for the relation “self”.
	SetupReplicationRelationLink	Gets the Uri of the link for the relation “setupReplication”.
	StampsRelationLink	Gets the Uri of the link for the relation “stamps”.
	StoresRelationLink	Gets the Uri of the link for the relation “stores”.
	TaskListsRelationLink	Gets the Uri of the link for the relation “taskLists”.
	TransferRelationLink	Gets the Uri of the link for the relation “transfer”.
	UnprocessedDocumentUploadRelationLink	Gets the Uri of the link for the relation “unprocessedDocumentUpload”.
	Usable	Gets or sets if user has usage right for web basket. For file cabinets it's always true
	VersionHistoryResultListId	Gets the id of version history result list.
	VersionHistoryResultListRelationLink	Gets the Uri of the link for the relation “versionHistoryResultList”.
	VersionManagement	Version management mode.
	WindowsExplorerClientAccess	Gets whether the file cabinet can be accessed by windows explorer client.

Top

Methods

	Name	Description
	GetDialogFromCustomSearchRelation	Calls the HTTP Get method on the link for the relation “customSearch”.
	GetDialogFromCustomSearchRelationAsync	Calls the HTTP Get method on the link for the relation “customSearch” asynchronously.
	GetDialogFromCustomSearchRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “customSearch” asynchronously.
	GetDialogInfoFromVersionHistoryResultListRelation	Calls the HTTP Get method on the link for the relation “versionHistoryResultList”.
	GetDialogInfoFromVersionHistoryResultListRelationAsync	Calls the HTTP Get method on the link for the relation “versionHistoryResultList” asynchronously.
	GetDialogInfoFromVersionHistoryResultListRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “versionHistoryResultList” asynchronously.
	GetDialogInfosFromDialogsRelation	Calls the HTTP Get method on the link for the relation “dialogs”.
	GetDialogInfosFromDialogsRelationAsync	Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.
	GetDialogInfosFromDialogsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.
	GetDialogInfosFromResultTreesRelation	Calls the HTTP Get method on the link for the relation “resultTrees”.
	GetDialogInfosFromResultTreesRelationAsync	Calls the HTTP Get method on the link for the relation “resultTrees” asynchronously.
	GetDialogInfosFromResultTreesRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “resultTrees” asynchronously.
	GetDialogInfosFromSearchesRelation	Calls the HTTP Get method on the link for the relation “searches”.
	GetDialogInfosFromSearchesRelationAsync	Calls the HTTP Get method on the link for the relation “searches” asynchronously.
	GetDialogInfosFromSearchesRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “searches” asynchronously.
	GetDialogInfosFromStoresRelation	Calls the HTTP Get method on the link for the relation “stores”.
	GetDialogInfosFromStoresRelationAsync	Calls the HTTP Get method on the link for the relation “stores” asynchronously.
	GetDialogInfosFromStoresRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “stores” asynchronously.
	GetDialogInfosFromTaskListsRelation	Calls the HTTP Get method on the link for the relation “taskLists”.
	GetDialogInfosFromTaskListsRelationAsync	Calls the HTTP Get method on the link for the relation “taskLists” asynchronously.
	GetDialogInfosFromTaskListsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “taskLists” asynchronously.
	GetDocumentsQueryResultFromDocumentsRelation	Calls the HTTP Get method on the link for the relation “documents”.
	GetDocumentsQueryResultFromDocumentsRelationAsync	Calls the HTTP Get method on the link for the relation “documents” asynchronously.
	GetDocumentsQueryResultFromDocumentsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “documents” asynchronously.
	GetDocumentsQueryResultFromQueryRelation	Calls the HTTP Get method on the link for the relation “query”.
	GetDocumentsQueryResultFromQueryRelationAsync	Calls the HTTP Get method on the link for the relation “query” asynchronously.
	GetDocumentsQueryResultFromQueryRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “query” asynchronously.
	GetFileCabinetFromSelfRelation	Calls the HTTP Get method on the link for the relation “self”.
	GetFileCabinetFromSelfRelationAsync	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetFileCabinetFromSelfRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetNotificationsFromNotificationsRelation	Calls the HTTP Get method on the link for the relation “notifications”.
	GetNotificationsFromNotificationsRelationAsync	Calls the HTTP Get method on the link for the relation “notifications” asynchronously.
	GetNotificationsFromNotificationsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “notifications” asynchronously.
	GetStampsFromStampsRelation	Calls the HTTP Get method on the link for the relation “stamps”.
	GetStampsFromStampsRelationAsync	Calls the HTTP Get method on the link for the relation “stamps” asynchronously.
	GetStampsFromStampsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “stamps” asynchronously.
	PostToAdvancedDocumentUploadRelationForDocument	Calls the HTTP Post method on the link for the relation “advancedDocumentUpload”.
	PostToAdvancedDocumentUploadRelationForDocumentAsync(String, Stream)	Calls the HTTP Post method on the link for the relation “advancedDocumentUpload” asynchronously.
	PostToAdvancedDocumentUploadRelationForDocumentAsync(CancellationToken, String, Stream)	Calls the HTTP Post method on the link for the relation “advancedDocumentUpload” asynchronously.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult	Calls the HTTP Post method on the link for the relation “batchUpdate”.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcess)	Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(CancellationToken, BatchUpdateProcess)	Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
	PostToDocumentReplicationStatusRelationForStream	Calls the HTTP Post method on the link for the relation “documentReplicationStatus”.
	PostToDocumentReplicationStatusRelationForStreamAsync(Stream)	Calls the HTTP Post method on the link for the relation “documentReplicationStatus” asynchronously.
	PostToDocumentReplicationStatusRelationForStreamAsync(CancellationToken, Stream)	Calls the HTTP Post method on the link for the relation “documentReplicationStatus” asynchronously.
	PostToDocumentsRelationForDocument	Calls the HTTP Post method on the link for the relation “documents”.
	PostToDocumentsRelationForDocumentAsync(Document)	Calls the HTTP Post method on the link for the relation “documents” asynchronously.
	PostToDocumentsRelationForDocumentAsync(CancellationToken, Document)	Calls the HTTP Post method on the link for the relation “documents” asynchronously.
	PostToFieldValueStatisticsRelationForFieldValueStatisticsResult	Calls the HTTP Post method on the link for the relation “fieldValueStatistics”.
	PostToFieldValueStatisticsRelationForFieldValueStatisticsResultAsync(FieldValueStatisticsExpression)	Calls the HTTP Post method on the link for the relation “fieldValueStatistics” asynchronously.
	PostToFieldValueStatisticsRelationForFieldValueStatisticsResultAsync(CancellationToken, FieldValueStatisticsExpression)	Calls the HTTP Post method on the link for the relation “fieldValueStatistics” asynchronously.
	PostToFinalizeReplicationRelationForString	Calls the HTTP Post method on the link for the relation “finalizeReplication”.
	PostToFinalizeReplicationRelationForStringAsync(Stream)	Calls the HTTP Post method on the link for the relation “finalizeReplication” asynchronously.
	PostToFinalizeReplicationRelationForStringAsync(CancellationToken, Stream)	Calls the HTTP Post method on the link for the relation “finalizeReplication” asynchronously.
	PostToImportDocumentsRelationForImportResult(ImportSettings)	Calls the HTTP Post method on the link for the relation “importDocuments”.
	PostToImportDocumentsRelationForImportResult(SynchronizationSettings)	Calls the HTTP Post method on the link for the relation “importDocuments”.
	PostToImportDocumentsRelationForImportResultAsync(ImportSettings)	Calls the HTTP Post method on the link for the relation “importDocuments” asynchronously.
	PostToImportDocumentsRelationForImportResultAsync(SynchronizationSettings)	Calls the HTTP Post method on the link for the relation “importDocuments” asynchronously.
	PostToImportDocumentsRelationForImportResultAsync(CancellationToken, ImportSettings)	Calls the HTTP Post method on the link for the relation “importDocuments” asynchronously.
	PostToImportDocumentsRelationForImportResultAsync(CancellationToken, SynchronizationSettings)	Calls the HTTP Post method on the link for the relation “importDocuments” asynchronously.
	PostToNotificationsRelationForNotifications	Calls the HTTP Post method on the link for the relation “notifications”.
	PostToNotificationsRelationForNotificationsAsync(Notifications)	Calls the HTTP Post method on the link for the relation “notifications” asynchronously.
	PostToNotificationsRelationForNotificationsAsync(CancellationToken, Notifications)	Calls the HTTP Post method on the link for the relation “notifications” asynchronously.
	PostToReplicationDataRelationForStream	Calls the HTTP Post method on the link for the relation “replicationData”.
	PostToReplicationDataRelationForStreamAsync(Stream)	Calls the HTTP Post method on the link for the relation “replicationData” asynchronously.
	PostToReplicationDataRelationForStreamAsync(CancellationToken, Stream)	Calls the HTTP Post method on the link for the relation “replicationData” asynchronously.
	PostToSetupReplicationRelationForString	Calls the HTTP Post method on the link for the relation “setupReplication”.
	PostToSetupReplicationRelationForStringAsync(Stream)	Calls the HTTP Post method on the link for the relation “setupReplication” asynchronously.
	PostToSetupReplicationRelationForStringAsync(CancellationToken, Stream)	Calls the HTTP Post method on the link for the relation “setupReplication” asynchronously.
	PostToTransferRelationForDocumentsQueryResult(DocumentsTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer”.
	PostToTransferRelationForDocumentsQueryResult(FileCabinetTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer”.
	PostToTransferRelationForDocumentsQueryResultAsync(DocumentsTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer” asynchronously.
	PostToTransferRelationForDocumentsQueryResultAsync(FileCabinetTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer” asynchronously.
	PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken, DocumentsTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer” asynchronously.
	PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken, FileCabinetTransferInfo)	Calls the HTTP Post method on the link for the relation “transfer” asynchronously.
	PostToUnprocessedDocumentUploadRelationForDocument	Calls the HTTP Post method on the link for the relation “unprocessedDocumentUpload”.
	PostToUnprocessedDocumentUploadRelationForDocumentAsync(String, Stream)	Calls the HTTP Post method on the link for the relation “unprocessedDocumentUpload” asynchronously.
	PostToUnprocessedDocumentUploadRelationForDocumentAsync(CancellationToken, String, Stream)	Calls the HTTP Post method on the link for the relation “unprocessedDocumentUpload” asynchronously.
	PutToContentMergeOperationRelationForDocument	Calls the HTTP Put method on the link for the relation “contentMergeOperation”.
	PutToContentMergeOperationRelationForDocumentAsync(ContentMergeOperationInfo)	Calls the HTTP Put method on the link for the relation “contentMergeOperation” asynchronously.
	PutToContentMergeOperationRelationForDocumentAsync(CancellationToken, ContentMergeOperationInfo)	Calls the HTTP Put method on the link for the relation “contentMergeOperation” asynchronously.
	SetProxy	Sets the HTTP communication proxy which is used in further HTTP communication.

Top

Extension Methods

	Name	Description
	DeleteTResponse(String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetBaseUri	Gets the base URI of the specified relations instance. (Defined by RelationsWithProxyExtensions.)
	GetLink	Gets the link by its name. (Defined by RelationExtension.)
	GetRelationUri	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	GetRelationUriOrThrow	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	HasRelationUri	Determines whether the specified link exists. (Defined by RelationExtension.)
	SendTResponse(HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)

Top

Explicit Interface Implementations

	Name	Description
	IHttpClientProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace

Send comments on this topic to DocuWare