Class SelectListResult

Select list values.

Inheritance

System.Object

SelectListResult

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class SelectListResult : IRelationsWithProxy

Properties

FirstRelationLink

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

Declaration

[Eagle]
public string FirstRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

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

Declaration

[Eagle]
public string NextRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

PrevRelationLink

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

Declaration

[Eagle]
public string PrevRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

[Eagle]
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.

TypedValue

Declaration

public List<DocumentIndexFieldValue> TypedValue { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DocumentIndexFieldValue>

Value

Select list values.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Methods

GetSelectListResultFromFirstRelation()

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

Declaration

[Eagle]
public SelectListResult GetSelectListResultFromFirstRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromFirstRelationAsync()

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromFirstRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromFirstRelationAsync(CancellationToken)

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromFirstRelationAsync(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<SelectListResult>>	A task which runs the request.

Remarks

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

GetSelectListResultFromNextRelation()

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

Declaration

[Eagle]
public SelectListResult GetSelectListResultFromNextRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromNextRelationAsync()

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromNextRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromNextRelationAsync(CancellationToken)

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromNextRelationAsync(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<SelectListResult>>	A task which runs the request.

Remarks

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

GetSelectListResultFromPrevRelation()

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

Declaration

[Eagle]
public SelectListResult GetSelectListResultFromPrevRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromPrevRelationAsync()

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromPrevRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromPrevRelationAsync(CancellationToken)

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromPrevRelationAsync(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<SelectListResult>>	A task which runs the request.

Remarks

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

GetSelectListResultFromSelfRelation()

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

Declaration

[Eagle]
public SelectListResult GetSelectListResultFromSelfRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromSelfRelationAsync()

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelfRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromSelfRelationAsync(CancellationToken)

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

Declaration

[Eagle]
public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelfRelationAsync(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<SelectListResult>>	A task which runs the request.

Remarks

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

SetProxy(HttpClientProxy)

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

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The System.Net.Http.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.