Configuration of the SDK. More...

Inheritance diagram for LicenseSpring.Configuration:

Public Member Functions
	Configuration ()
	Configuration default constructor, creates invalid configuration with empty Shared/API keys and OAuth credentials.

	Configuration (OAuthCredentials oAuthCredentials, string productCode, string appName, string appVersion, ExtendedOptions extendedOptions=null)
	Configuration constructor used when initializing the LicenseManager with OAuth authentication method.

	Configuration (string apiKey, string sharedKey, string productCode, string appName, string appVersion, ExtendedOptions extendedOptions=null)
	Configuration constructor.

Static Public Member Functions
static bool	IsMonoRuntime ()
	Check if application is running in Mono runtime.

Properties
string	AirGapPublicKey `[get, set]`
	Public key for air gap activation acquired from LicenseSpring.

string	ApiKey `[get, set]`
	API key acquired from LicenseSpring.

string	AppName `[get, set]`
	Your application name.

string	AppVersion `[get, set]`
	Your application version.

string	CertificateChain `[get]`
	Certificate chain used for verifying LicenseSpring response signatures.

string	ClientId `[get]`
	OAuth client id.

string	ClientSecret `[get]`
	OAuth client secret.

bool	CollectNetworkInfo `[get]`
	Whether SDK should send hostname, local IP and MAC to the platfrom.

ICryptoProvider	CryptoProvider `[get, set]`
	CryptoProvider of the configuration.The SDK uses it internally and you can also use it in your codebase.

string	CustomerAccount `[get, set]`
	Customer group(account) code that is required for SSO.Meaningful for user-based auth only.

string	DetectedVMName `[get]`
	In case VM detection enabled returns hypervisor name.

ExtendedOptions	ExtendedOptions `[get, set]`
	Extended options of the configuration.Attention: changing some fields of the extended options indirectly won't take effect. For example `config.ExtendedOptions.LicenseFilePath = "..."` will not work.

uint	GracePeriod `[get]`
	Grace period.In hours, default is 48 hours.

string	HardwareID `[get]`
	Hardware ID of the device.

string	HardwareKeyPin `[get]`
	Returns the YubiKey PIN configured via ExtendedOptions or empty string if YubiKey is not configured.

string	HardwareKeyTargetSerial `[get]`
	Returns the target YubiKey serial number configured via ExtendedOptions or empty string if YubiKey is not configured.

string	Hostname `[get, set]`
	Hostname.

bool	IsHardwareKeyEnabled `[get]`
	Returns true if requests should be sent with a hardware key signature. See ExtendedOptions.IsHardwareKeyEnabled for more details.

bool	IsLoggingEnabled `[get]`
	Whether SDK should log licensing activity to file.

bool	IsOAuth = false `[get]`
	Returns true if OAuth constructor was used to instantiate the configuration object, false if standard api/shared key pair was used.

bool	IsVM `[get]`
	In case VM detection enabled returns true if app currently running in virtualized environment.

bool	IsVMDetectionEnabled `[get]`
	Whether detection of Virtual machines is enabled.

uint	LicenseSpringAPIVersion `[get]`
	LicenseSpring API version.Note this is the API version that SDK uses.

string	LocalIp `[get, set]`
	Local IP address.

string	MACAddress `[get, set]`
	MAC address.

int	NetworkTimeout `[get, set]`
	Get network operation timeout in seconds, 0 means use system defaults.

string	OSVersion `[get, set]`
	OS Version.

string	ProductCode `[get, set]`
	Product code acquired from LicenseSpring.

ProxySettings	Proxy `[get, set]`
	Get proxy configuration.

string	SdkVersion `[get]`
	LicenseSpring SDK version.

string	SharedKey `[get, set]`
	Shared or Management key acquired from LicenseSpring.

Properties inherited from LicenseSpring.IConfiguration

Detailed Description

Configuration of the SDK.

Constructor & Destructor Documentation

◆ Configuration() [1/2]

