| LicenseSpring .Net SDK 7.42.0 Easily add Software Licensing to your application

Loading...
Searching...
No Matches
Properties | List of all members
LicenseSpring.IConfiguration Interface Reference

Configuration interface. More...

Inheritance diagram for LicenseSpring.IConfiguration:

## 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.
string | CustomerAccount`[get, set]`
| Customer group(account) code that is required for SSO.
string | DetectedVMName`[get]`
| In case VM detection enabled returns hypervisor name.
ExtendedOptions | ExtendedOptions`[get, set]`
| Extended options of the configuration.
uint | GracePeriod`[get]`
| Grace period.
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`[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.
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.

## Detailed Description

Configuration interface.

## Property Documentation

## ◆ AirGapPublicKey

string LicenseSpring.IConfiguration.AirGapPublicKey
| get set

Public key for air gap activation acquired from LicenseSpring.

Implemented in LicenseSpring.Configuration.

## ◆ ApiKey

string LicenseSpring.IConfiguration.ApiKey
| get set

API key acquired from LicenseSpring.

Implemented in LicenseSpring.Configuration.

## ◆ AppName

string LicenseSpring.IConfiguration.AppName
| get set

Your application name.

Implemented in LicenseSpring.Configuration.

## ◆ AppVersion

string LicenseSpring.IConfiguration.AppVersion
| get set

Your application version.

Implemented in LicenseSpring.Configuration.

## ◆ CertificateChain

string LicenseSpring.IConfiguration.CertificateChain
| get

Certificate chain used for verifying LicenseSpring response signatures.

Implemented in LicenseSpring.Configuration.

## ◆ ClientId

string LicenseSpring.IConfiguration.ClientId
| get

OAuth client id.

Implemented in LicenseSpring.Configuration.

## ◆ ClientSecret

string LicenseSpring.IConfiguration.ClientSecret
| get

OAuth client secret.

Implemented in LicenseSpring.Configuration.

## ◆ CollectNetworkInfo

bool LicenseSpring.IConfiguration.CollectNetworkInfo
| get

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

Implemented in LicenseSpring.Configuration.

## ◆ CryptoProvider

ICryptoProvider LicenseSpring.IConfiguration.CryptoProvider
| get set

CryptoProvider of the configuration.

The SDK uses it internally and you can also use it in your codebase.

Implemented in LicenseSpring.Configuration.

## ◆ CustomerAccount

string LicenseSpring.IConfiguration.CustomerAccount
| get set

Customer group(account) code that is required for SSO.

Meaningful for user-based auth only.

Implemented in LicenseSpring.Configuration.

## ◆ DetectedVMName

string LicenseSpring.IConfiguration.DetectedVMName
| get

In case VM detection enabled returns hypervisor name.

Implemented in LicenseSpring.Configuration.

## ◆ ExtendedOptions

ExtendedOptions LicenseSpring.IConfiguration.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.

If you need to adjust some of the options please set new ExtendedOptions explicitly.

Implemented in LicenseSpring.Configuration.

## ◆ GracePeriod

uint LicenseSpring.IConfiguration.GracePeriod
| get

Grace period.

In hours, default is 48 hours.

Implemented in LicenseSpring.Configuration.

## ◆ HardwareID

string LicenseSpring.IConfiguration.HardwareID
| get

Hardware ID of the device.

Implemented in LicenseSpring.Configuration.

## ◆ HardwareKeyPin

string LicenseSpring.IConfiguration.HardwareKeyPin
| get

Returns the YubiKey PIN configured via ExtendedOptions or empty string if YubiKey is not configured.

Implemented in LicenseSpring.Configuration.

## ◆ HardwareKeyTargetSerial

string LicenseSpring.IConfiguration.HardwareKeyTargetSerial
| get

Returns the target YubiKey serial number configured via ExtendedOptions or empty string if YubiKey is not configured.

Implemented in LicenseSpring.Configuration.

## ◆ Hostname

string LicenseSpring.IConfiguration.Hostname
| get set

Hostname.

Implemented in LicenseSpring.Configuration.

## ◆ IsHardwareKeyEnabled

bool LicenseSpring.IConfiguration.IsHardwareKeyEnabled
| get

Returns true if requests should be sent with a hardware key signature. See ExtendedOptions.IsHardwareKeyEnabled for more details.

Implemented in LicenseSpring.Configuration.

## ◆ IsLoggingEnabled

bool LicenseSpring.IConfiguration.IsLoggingEnabled
| get

Whether SDK should log licensing activity to file.

Implemented in LicenseSpring.Configuration.

## ◆ IsOAuth

bool LicenseSpring.IConfiguration.IsOAuth
| get

Returns true if OAuth constructor was used to instantiate the configuration object, false if standard api/shared key pair was used.

Implemented in LicenseSpring.Configuration.

## ◆ IsVM

bool LicenseSpring.IConfiguration.IsVM
| get

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

Implemented in LicenseSpring.Configuration.

## ◆ IsVMDetectionEnabled

bool LicenseSpring.IConfiguration.IsVMDetectionEnabled
| get

Whether detection of Virtual machines is enabled.

Implemented in LicenseSpring.Configuration.

## ◆ LicenseSpringAPIVersion

uint LicenseSpring.IConfiguration.LicenseSpringAPIVersion
| get

LicenseSpring API version.

Note this is the API version that SDK uses.

Implemented in LicenseSpring.Configuration.

## ◆ LocalIp

string LicenseSpring.IConfiguration.LocalIp
| get set

Local IP address.

Implemented in LicenseSpring.Configuration.

## ◆ MACAddress

string LicenseSpring.IConfiguration.MACAddress
| get set

MAC address.

Implemented in LicenseSpring.Configuration.

## ◆ NetworkTimeout

int LicenseSpring.IConfiguration.NetworkTimeout
| get set

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

Implemented in LicenseSpring.Configuration.

## ◆ OSVersion

string LicenseSpring.IConfiguration.OSVersion
| get set

OS Version.

Implemented in LicenseSpring.Configuration.

## ◆ ProductCode

string LicenseSpring.IConfiguration.ProductCode
| get set

Product code acquired from LicenseSpring.

Implemented in LicenseSpring.Configuration.

## ◆ Proxy

ProxySettings LicenseSpring.IConfiguration.Proxy
| get set

Get proxy configuration.

Implemented in LicenseSpring.Configuration.

## ◆ SdkVersion

string LicenseSpring.IConfiguration.SdkVersion
| get

LicenseSpring SDK version.

Implemented in LicenseSpring.Configuration.

## ◆ SharedKey

string LicenseSpring.IConfiguration.SharedKey
| get set

Shared or Management key acquired from LicenseSpring.

Implemented in LicenseSpring.Configuration.

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

- IConfiguration.cs