LicenseSpring .Net SDK 7.22.0
Easily add Software Licensing to your application
LicenseSpring.Configuration Class Reference

Configuration of the SDK More...

Inheritance diagram for LicenseSpring.Configuration:
LicenseSpring.IConfiguration

Public Member Functions

 Configuration ()
 Configuration default constructor, creates invalid configuration with empty Shared and API keys
 
 Configuration (string apiKey, string sharedKey, string productCode, string appName, string appVersion, ExtendedOptions extendedOptions=null)
 Configuration constructor More...
 

Static Public Member Functions

static bool IsMonoRuntime ()
 Check if application is running in Mono runtime More...
 

Properties

string AirGapPublicKey [get, set]
 Public key for air gap activation acquired from LicenseSpring More...
 
string ApiKey [get, set]
 API key acquired from LicenseSpring More...
 
string AppName [get, set]
 Your application name More...
 
string AppVersion [get, set]
 Your application version More...
 
bool CollectNetworkInfo [get]
 Whether SDK should send hostname, local IP and MAC to the platfrom More...
 
ICryptoProvider CryptoProvider [get, set]
 CryptoProvider of the configuration More...
 
string CustomerAccount [get, set]
 Customer group(account) code that is required for SSO More...
 
string DetectedVMName [get]
 In case VM detection enabled returns hypervisor name More...
 
ExtendedOptions ExtendedOptions [get, set]
 Extended options of the configuration More...
 
uint GracePeriod [get]
 Grace period More...
 
string HardwareID [get]
 Hardware ID of the device More...
 
string Hostname [get, set]
 Hostname More...
 
bool IsLoggingEnabled [get]
 Whether SDK should log licensing activity to file More...
 
bool IsVM [get]
 In case VM detection enabled returns true if app currently running in virtualized environment More...
 
bool IsVMDetectionEnabled [get]
 Whether detection of Virtual machines is enabled More...
 
uint LicenseSpringAPIVersion [get]
 LicenseSpring API version More...
 
string LocalIp [get, set]
 Local IP address More...
 
string MACAddress [get, set]
 MAC address More...
 
int NetworkTimeout [get, set]
 Get network operation timeout in seconds, 0 means use system defaults More...
 
string OSVersion [get, set]
 OS Version More...
 
string ProductCode [get, set]
 Product code acquired from LicenseSpring More...
 
ProxySettings Proxy [get, set]
 Get proxy configuration More...
 
string SdkVersion [get]
 LicenseSpring SDK version More...
 
string SharedKey [get, set]
 Shared or Management key acquired from LicenseSpring More...
 
- Properties inherited from LicenseSpring.IConfiguration
string AirGapPublicKey [get, set]
 Public key for air gap activation acquired from LicenseSpring More...
 
string ApiKey [get, set]
 API key acquired from LicenseSpring More...
 
string AppName [get, set]
 Your application name More...
 
string AppVersion [get, set]
 Your application version More...
 
bool CollectNetworkInfo [get]
 Whether SDK should send hostname, local IP and MAC to the platfrom More...
 
ICryptoProvider CryptoProvider [get, set]
 CryptoProvider of the configuration More...
 
string CustomerAccount [get, set]
 Customer group(account) code that is required for SSO More...
 
string DetectedVMName [get]
 In case VM detection enabled returns hypervisor name More...
 
ExtendedOptions ExtendedOptions [get, set]
 Extended options of the configuration More...
 
uint GracePeriod [get]
 Grace period More...
 
string HardwareID [get]
 Hardware ID of the device More...
 
string Hostname [get, set]
 Hostname More...
 
bool IsLoggingEnabled [get]
 Whether SDK should log licensing activity to file More...
 
bool IsVM [get]
 In case VM detection enabled returns true if app currently running in virtualized environment More...
 
bool IsVMDetectionEnabled [get]
 Whether detection of Virtual machines is enabled More...
 
