Class MultiColSelectListInfo

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Multi column select list object.

[Quokka]
public class MultiColSelectListInfo : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

MultiColSelectListInfo

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Columns

public List<string> Columns { get; set; }

Property Value

Type	Description
List<string>

Guid

The guid of the select list.

public string Guid { get; set; }

Property Value

Type	Description
string

Kind

The Kind of the select list.

public SelectListKind Kind { get; set; }

Property Value

Type	Description
SelectListKind

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The name of the select list.

public string Name { get; set; }

Property Value

Type	Description
string

ValuesRelationLink

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

public string ValuesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Methods

GetMultiColSelectListValuesResultFromValuesRelation()

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

public MultiColSelectListValuesResult GetMultiColSelectListValuesResultFromValuesRelation()

Returns

Type	Description
MultiColSelectListValuesResult	The content of the response.

GetMultiColSelectListValuesResultFromValuesRelationAsync()

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

public Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromValuesRelationAsync()

Returns

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

Remarks

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

GetMultiColSelectListValuesResultFromValuesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromValuesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToValuesRelationForMultiColSelectListValuesResult(MultiColSelectListValuesQuery)

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

public MultiColSelectListValuesResult PostToValuesRelationForMultiColSelectListValuesResult(MultiColSelectListValuesQuery dataToSend)

Parameters

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

Returns

Type	Description
MultiColSelectListValuesResult	The content of the response.

PostToValuesRelationForMultiColSelectListValuesResultAsync(MultiColSelectListValuesQuery)

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

public Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToValuesRelationForMultiColSelectListValuesResultAsync(MultiColSelectListValuesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToValuesRelationForMultiColSelectListValuesResultAsync(CancellationToken, MultiColSelectListValuesQuery)

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

public Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToValuesRelationForMultiColSelectListValuesResultAsync(CancellationToken cancellationToken, MultiColSelectListValuesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

SetProxy(HttpClientProxy)

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

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