Class SelectListInfo

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Select list information object.

public class SelectListInfo : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

SelectListInfo

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

ContainsRelationLink

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

public string ContainsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

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

GetSelectListValuesResultFromValuesRelation()

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

public SelectListValuesResult GetSelectListValuesResultFromValuesRelation()

Returns

Type	Description
SelectListValuesResult	The content of the response.

GetSelectListValuesResultFromValuesRelationAsync()

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

public Task<DeserializedHttpResponse<SelectListValuesResult>> GetSelectListValuesResultFromValuesRelationAsync()

Returns

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

Remarks

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

GetSelectListValuesResultFromValuesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SelectListValuesResult>> GetSelectListValuesResultFromValuesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToContainsRelationForAreValuesInSelectListsResult(SelectListValuesToCheck)

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

public AreValuesInSelectListsResult PostToContainsRelationForAreValuesInSelectListsResult(SelectListValuesToCheck dataToSend)

Parameters

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

Returns

Type	Description
AreValuesInSelectListsResult	The content of the response.

PostToContainsRelationForAreValuesInSelectListsResultAsync(SelectListValuesToCheck)

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

public Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> PostToContainsRelationForAreValuesInSelectListsResultAsync(SelectListValuesToCheck dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToContainsRelationForAreValuesInSelectListsResultAsync(CancellationToken, SelectListValuesToCheck)

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

public Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> PostToContainsRelationForAreValuesInSelectListsResultAsync(CancellationToken cancellationToken, SelectListValuesToCheck dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToValuesRelationForSelectListValuesResult(SelectListValuesQuery)

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

public SelectListValuesResult PostToValuesRelationForSelectListValuesResult(SelectListValuesQuery dataToSend)

Parameters

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

Returns

Type	Description
SelectListValuesResult	The content of the response.

PostToValuesRelationForSelectListValuesResultAsync(SelectListValuesQuery)

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

public Task<DeserializedHttpResponse<SelectListValuesResult>> PostToValuesRelationForSelectListValuesResultAsync(SelectListValuesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToValuesRelationForSelectListValuesResultAsync(CancellationToken, SelectListValuesQuery)

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

public Task<DeserializedHttpResponse<SelectListValuesResult>> PostToValuesRelationForSelectListValuesResultAsync(CancellationToken cancellationToken, SelectListValuesQuery dataToSend)

Parameters

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

Returns

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