LicenseSpring.Configuration.Configuration	(	string	apiKey,
		string	sharedKey,
		string	productCode,
		string	appName,
		string	appVersion,
		ExtendedOptions	extendedOptions = `null`
	)

Configuration constructor.

Parameters

apiKey	Your API key that you got from LicenseSpring platform
sharedKey	Your Shared key that you got from LicenseSpring platform
productCode	Your product code
appName	Your application name
appVersion	Your application version
extendedOptions	Instance of the ExtendedOptions, optionally

Exceptions

System.ArgumentException	Thrown in case of empty API or Shared keys, invalid prouct code
LicenseSpring.ConfigurationException	Thrown in case of invalid proxy settings

◆ Configuration() [2/2]

LicenseSpring.Configuration.Configuration	(	OAuthCredentials	oAuthCredentials,
		string	productCode,
		string	appName,
		string	appVersion,
		ExtendedOptions	extendedOptions = `null`
	)

Configuration constructor used when initializing the LicenseManager with OAuth authentication method.

WARNING: you must provide oAuthCredentials.CryptoProviderKey if you intend to use the default sdk cryptography.

Parameters

oAuthCredentials	Container for OAuth client id and secret.
productCode	Your product code.
appName	Your application name.
appVersion	Your application version.
extendedOptions	Instance of the ExtendedOptions, optional.

Exceptions

System.ArgumentException	Thrown in case of empty client id, secret, or invalid prouct code.
LicenseSpring.ConfigurationException	Thrown in case of invalid proxy settings.

Member Function Documentation

◆ IsMonoRuntime()

static bool LicenseSpring.Configuration.IsMonoRuntime ( )

static

Check if application is running in Mono runtime.

Returns: True if Mono runtime detected and false otherwise

Property Documentation

◆ AirGapPublicKey

string LicenseSpring.Configuration.AirGapPublicKey

getset

Public key for air gap activation acquired from LicenseSpring.

Implements LicenseSpring.IConfiguration.

◆ ApiKey

string LicenseSpring.Configuration.ApiKey

getset

API key acquired from LicenseSpring.

Implements LicenseSpring.IConfiguration.

◆ AppName

string LicenseSpring.Configuration.AppName

getset

Your application name.

Implements LicenseSpring.IConfiguration.

◆ AppVersion

string LicenseSpring.Configuration.AppVersion

getset

Your application version.

Implements LicenseSpring.IConfiguration.

◆ CertificateChain

string LicenseSpring.Configuration.CertificateChain

get

Certificate chain used for verifying LicenseSpring response signatures.

Implements LicenseSpring.IConfiguration.

◆ ClientId

string LicenseSpring.Configuration.ClientId

get

OAuth client id.

Implements LicenseSpring.IConfiguration.

◆ ClientSecret

string LicenseSpring.Configuration.ClientSecret

get

OAuth client secret.

Implements LicenseSpring.IConfiguration.

◆ CollectNetworkInfo

bool LicenseSpring.Configuration.CollectNetworkInfo

get

Whether SDK should send hostname, local IP and MAC to the platfrom.

Implements LicenseSpring.IConfiguration.

◆ CryptoProvider

ICryptoProvider LicenseSpring.Configuration.CryptoProvider

getset

CryptoProvider of the configuration.The SDK uses it internally and you can also use it in your codebase.

Implements LicenseSpring.IConfiguration.

◆ CustomerAccount

string LicenseSpring.Configuration.CustomerAccount

getset

Customer group(account) code that is required for SSO.Meaningful for user-based auth only.

Implements LicenseSpring.IConfiguration.

◆ DetectedVMName

string LicenseSpring.Configuration.DetectedVMName

get

In case VM detection enabled returns hypervisor name.

Implements LicenseSpring.IConfiguration.

◆ ExtendedOptions

ExtendedOptions LicenseSpring.Configuration.ExtendedOptions

getset

Extended options of the configuration.Attention: changing some fields of the extended options indirectly won't take effect. For example config.ExtendedOptions.LicenseFilePath = "..." will not work.

Implements LicenseSpring.IConfiguration.