Class SingleColumnSelectListValues
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class SingleColumnSelectListValues : IRelationsWithProxy
Properties
FirstRelationLink
Gets the Uri of the link for the relation “first”.
Declaration
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
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
NextRelationLink
Gets the Uri of the link for the relation “next”.
Declaration
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
PrevRelationLink
Gets the Uri of the link for the relation “prev”.
Declaration
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
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
TypedValue
Select list values.
Declaration
public List<DocumentIndexFieldValue> TypedValue { get; set; }
Property Value
Type | Description |
---|---|
List<DocumentIndexFieldValue> |
Value
Select list values as string.
Declaration
public List<string> Value { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
Methods
GetSingleColumnSelectListValuesFromFirstRelation()
Calls the HTTP Get method on the link for the relation “first”.
Declaration
public SingleColumnSelectListValues GetSingleColumnSelectListValuesFromFirstRelation()
Returns
Type | Description |
---|---|
SingleColumnSelectListValues | The content of the response. |
GetSingleColumnSelectListValuesFromFirstRelationAsync()
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromFirstRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetSingleColumnSelectListValuesFromFirstRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromFirstRelationAsync(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<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetSingleColumnSelectListValuesFromNextRelation()
Calls the HTTP Get method on the link for the relation “next”.
Declaration
public SingleColumnSelectListValues GetSingleColumnSelectListValuesFromNextRelation()
Returns
Type | Description |
---|---|
SingleColumnSelectListValues | The content of the response. |
GetSingleColumnSelectListValuesFromNextRelationAsync()
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromNextRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetSingleColumnSelectListValuesFromNextRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromNextRelationAsync(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<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetSingleColumnSelectListValuesFromPrevRelation()
Calls the HTTP Get method on the link for the relation “prev”.
Declaration
public SingleColumnSelectListValues GetSingleColumnSelectListValuesFromPrevRelation()
Returns
Type | Description |
---|---|
SingleColumnSelectListValues | The content of the response. |
GetSingleColumnSelectListValuesFromPrevRelationAsync()
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromPrevRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetSingleColumnSelectListValuesFromPrevRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromPrevRelationAsync(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<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetSingleColumnSelectListValuesFromSelfRelation()
Calls the HTTP Get method on the link for the relation “self”.
Declaration
public SingleColumnSelectListValues GetSingleColumnSelectListValuesFromSelfRelation()
Returns
Type | Description |
---|---|
SingleColumnSelectListValues | The content of the response. |
GetSingleColumnSelectListValuesFromSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetSingleColumnSelectListValuesFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleColumnSelectListValues>> GetSingleColumnSelectListValuesFromSelfRelationAsync(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<SingleColumnSelectListValues>> | 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 |
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.