uint LicenseSpringAPIVersion [get]
 LicenseSpring API version More...
 
string LocalIp [get, set]
 Local IP address More...
 
string MACAddress [get, set]
 MAC address More...
 
int NetworkTimeout [get, set]
 Get network operation timeout in seconds, 0 means use system defaults More...
 
string OSVersion [get, set]
 OS Version More...
 
string ProductCode [get, set]
 Product code acquired from LicenseSpring More...
 
ProxySettings Proxy [get, set]
 Get proxy configuration More...
 
string SdkVersion [get]
 LicenseSpring SDK version More...
 
string SharedKey [get, set]
 Shared or Management key acquired from LicenseSpring More...
 

Detailed Description

Configuration of the SDK

Constructor & Destructor Documentation

◆ Configuration()

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

Configuration constructor

Parameters
apiKeyYour API key that you got from LicenseSpring platform
sharedKeyYour Shared key that you got from LicenseSpring platform
productCodeYour product code
appNameYour application name
appVersionYour application version
extendedOptionsInstance of the ExtendedOptions, optionally
Exceptions
System.ArgumentExceptionThrown in case of empty API or Shared keys, invalid prouct code
LicenseSpring.ConfigurationExceptionThrown 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.

◆ 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

Implements LicenseSpring.IConfiguration.

◆ CustomerAccount

string LicenseSpring.Configuration.CustomerAccount
getset

Customer group(account) code that is required for SSO

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

Implements LicenseSpring.IConfiguration.

◆ GracePeriod

uint LicenseSpring.Configuration.GracePeriod
get

Grace period

Implements LicenseSpring.IConfiguration.

◆ HardwareID

string LicenseSpring.Configuration.HardwareID
get

Hardware ID of the device

Implements LicenseSpring.IConfiguration.

◆ Hostname

string LicenseSpring.Configuration.Hostname
getset

Hostname

Implements LicenseSpring.IConfiguration.

◆ IsLoggingEnabled

bool LicenseSpring.Configuration.IsLoggingEnabled
get

Whether SDK should log licensing activity to file

Implements LicenseSpring.IConfiguration.

◆ IsVM

bool LicenseSpring.Configuration.IsVM
get

In case VM detection enabled returns true if app currently running in virtualized environment

Implements LicenseSpring.IConfiguration.

◆ IsVMDetectionEnabled

bool LicenseSpring.Configuration.IsVMDetectionEnabled
get

Whether detection of Virtual machines is enabled

Implements LicenseSpring.IConfiguration.

◆ LicenseSpringAPIVersion

uint LicenseSpring.Configuration.LicenseSpringAPIVersion
get

◆ LocalIp

string LicenseSpring.Configuration.LocalIp
getset

Local IP address

Implements LicenseSpring.IConfiguration.

◆ MACAddress

string LicenseSpring.Configuration.MACAddress
getset

MAC address

Implements LicenseSpring.IConfiguration.

◆ NetworkTimeout

int LicenseSpring.Configuration.NetworkTimeout
getset

Get network operation timeout in seconds, 0 means use system defaults

Implements LicenseSpring.IConfiguration.

◆ OSVersion

string LicenseSpring.Configuration.OSVersion
getset

OS Version

Implements LicenseSpring.IConfiguration.

◆ ProductCode

string LicenseSpring.Configuration.ProductCode
getset

Product code acquired from LicenseSpring

Implements LicenseSpring.IConfiguration.

◆ Proxy

ProxySettings LicenseSpring.Configuration.Proxy
getset

Get proxy configuration

Implements LicenseSpring.IConfiguration.

◆ SdkVersion

string LicenseSpring.Configuration.SdkVersion
get

◆ SharedKey

string LicenseSpring.Configuration.SharedKey
getset

Shared or Management key acquired from LicenseSpring

Implements LicenseSpring.IConfiguration.


The documentation for this class was generated from the following file: