Class MultiColSelectListInfo
Multi column select list object.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class MultiColSelectListInfo : IRelationsWithProxy
Properties
Columns
Declaration
public List<string> Columns { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
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
GetMultiColSelectListValuesResultFromValuesRelation()
Calls the HTTP Get method on the link for the relation “values”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromValuesRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “values”.
GetMultiColSelectListValuesResultFromValuesRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “values” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromValuesRelationAsync(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<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”.
Declaration
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.
Declaration
public System.Threading.Tasks.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 |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “values”.
PostToValuesRelationForMultiColSelectListValuesResultAsync(System.Threading.CancellationToken, MultiColSelectListValuesQuery)
Calls the HTTP Post method on the link for the relation “values” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> PostToValuesRelationForMultiColSelectListValuesResultAsync(System.Threading.CancellationToken cancellationToken, MultiColSelectListValuesQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.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 |
---|---|
System.Threading.Tasks.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.
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.