![]() |
LicenseSpring .Net SDK 7.32.1
Easily add Software Licensing to your application
|
Configuration of the SDK. More...
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 | 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 | Hostname [get, set] |
Hostname. | |
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. | |
![]() |
Configuration of the SDK.
LicenseSpring.Configuration.Configuration | ( | string | apiKey, |
string | sharedKey, | ||
string | productCode, | ||
string | appName, | ||
string | appVersion, | ||
ExtendedOptions | extendedOptions = null |
||
) |
Configuration constructor.
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 |
System.ArgumentException | Thrown in case of empty API or Shared keys, invalid prouct code |
LicenseSpring.ConfigurationException | Thrown in case of invalid proxy settings |
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.
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. |
System.ArgumentException | Thrown in case of empty client id, secret, or invalid prouct code. |
LicenseSpring.ConfigurationException | Thrown in case of invalid proxy settings. |
|
static |
Check if application is running in Mono runtime.
|
getset |
Public key for air gap activation acquired from LicenseSpring.
Implements LicenseSpring.IConfiguration.
|
getset |
API key acquired from LicenseSpring.
Implements LicenseSpring.IConfiguration.
|
getset |
Your application name.
Implements LicenseSpring.IConfiguration.
|
getset |
Your application version.
Implements LicenseSpring.IConfiguration.
|
get |
OAuth client id.
Implements LicenseSpring.IConfiguration.
|
get |
OAuth client secret.
Implements LicenseSpring.IConfiguration.
|
get |
Whether SDK should send hostname, local IP and MAC to the platfrom.
Implements LicenseSpring.IConfiguration.
|
getset |
CryptoProvider of the configuration.The SDK uses it internally and you can also use it in your codebase.
Implements LicenseSpring.IConfiguration.
|
getset |
Customer group(account) code that is required for SSO.Meaningful for user-based auth only.
Implements LicenseSpring.IConfiguration.
|
get |
In case VM detection enabled returns hypervisor name.
Implements LicenseSpring.IConfiguration.
|
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.
|
get |
Grace period.In hours, default is 48 hours.
Implements LicenseSpring.IConfiguration.
|
get |
Hardware ID of the device.
Implements LicenseSpring.IConfiguration.
|
getset |
Hostname.
Implements LicenseSpring.IConfiguration.
|
get |
Whether SDK should log licensing activity to file.
Implements LicenseSpring.IConfiguration.
|
get |
Returns true if OAuth constructor was used to instantiate the configuration object, false if standard api/shared key pair was used.
Implements LicenseSpring.IConfiguration.
|
get |
In case VM detection enabled returns true if app currently running in virtualized environment.
Implements LicenseSpring.IConfiguration.
|
get |
Whether detection of Virtual machines is enabled.
Implements LicenseSpring.IConfiguration.
|
get |
LicenseSpring API version.Note this is the API version that SDK uses.
Implements LicenseSpring.IConfiguration.
|
getset |
Local IP address.
Implements LicenseSpring.IConfiguration.
|
getset |
MAC address.
Implements LicenseSpring.IConfiguration.
|
getset |
Get network operation timeout in seconds, 0 means use system defaults.
Implements LicenseSpring.IConfiguration.
|
getset |
OS Version.
Implements LicenseSpring.IConfiguration.
|
getset |
Product code acquired from LicenseSpring.
Implements LicenseSpring.IConfiguration.
|
getset |
Get proxy configuration.
Implements LicenseSpring.IConfiguration.
|
get |
LicenseSpring SDK version.
Implements LicenseSpring.IConfiguration.
|
getset |
Shared or Management key acquired from LicenseSpring.
Implements LicenseSpring.IConfiguration.