Class MetaClient.Builder

Instantiates a new IMetaClient instance. This type is not thread safe. Builder instances can be reused and will create identical IMetaClient instances.

Inheritance
Object
MetaClient.Builder
Inherited Members
Namespace: PKWARE.Smartcrypt.MetaClient
Assembly: MetaClient.dll
Syntax
public sealed class Builder

Properties

AppName

The name of the current application. In some cases this will be used to activate certains modes or logic. Use null to indicate that the application name is unimportant.

Declaration
[CanBeNull]
public string AppName { get; set; }
Property Value
Type Description
String
See Also

AppVersion

The version of the current application. This is used primarily for logging. Use null to indicate that the application version is unimportant.

Declaration
[CanBeNull]
public string AppVersion { get; set; }
Property Value
Type Description
String

CryptoProvider

Specifies the ICryptoProvider to use.

Declaration
[CanBeNull]
public ICryptoProvider CryptoProvider { get; set; }
Property Value
Type Description
ICryptoProvider

DataCenter

Declaration
[CanBeNull]
public string DataCenter { get; set; }
Property Value
Type Description
String

DeviceName

Device name, defaults to MachineName.

Declaration
[CanBeNull]
public string DeviceName { get; set; }
Property Value
Type Description
String

DeviceUniqueId

A unique fingerprint for this device, default value is provided on Windows, Linux and macOS.

Declaration
[CanBeNull]
public string DeviceUniqueId { get; set; }
Property Value
Type Description
String

Logger

Declaration
[CanBeNull]
public Logger Logger { get; set; }
Property Value
Type Description
Logger

NetworkRequestProcessor

If null, the default processor will be used. The default is sufficient in most production environments and places emphasis on connection security.

Declaration
[CanBeNull]
public INetworkRequestProcessor NetworkRequestProcessor { get; set; }
Property Value
Type Description
INetworkRequestProcessor

Platform

Operating system platform, defaults to Windows, Linux or macOS as appropriate.

Declaration
[CanBeNull]
public Platform Platform { get; set; }
Property Value
Type Description
Platform

PlatformSubtype

Operating system architecture. For example, ARMv7 for Android, or x64 for Windows.

Declaration
[CanBeNull]
public string PlatformSubtype { get; set; }
Property Value
Type Description
String

PlatformVersion

Operating system version. For example, 10.12.6 for macOS Sierra, or 16299.192 for Windows.

Declaration
[CanBeNull]
public string PlatformVersion { get; set; }
Property Value
Type Description
String

Scopes

Scopes are used to limit which AssetFeatures apply to an instance of MetaClient. For example, one could have an asset feature apply only to Android by defining a scope named android. android would be passed to this method to indicate that this software supports that scope.

Declaration
public IEnumerable<string> Scopes
{

    [NotNull]

    get;

    [CanBeNull]

    set;

}
Property Value
Type Description
IEnumerable<String>

Server

URL of the server to communicate with.

Declaration
[CanBeNull]
public string Server { get; set; }
Property Value
Type Description
String

Methods

Build()

Declaration
public IMetaClient Build()
Returns
Type Description
IMetaClient