Class SubstitutionList

Defines a substitution list for an organization.

Inheritance

System.Object

SubstitutionList

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class SubstitutionList : IRelationsWithProxy

Properties

Active

Gets a value indicating whether the list is active.

Declaration

public bool Active { get; set; }

Property Value

Type	Description
System.Boolean

Guid

Gets the Guid of the list.

Declaration

public string Guid { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Gets the name of the list.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

SubstitutionRulesRelationLink

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

Declaration

public string SubstitutionRulesRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetSubstitutionRulesFromSubstitutionRulesRelation()

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

Declaration

public SubstitutionRules GetSubstitutionRulesFromSubstitutionRulesRelation()

Returns

Type	Description
SubstitutionRules	The content of the response.

GetSubstitutionRulesFromSubstitutionRulesRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionRules>> GetSubstitutionRulesFromSubstitutionRulesRelationAsync()

Returns

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

Remarks

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

GetSubstitutionRulesFromSubstitutionRulesRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionRules>> GetSubstitutionRulesFromSubstitutionRulesRelationAsync(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<SubstitutionRules>>	A task which runs the request.

Remarks

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

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 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.