Class DialogInfo

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

General properties of any dialog.

public class DialogInfo : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DialogInfo

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Derived

Dialog

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

EasyFileUploadExtensionsBase.EasyUploadDocument(DialogInfo, InputDocument)

EasyFileUploadExtensionsBase.EasyUploadDocumentAsync(DialogInfo, InputDocument)

FileCabinetExtensionsBase.UploadDocumentAsync(DialogInfo, InputDocument)

Constructors

DialogInfo()

Creates a new instance of this class

public DialogInfo()

Properties

AssignedDialogId

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

public string AssignedDialogId { get; set; }

Property Value

Type	Description
string

AssignedDialogRelationLink

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

public string AssignedDialogRelationLink { get; }

Property Value

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

public string ClientSideValidationRelationLink { get; }

Property Value

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

public string Color { get; set; }

Property Value

Type	Description
string

CountRelationLink

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

public string CountRelationLink { get; }

Property Value

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

public string CreateUserDefinedSearchRelationLink { get; }

Property Value

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

public string DisplayName { get; set; }

Property Value

Type	Description
string

FileCabinetId

The id of the file cabinet

public string FileCabinetId { get; set; }

Property Value

Type	Description
string

FileCabinetName

The name of the file cabinet

public string FileCabinetName { get; set; }

Property Value

Type	Description
string

Id

The id of the dialog

public string Id { get; set; }

Property Value

Type	Description
string

IsDefault

Gets or sets if this dialog is a default dialog.

public bool IsDefault { get; set; }

Property Value

Type	Description
bool

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

public bool IsForMobile { get; set; }

Property Value

Type	Description
bool

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SelectListRelationLink

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

public string SelectListRelationLink { get; }

Property Value

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

public string SelfRelationLink { get; }

Property Value

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

public string StoreDocumentRelationLink { get; }

Property Value

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

public string TransferRelationLink { get; }

Property Value

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

public DialogTypes Type { get; set; }

Property Value

Type	Description
DialogTypes

Methods

DeleteSelfRelation()

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

[Dolphin]
public string DeleteSelfRelation()

Returns

Type	Description
string	The content of the response.

DeleteSelfRelationAsync()

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

[Dolphin]
public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

DeleteSelfRelationAsync(CancellationToken)

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

[Dolphin]
public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountRelationAsync()

Returns

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

Remarks

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

GetCountResultFromCountRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<Dialog>> GetDialogFromAssignedDialogRelationAsync()

Returns

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

Remarks

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

GetDialogFromAssignedDialogRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Dialog>> GetDialogFromAssignedDialogRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<Dialog>> GetDialogFromSelfRelationAsync()

Returns

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

Remarks

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

GetDialogFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Dialog>> GetDialogFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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
string	The content of the response.

PostToClientSideValidationRelationForStringAsync(DocumentIndexFields)

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

public 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
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

PostToClientSideValidationRelationForStringAsync(CancellationToken, DocumentIndexFields)

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

public Task<DeserializedHttpResponse<string>> PostToClientSideValidationRelationForStringAsync(CancellationToken cancellationToken, DocumentIndexFields dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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”.

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.

public 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
Task<DeserializedHttpResponse<CountResult>>	A task which runs the request.

Remarks

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

PostToCountRelationForCountResultAsync(CancellationToken, CountExpression)

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

public Task<DeserializedHttpResponse<CountResult>> PostToCountRelationForCountResultAsync(CancellationToken cancellationToken, CountExpression dataToSend)

Parameters

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

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.

public 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
Task<DeserializedHttpResponse<Dialog>>	A task which runs the request.

Remarks

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

PostToCreateUserDefinedSearchRelationForDialogAsync(CancellationToken, UserDefinedSearchInfo)

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

public Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(CancellationToken cancellationToken, UserDefinedSearchInfo dataToSend)

Parameters

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

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.

public 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
Task<DeserializedHttpResponse<SelectListResult>>	A task which runs the request.

Remarks

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

PostToSelectListRelationForSelectListResultAsync(CancellationToken, SelectListExpression)

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

public Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListRelationForSelectListResultAsync(CancellationToken cancellationToken, SelectListExpression dataToSend)

Parameters

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

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.

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

Remarks

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

PostToStoreDocumentRelationForDocumentAsync(CancellationToken, Document)

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

public Task<DeserializedHttpResponse<Document>> PostToStoreDocumentRelationForDocumentAsync(CancellationToken cancellationToken, Document dataToSend)

Parameters

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

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

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.

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

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

Remarks

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

PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken, DocumentsTransferInfo)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken cancellationToken, DocumentsTransferInfo dataToSend)

Parameters

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

Remarks

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

PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken, FileCabinetTransferInfo)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToTransferRelationForDocumentsQueryResultAsync(CancellationToken cancellationToken, FileCabinetTransferInfo dataToSend)

Parameters

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

public virtual void SetProxy(HttpClientProxy proxy)

Parameters

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

Remarks

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

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

Type	Description
string	A String that represents this instance.

Overrides

Object.ToString()