Click or drag to resize
Pdftools logo

Sdk Properties

The Sdk type exposes the following members.

Properties
 NameDescription
Public propertyStatic memberHttpClientHandler

The default handler for communication to remote servers

This instance is used wherever there is no dedicated HTTP client handler parameter.
Public propertyStatic memberLicenseInfoSnapshot

A new snapshot is created whenever this property is accessed.

Note: Initialize(String, String) must be called before accessing license information. Otherwise, the license is considered invalid.

Public propertyStatic memberLicensingService

Licensing service to use for all licensing requests

This property is relevant only for page-based licenses and is used to set the Licensing Gateway Service.

The default is "https://licensing.pdf-tools.com/api/v1/licenses/" for the online Pdftools Licensing Service. If you plan to use the Licensing Gateway Service instead of the Pdftools Licensing Service, the property’s value must be a URI with the following elements:

http[s]://[‹user›[:‹password›]@]‹host›[:‹port›]

Where:

  • http/https: Protocol for connection to the Licensing Gateway Service.
  • ‹user›:‹password› (optional): Credentials for connection to the Licensing Gateway Service (basic authorization).
  • ‹host›: Hostname of the Licensing Gateway Service.
  • ‹port›: Port for connection to the Licensing Gateway Service.

Example: "http://localhost:9999"

Public propertyStatic memberProducerFullName

The producer string that is set within the metadata of PDF output documents

The producer string depends on the license key and producer suffix set in Initialize(String, String).
Public propertyStatic memberProxy

Proxy to use for all communication to remote servers

The SDK can use a proxy for all HTTP and HTTPS communication.

The default is , i.e. no proxy is used. Otherwise the property’s value must be a URI with the following elements:

http[s]://[‹user›[:‹password›]@]‹host›[:‹port›]

Where:

  • http/https: Protocol for connection to proxy.
  • ‹user›:‹password› (optional): Credentials for connection to proxy (basic authorization).
  • ‹host›: Hostname of proxy.
  • ‹port›: Port for connection to proxy.

Example: "http://myproxy:8080"

For SSL/TLS connections, e.g. to a signature service, the proxy must allow the HTTP CONNECT request to the remote server.

Public propertyStatic memberUsageTracking

Property denoting whether the usage tracking is enabled or disabled

The SDK is allowed to track usage when this property is set to . The collected data includes only non-sensitive information, such as the features used, the document type, the number of pages, etc.

The default is , i.e. usage tracking is enabled.

Public propertyStatic memberVersion

The version of the SDK

Top
See Also