Class DialogInfo

General properties of any dialog.

Inheritance

System.Object

DialogInfo

Dialog

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DialogInfo : IRelationsWithProxy

Constructors

DialogInfo()

Creates a new instance of this class

Declaration

public DialogInfo()

Properties

AssignedDialogId

The id of the assigned dialog (result list for search dialogs, info dialog for result dialogs, etc.)

Declaration

public string AssignedDialogId { get; set; }

Property Value

Type	Description
System.String

AssignedDialogRelationLink

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

Declaration

public string AssignedDialogRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ClientSideValidationRelationLink

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

Declaration

public string ClientSideValidationRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Color of the dialog icon.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String

CountRelationLink

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

Declaration

public string CountRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

CreateUserDefinedSearchRelationLink

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

Declaration

public string CreateUserDefinedSearchRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

DisplayName

The display name of the dialog

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

FileCabinetId

The id of the file cabinet

Declaration

public string FileCabinetId { get; set; }

Property Value

Type	Description
System.String

FileCabinetName

The name of the file cabinet

Declaration

public string FileCabinetName { get; set; }

Property Value

Type	Description
System.String

Id

The id of the dialog

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

IsDefault

Gets or sets if this dialog is a default dialog.

Declaration

public bool IsDefault { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

This flag can be used by the client to display a dialog in favour of the other dialogs. It can be used to display the initial dialog in case there is more than one dialog which can be displayed.

IsForMobile

Gets or sets if this dialog is a available for mobile client

Declaration

public bool IsForMobile { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SelectListRelationLink

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

Declaration

public string SelectListRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

SelfRelationLink

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

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

StoreDocumentRelationLink

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

Declaration

public string StoreDocumentRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

TransferRelationLink

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

Declaration

public string TransferRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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.

Type

The type of the dialog.

Declaration

public DialogTypes Type { get; set; }

Property Value

Type	Description
DialogTypes

Methods

DeleteSelfRelation()

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

Declaration

public string DeleteSelfRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteSelfRelationAsync()

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

Declaration

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

Returns

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

Remarks

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

DeleteSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

Remarks

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

GetCountResultFromCountRelation()

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

Declaration

public CountResult GetCountResultFromCountRelation()

Returns

Type	Description
CountResult	The content of the response.

GetCountResultFromCountRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountRelationAsync()

Returns

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

Remarks

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

GetCountResultFromCountRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDialogFromAssignedDialogRelation()

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

Declaration

public Dialog GetDialogFromAssignedDialogRelation()

Returns

Type	Description
Dialog	The content of the response.

GetDialogFromAssignedDialogRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromAssignedDialogRelationAsync()

Returns

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

Remarks

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

GetDialogFromAssignedDialogRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromAssignedDialogRelationAsync(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 “assignedDialog”.

GetDialogFromSelfRelation()

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

Declaration

public Dialog GetDialogFromSelfRelation()

Returns

Type	Description
Dialog	The content of the response.

GetDialogFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromSelfRelationAsync()

Returns

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

Remarks

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

GetDialogFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromSelfRelationAsync(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 “self”.

PostToClientSideValidationRelationForString(DocumentIndexFields)

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

Declaration

public string PostToClientSideValidationRelationForString(DocumentIndexFields dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PostToClientSideValidationRelationForStringAsync(DocumentIndexFields)

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

Declaration

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

Remarks

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

PostToClientSideValidationRelationForStringAsync(System.Threading.CancellationToken, DocumentIndexFields)

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

Declaration

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

Parameters

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

Returns

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

Remarks

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

PostToCountRelationForCountResult(CountExpression)

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

Declaration

public CountResult PostToCountRelationForCountResult(CountExpression dataToSend)

Parameters

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

Returns

Type	Description
CountResult	The content of the response.

PostToCountRelationForCountResultAsync(CountExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> PostToCountRelationForCountResultAsync(CountExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCountRelationForCountResultAsync(System.Threading.CancellationToken, CountExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> PostToCountRelationForCountResultAsync(System.Threading.CancellationToken cancellationToken, CountExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCreateUserDefinedSearchRelationForDialog(UserDefinedSearchInfo)

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

Declaration

public Dialog PostToCreateUserDefinedSearchRelationForDialog(UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

Type	Description
Dialog	The content of the response.

PostToCreateUserDefinedSearchRelationForDialogAsync(UserDefinedSearchInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCreateUserDefinedSearchRelationForDialogAsync(System.Threading.CancellationToken, UserDefinedSearchInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(System.Threading.CancellationToken cancellationToken, UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSelectListRelationForSelectListResult(SelectListExpression)

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

Declaration

public SelectListResult PostToSelectListRelationForSelectListResult(SelectListExpression dataToSend)

Parameters

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

Returns

Type	Description
SelectListResult	The content of the response.

PostToSelectListRelationForSelectListResultAsync(SelectListExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListRelationForSelectListResultAsync(SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSelectListRelationForSelectListResultAsync(System.Threading.CancellationToken, SelectListExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListRelationForSelectListResultAsync(System.Threading.CancellationToken cancellationToken, SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToStoreDocumentRelationForDocument(Document)

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

Declaration

public Document PostToStoreDocumentRelationForDocument(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.

PostToStoreDocumentRelationForDocumentAsync(Document)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToStoreDocumentRelationForDocumentAsync(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 “storeDocument”.

PostToStoreDocumentRelationForDocumentAsync(System.Threading.CancellationToken, Document)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> PostToStoreDocumentRelationForDocumentAsync(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 “storeDocument”.

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

SetProxy(HttpClientProxy)

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

Declaration

public virtual void SetProxy(HttpClientProxy proxy)

Parameters

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

Remarks

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

ToString()

Returns a that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A that represents this instance.