Class PlatformClientConfiguration

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

Inheritance

System.Object

PlatformClientConfiguration

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public abstract class PlatformClientConfiguration

Properties

DefaultProductInfoHeader

Gets or sets the default product information header.

Declaration

public static ProductInfoHeaderValue DefaultProductInfoHeader { get; set; }

Property Value

Type	Description
System.Net.Http.Headers.ProductInfoHeaderValue	The default product information header.

Methods

AddProductInfoHeaderValueOfExecutingApplication(HttpHeaderValueCollection<ProductInfoHeaderValue>)

Gets the product information header value of executing application.

Declaration

public abstract void AddProductInfoHeaderValueOfExecutingApplication(HttpHeaderValueCollection<ProductInfoHeaderValue> userAgent)

Parameters

Type	Name	Description
System.Net.Http.Headers.HttpHeaderValueCollection<System.Net.Http.Headers.ProductInfoHeaderValue>	userAgent

CreateDefaultCircuitBreakerPolicyOptions()

Creates the default circuit breaker policy options.

Declaration

public abstract CircuitBreakerPolicyOptions CreateDefaultCircuitBreakerPolicyOptions()

Returns

Type	Description
CircuitBreakerPolicyOptions	The default circuit breaker policy options.

CreateDefaultHttpMessageHandler()

Creates the default HTTP message handler.

Declaration

public abstract HttpMessageHandler CreateDefaultHttpMessageHandler()

Returns

Type	Description
System.Net.Http.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.

Declaration

public abstract RetryPolicyOptions CreateDefaultRetryPolicyOptions()

Returns

Type	Description
RetryPolicyOptions	The default retry policy options.

CreateHandlerForNTLMAuthentication(ICredentials)

Creates a System.Net.Http.HttpClientHandler instance for handling NTLM authentication.

Declaration

public abstract HttpClientHandler CreateHandlerForNTLMAuthentication(ICredentials credentials)

Parameters

Type	Name	Description
System.Net.ICredentials	credentials	The credentials.

Returns

Type	Description
System.Net.Http.HttpClientHandler	System.Net.Http.HttpClientHandler instance which uses the specified credentials.

CreateHandlerForNTLMAuthentication(Uri, String, String, String)

Creates a System.Net.Http.HttpClientHandler instance for handling NTLM authentication.

Declaration

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

Parameters

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

Returns

Type	Description
System.Net.Http.HttpClientHandler	System.Net.Http.HttpClientHandler instance which uses the specified credentials.

GetHostId()

Gets the host identifier.

Declaration

public abstract string GetHostId()

Returns

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

GetRequestTimeout()

Gets the request timeout.

Declaration

public abstract int? GetRequestTimeout()

Returns

Type	Description
System.Nullable<System.Int32>	The timeout in milliseconds for a request or null if the request timeout is not explicitely set.