Class PlatformClientConfiguration

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

A interface which is used to calculate a hash to identify the machine or device the application is running.

public abstract class PlatformClientConfiguration

Inheritance

object

PlatformClientConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DefaultProductInfoHeader

Gets or sets the default product information header.

public static ProductInfoHeaderValue DefaultProductInfoHeader { get; set; }

Property Value

Type	Description
ProductInfoHeaderValue	The default product information header.

Methods

AddProductInfoHeaderValueOfExecutingApplication(HttpHeaderValueCollection<ProductInfoHeaderValue>)

Gets the product information header value of executing application.

public abstract void AddProductInfoHeaderValueOfExecutingApplication(HttpHeaderValueCollection<ProductInfoHeaderValue> userAgent)

Parameters

Type	Name	Description
HttpHeaderValueCollection<ProductInfoHeaderValue>	userAgent

CreateDefaultCircuitBreakerPolicyOptions()

Creates the default circuit breaker policy options.

public abstract CircuitBreakerPolicyOptions CreateDefaultCircuitBreakerPolicyOptions()

Returns

Type	Description
CircuitBreakerPolicyOptions	The default circuit breaker policy options.

CreateDefaultHttpMessageHandler()

Creates the default HTTP message handler.

public abstract HttpMessageHandler CreateDefaultHttpMessageHandler()

Returns

Type	Description
HttpMessageHandler	The default message handler which is used when connection to a service in case there is no explicit handler given.

CreateDefaultRetryPolicyOptions()

Creates the default retry policy options.

public abstract RetryPolicyOptions CreateDefaultRetryPolicyOptions()

Returns

Type	Description
RetryPolicyOptions	The default retry policy options.

CreateHandlerForNTLMAuthentication(ICredentials)

Creates a HttpClientHandler instance for handling NTLM authentication.

public abstract HttpClientHandler CreateHandlerForNTLMAuthentication(ICredentials credentials)

Parameters

Type	Name	Description
ICredentials	credentials	The credentials.

Returns

Type	Description
HttpClientHandler	HttpClientHandler instance which uses the specified credentials.

CreateHandlerForNTLMAuthentication(Uri, string, string, string)

Creates a HttpClientHandler instance for handling NTLM authentication.

public abstract HttpClientHandler CreateHandlerForNTLMAuthentication(Uri serviceUri, string userName, string password, string domain = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	domain	The domain.

Returns

Type	Description
HttpClientHandler	HttpClientHandler instance which uses the specified credentials.

GetHostId()

Gets the host identifier.

public abstract string GetHostId()

Returns

Type	Description
string	A hash identifying the machine or device the application is running.

GetRequestTimeout()

Gets the request timeout.

public abstract int? GetRequestTimeout()

Returns

Type	Description
int?	The timeout in milliseconds for a request or null if the request timeout is not explicitely set.