Class SelectListInfo
Select list information object.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class SelectListInfo : IRelationsWithProxy
Properties
ContainsRelationLink
Gets the Uri of the link for the relation “contains”.
Declaration
public string ContainsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “contains” if it exists, or
Guid
The guid of the select list.
Declaration
public string Guid { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Kind
The Kind of the select list.
Declaration
public SelectListKind Kind { get; set; }
Property Value
Type | Description |
---|---|
SelectListKind |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
Name
The name of the select list.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ValuesRelationLink
Gets the Uri of the link for the relation “values”.
Declaration
public string ValuesRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “values” if it exists, or
Methods
GetSelectListValuesResultFromValuesRelation()
Calls the HTTP Get method on the link for the relation “values”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListValuesResult>> GetSelectListValuesResultFromValuesRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “values”.
GetSelectListValuesResultFromValuesRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “values” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListValuesResult>> GetSelectListValuesResultFromValuesRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “contains”.
PostToContainsRelationForAreValuesInSelectListsResultAsync(System.Threading.CancellationToken, SelectListValuesToCheck)
Calls the HTTP Post method on the link for the relation “contains” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<AreValuesInSelectListsResult>> PostToContainsRelationForAreValuesInSelectListsResultAsync(System.Threading.CancellationToken cancellationToken, SelectListValuesToCheck dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “values”.
PostToValuesRelationForSelectListValuesResultAsync(System.Threading.CancellationToken, SelectListValuesQuery)
Calls the HTTP Post method on the link for the relation “values” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListValuesResult>> PostToValuesRelationForSelectListValuesResultAsync(System.Threading.CancellationToken cancellationToken, SelectListValuesQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.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.
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.