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

License class, implements ILicense interface. More...

Inheritance diagram for LicenseSpring.License:
LicenseSpring.ILicense

Public Member Functions

void AddDeviceVariable (DeviceVariable variable)
 Add new or update existing device variable to license data More...
 
void AddDeviceVariable (string name, string value)
 Add new or update existing device variable to license data More...
 
void AddDeviceVariables (DeviceVariable[] variables)
 Add new or update existing device variables to license data More...
 
void Borrow (DateTime endDateTime)
 Borrow floating license till provided end date time More...
 
void Borrow (string borrowEndDateTime=null)
 Borrow floating license till provided end date time string More...
 
void Borrow (uint hours, uint days=0)
 Borrow floating license for provided time interval More...
 
bool CanBorrow ()
 Is this license can be borrowed or not More...
 
bool ChangePassword (string password, string newPassword)
 Change password for user-based license More...
 
InstallationFile Check (IInstallationFileOptions options=null)
 Check current license for validity on the LicenseSpring platform More...
 
ConsumptionPeriod ConsumptionPeriod ()
 Period of time after which consumption is reset. More...
 
CustomField[] CustomFields ()
 Custom data fields available for the license More...
 
int DaysPassedSinceLastCheck ()
 How many days passed since last online check More...
 
int DaysRemaining ()
 How many days remaining till license expires in current time zone More...
 
int DaysRemainingUTC ()
 How many days remaining till license expires More...
 
bool Deactivate (bool removeLocalData=false)
 Deactivate current license More...
 
void DeactivateAirGap (string code)
 Verify Confirmation code and deactivate air gap license More...
 
string DeactivateOffline (string deactivationRequestFile=null)
 Deactivate license locally and create offline deactivation file request More...
 
DeviceVariable DeviceVariable (string name)
 Get device variable by name More...
 
string DeviceVariableValue (string name)
 Get device variable value by name More...
 
LicenseFeature Feature (string featureCode)
 Get product (license) feature by feature code More...
 
LicenseFeature[] Features ()
 Product features available for the license More...
 
string FloatingClientId ()
 Floating user (client) or instance id More...
 
DateTime FloatingEndDateTime ()
 Floating license validity end date time in local time zone More...
 
DateTime FloatingEndDateTimeUtc ()
 Floating license validity end date time in UTC More...
 
uint FloatingSlotsCount ()
 Overall Floating slots or users count. Amount of simultaneous users (instances) allowed for this license. More...
 
uint FloatingSlotsInUse ()
 Current floatings slots in use count, including this user (instance). More...
 
uint FloatingTimeout ()
 Floating timeout in minutes More...
 
string GetAirGapDeactivationCode (string initializationCode)
 Get air gap Deactivation code. More...
 
DeviceVariable[] GetDeviceVariables (bool getFromBackend=false)
 Get device variables from the local license or from the backend More...
 
ProductDetails GetProductDetails ()
 Get information about a product this license belongs to More...
 
DateTime GracePeriodEndDateTime ()
 Getter for grace period end date time in local time More...
 
DateTime GracePeriodEndDateTimeUTC ()
 Getter for grace period end date time in UTC More...
 
double GracePeriodHoursRemaining ()
 How many hours remaining till grace period ends More...
 
LicenseID Id ()
 License ID More...
 
bool IsAirGapped ()
 Is this license was activated using air-gap activation More...
 
bool IsBorrowed ()
 Checker for whether the license is borrowed More...
 
bool IsConsumptionOverageAllowed ()
 Is it allowed to exceed consumption for this license. More...
 
bool IsConsumptionResetEnabled ()
 Indicates whether consumption resets after a certain period of time. More...
 
bool IsDeviceTransferAllowed ()
 Checks if license can be transfered between devices More...
 
bool IsDeviceTransferLimited ()
 Checks if the license allows only limited number of transfers between devices More...
 
bool IsExpired ()
 Is license expired More...
 
bool IsFloating ()
 Is this license floating More...
 
bool IsGracePeriodStarted ()
 Check if grace period started for a license More...
 
bool IsMaintenancePeriodExpired ()
 Is maintenance period expired More...
 
bool IsOfflineActivated ()
 Is this license was activated offline More...
 
bool IsSubscriptionGracePeriodStarted ()
 Check if grace period started for subscription license More...
 
bool IsTrial ()
 Is this license trial More...
 
bool IsUnlimitedConsumptionAllowed ()
 Is unlimited consumption allowed for the license More...
 
bool IsValid ()
 Fast and simple way to check current local state of the license.Equivalent to Status().IsOk() and !IsExpired() More...
 
string Key ()
 License key More...
 
DateTime LastCheckDate ()
 The DateTime of the last sync with the LicenseSpring platform More...
 
DateTime LastCheckDateUTC ()
 The DateTime of the last sync with the LicenseSpring platform More...
 
 License ()
 Default constructor, creates invalid license
 
LicenseUser LicenseUser ()
 License user More...
 
void LocalCheck ()
 Perform check for license validity locally More...
 
int MaintenanceDaysRemaining ()
 How many days remaining till maintenance period expires in current time zone More...
 
DateTime MaintenancePeriod ()
 Maintenance period for the license More...
 
DateTime MaintenancePeriodUTC ()
 Maintenance period for the license More...
 
uint MaxActivations ()
 How many times license can be activated More...
 
uint MaxBorrowTime ()
 Maximum borrowing period in hours More...
 
int MaxConsumption ()
 Maximum consumption of the license More...
 
int MaxConsumptionOverage ()
 Extra amount of consumption that allows to go over MaxConsumption. More...
 
string Metadata ()
 License metadata More...
 
Customer Owner ()
 Gets the information about license owner, commonly it's a person or organization associated with the license More...
 
uint PolicyId ()
 License Policy id More...
 
void Register ()
 Register floating license and occupy floating slot. More...
 
void Release (bool throwExceptions=false)
 Stop license watchdog thread and revoke floating license so other user can use it. More...
 
void ResumeLicenseWatchdog ()
 Restart background thread, you can call this within you callback in order to resume periodic license checks. More...
 
bool SendDeviceVariables ()
 Send current device variables list to the backend (see device variables on the platform)Please note this data will be linked to the current running device ID. More...
 
void SetupLicenseWatchdog (LicenseWatchdogCallback callback, uint timeout=0)
 Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive.This is especially useful for floating licenses, but can be used for any. More...
 
void SetupLicenseWatchdog (LicenseWatchdogSettings settings)
 Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive.This is especially useful for floating licenses, but can be used for any. More...
 
void SetWatchdogTimeout (uint timeout=0)
 Set new timout for license watchdog. More...
 
DateTime StartDate ()
 License start date More...
 
LicenseStatus Status ()
 Method for getting local license status, see LicenseStatus documentation More...
 
void StopLicenseWatchdog ()
 Stops license watchdog background thread. More...
 
uint SubscriptionGracePeriod ()
 Grace period in hours More...
 
bool SyncConsumption (OverageRequest overageRequest=null)
 Sync Consumption license with the LicenseSpring platform More...
 
bool SyncFeatureConsumption (string featureCode=null)
 Sync Consumption feature with the LicenseSpring platform More...
 
uint TimesActivated ()
 How many times license already been activated More...
 
int TotalConsumption ()
 Current total consumption of the license More...
 
uint TransferCount ()
 How many times license has been transferred between devices More...
 
uint TransferLimit ()
 Maximum number of allowed license transfers between devices More...
 
LicenseType Type ()
 Type of license More...
 
void UpdateConsumption (int value=1)
 Increase local consumption counter for consumption license More...
 
void UpdateFeatureConsumption (string featureCode, int value=1)
 Increase local consumption counter for consumption product feature. More...
 
bool UpdateOffline (string path)
 Update license data accordingly to provided file. More...
 
string User ()
 Email of the License user More...
 
DateTime ValidityPeriod ()
 The DateTime until the license is valid More...
 
DateTime ValidityPeriodUTC ()
 The DateTime until the license is valid More...
 
DateTime ValidityWithGracePeriod ()
 The DateTime until the license is valid including grace period More...
 
DateTime ValidityWithGracePeriodUTC ()
 The DateTime until the license is valid including grace period More...
 
void AddDeviceVariable (DeviceVariable variable)
 Add new or update existing device variable to license data More...
 
void AddDeviceVariable (string name, string value)
 Add new or update existing device variable to license data More...
 
void AddDeviceVariables (DeviceVariable[] variables)
 Add new or update existing device variables to license data More...
 
void Borrow (DateTime endDateTime)
 Borrow floating license till provided end date time More...
 
void Borrow (string borrowEndDateTime=null)
 Borrow floating license till provided end date time string More...
 
void Borrow (uint hours, uint days)
 Borrow floating license for provided time interval More...
 
bool CanBorrow ()
 Is this license can be borrowed or not More...
 
bool ChangePassword (string password, string newPassword)
 Change password for user-based license More...
 
InstallationFile Check (IInstallationFileOptions options=null)
 Check current license for validity on the LicenseSpring platform More...
 
ConsumptionPeriod ConsumptionPeriod ()
 Period of time after which consumption is reset. More...
 
CustomField[] CustomFields ()
 Custom data fields available for the license More...
 
int DaysPassedSinceLastCheck ()
 How many days passed since last online check More...
 
int DaysRemaining ()
 How many days remaining till license expires in current time zone More...
 
int DaysRemainingUTC ()
 How many days remaining till license expires More...
 
bool Deactivate (bool removeLocalData=false)
 Deactivate current license More...
 
void DeactivateAirGap (string confirmationCode)
 Verify Confirmation code and deactivate air gap license More...
 
string DeactivateOffline (string deactivationRequestFile=null)
 Deactivate license locally and create offline deactivation file request More...
 
DeviceVariable DeviceVariable (string name)
 Get device variable by name More...
 
string DeviceVariableValue (string name)
 Get device variable value by name More...
 
LicenseFeature Feature (string featureCode)
 Get product (license) feature by feature code More...
 
LicenseFeature[] Features ()
 Product features available for the license More...
 
string FloatingClientId ()
 Floating user (client) or instance id More...
 
DateTime FloatingEndDateTime ()
 Floating license validity end date time in local time zone More...
 
DateTime FloatingEndDateTimeUtc ()
 Floating license validity end date time in UTC More...
 
uint FloatingSlotsCount ()
 Overall Floating slots or users count. Amount of simultaneous users (instances) allowed for this license. More...
 
uint FloatingSlotsInUse ()
 Current floatings slots in use count, including this user (instance). More...
 
uint FloatingTimeout ()
 Floating timeout in minutes More...
 
string GetAirGapDeactivationCode (string initializationCode)
 Get air gap Deactivation code. More...
 
DeviceVariable[] GetDeviceVariables (bool getFromBackend=false)
 Get device variables from the local license or from the backend More...
 
ProductDetails GetProductDetails ()
 Get information about a product this license belongs to More...
 
DateTime GracePeriodEndDateTime ()
 Getter for grace period end date time in local time More...
 
DateTime GracePeriodEndDateTimeUTC ()
 Getter for grace period end date time in UTC More...
 
double GracePeriodHoursRemaining ()
 How many hours remaining till grace period ends More...
 
LicenseID Id ()
 License ID More...
 
bool IsAirGapped ()
 Is this license was activated using air-gap activation More...
 
bool IsBorrowed ()
 Checker for whether the license is borrowed More...
 
bool IsConsumptionOverageAllowed ()
 Is it allowed to exceed consumption for this license. More...
 
bool IsConsumptionResetEnabled ()
 Indicates whether consumption resets after a certain period of time. More...
 
bool IsDeviceTransferAllowed ()
 Checks if license can be transfered between devices More...
 
bool IsDeviceTransferLimited ()
 Checks if the license allows only limited number of transfers between devices More...
 
bool IsExpired ()
 Is license expired More...
 
bool IsFloating ()
 Is this license floating More...
 
bool IsGracePeriodStarted ()
 Check if grace period started for a license More...
 
bool IsMaintenancePeriodExpired ()
 Is maintenance period expired More...
 
bool IsOfflineActivated ()
 Is this license was activated offline More...
 
bool IsSubscriptionGracePeriodStarted ()
 Check if grace period started for subscription license More...
 
bool IsTrial ()
 Is this license trial More...
 
bool IsUnlimitedConsumptionAllowed ()
 Is unlimited consumption allowed for the license More...
 
bool IsValid ()
 Fast and simple way to check current local state of the license. More...
 
string Key ()
 License key More...
 
DateTime LastCheckDate ()
 The DateTime of the last sync with the LicenseSpring platform More...
 
DateTime LastCheckDateUTC ()
 The DateTime of the last sync with the LicenseSpring platform More...
 
LicenseUser LicenseUser ()
 License user More...
 
void LocalCheck ()
 Perform check for license validity locally More...
 
int MaintenanceDaysRemaining ()
 How many days remaining till maintenance period expires in current time zone More...
 
DateTime MaintenancePeriod ()
 Maintenance period for the license More...
 
DateTime MaintenancePeriodUTC ()
 Maintenance period for the license More...
 
uint MaxActivations ()
 How many times license can be activated More...
 
uint MaxBorrowTime ()
 Maximum borrowing period in hours More...
 
int MaxConsumption ()
 Maximum consumption of the license More...
 
int MaxConsumptionOverage ()
 Extra amount of consumption that allows to go over MaxConsumption. More...
 
string Metadata ()
 License metadata More...
 
Customer Owner ()
 Gets the information about license owner, commonly it's a person or organization associated with the license More...
 
uint PolicyId ()
 License Policy id More...
 
void Register ()
 Register floating license and occupy floating slot. More...
 
void Release (bool throwExceptions=false)
 Stop license watchdog thread and revoke floating license so other user can use it. More...
 
void ResumeLicenseWatchdog ()
 Restart background thread, you can call this within you callback in order to resume periodic license checks. More...
 
bool SendDeviceVariables ()
 Send current device variables list to the backend (see device variables on the platform) More...
 
void SetupLicenseWatchdog (LicenseWatchdogCallback callback, uint timeout=0)
 Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive. More...
 
void SetupLicenseWatchdog (LicenseWatchdogSettings settings)
 Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive. More...
 
void SetWatchdogTimeout (uint timeout=0)
 Set new timout for license watchdog. More...
 
DateTime StartDate ()
 License start date More...
 
LicenseStatus Status ()
 Method for getting local license status, see LicenseStatus documentation More...
 
void StopLicenseWatchdog ()
 Stops license watchdog background thread. More...
 
uint SubscriptionGracePeriod ()
 Grace period in hours More...
 
bool SyncConsumption (OverageRequest overageRequest=null)
 Sync Consumption license with the LicenseSpring platform More...
 
bool SyncFeatureConsumption (string featureCode=null)
 Sync Consumption feature with the LicenseSpring platform More...
 
uint TimesActivated ()
 How many times license already been activated More...
 
int TotalConsumption ()
 Current total consumption of the license More...
 
uint TransferCount ()
 How many times license has been transferred between devices More...
 
uint TransferLimit ()
 Maximum number of allowed license transfers between devices More...
 
LicenseType Type ()
 Type of license More...
 
void UpdateConsumption (int value=1)
 Increase local consumption counter for consumption license More...
 
void UpdateFeatureConsumption (string featureCode, int value=1)
 Increase local consumption counter for consumption product feature. More...
 
bool UpdateOffline (string path)
 Update license data accordingly to provided file. More...
 
string User ()
 Email of the License user More...
 
DateTime ValidityPeriod ()
 The DateTime until the license is valid More...
 
DateTime ValidityPeriodUTC ()
 The DateTime until the license is valid More...
 
DateTime ValidityWithGracePeriod ()
 The DateTime until the license is valid including grace period More...
 
DateTime ValidityWithGracePeriodUTC ()
 The DateTime until the license is valid including grace period More...
 

Static Public Attributes

const int MaxDaysRemainingValue = int.MaxValue
 Maximum value that can be returned by DaysRemaining, it equals to int.MaxValue
 

Detailed Description

License class, implements ILicense interface.

Used for checking, editing, and deleting characteristics of a license.

Member Function Documentation

◆ AddDeviceVariable() [1/2]

void LicenseSpring.License.AddDeviceVariable ( DeviceVariable  variable)

Add new or update existing device variable to license data

Implements LicenseSpring.ILicense.

◆ AddDeviceVariable() [2/2]

void LicenseSpring.License.AddDeviceVariable ( string  name,
string  value 
)

Add new or update existing device variable to license data

Implements LicenseSpring.ILicense.

◆ AddDeviceVariables()

void LicenseSpring.License.AddDeviceVariables ( DeviceVariable[]  variables)

Add new or update existing device variables to license data

Implements LicenseSpring.ILicense.

◆ Borrow() [1/3]

void LicenseSpring.License.Borrow ( DateTime  endDateTime)

Borrow floating license till provided end date time

Implements LicenseSpring.ILicense.

◆ Borrow() [2/3]

void LicenseSpring.License.Borrow ( string  borrowEndDateTime = null)

Borrow floating license till provided end date time string

Implements LicenseSpring.ILicense.

◆ Borrow() [3/3]

void LicenseSpring.License.Borrow ( uint  hours,
uint  days = 0 
)

Borrow floating license for provided time interval

Implements LicenseSpring.ILicense.

◆ CanBorrow()

bool LicenseSpring.License.CanBorrow ( )

Is this license can be borrowed or not

Implements LicenseSpring.ILicense.

◆ ChangePassword()

bool LicenseSpring.License.ChangePassword ( string  password,
string  newPassword 
)

Change password for user-based license

Implements LicenseSpring.ILicense.

◆ Check()

InstallationFile LicenseSpring.License.Check ( IInstallationFileOptions  options = null)

Check current license for validity on the LicenseSpring platform

Implements LicenseSpring.ILicense.

◆ ConsumptionPeriod()

ConsumptionPeriod LicenseSpring.License.ConsumptionPeriod ( )

Period of time after which consumption is reset.

Implements LicenseSpring.ILicense.

◆ CustomFields()

CustomField[] LicenseSpring.License.CustomFields ( )

Custom data fields available for the license

Implements LicenseSpring.ILicense.

◆ DaysPassedSinceLastCheck()

int LicenseSpring.License.DaysPassedSinceLastCheck ( )

How many days passed since last online check

Implements LicenseSpring.ILicense.

◆ DaysRemaining()

int LicenseSpring.License.DaysRemaining ( )

How many days remaining till license expires in current time zone

Implements LicenseSpring.ILicense.

◆ DaysRemainingUTC()

int LicenseSpring.License.DaysRemainingUTC ( )

How many days remaining till license expires

Implements LicenseSpring.ILicense.

◆ Deactivate()

bool LicenseSpring.License.Deactivate ( bool  removeLocalData = false)

Deactivate current license

Implements LicenseSpring.ILicense.

◆ DeactivateAirGap()

void LicenseSpring.License.DeactivateAirGap ( string  code)

Verify Confirmation code and deactivate air gap license

Implements LicenseSpring.ILicense.

◆ DeactivateOffline()

string LicenseSpring.License.DeactivateOffline ( string  deactivationRequestFile = null)

Deactivate license locally and create offline deactivation file request

Implements LicenseSpring.ILicense.

◆ DeviceVariable()

DeviceVariable LicenseSpring.License.DeviceVariable ( string  name)

Get device variable by name

Implements LicenseSpring.ILicense.

◆ DeviceVariableValue()

string LicenseSpring.License.DeviceVariableValue ( string  name)

Get device variable value by name

Implements LicenseSpring.ILicense.

◆ Feature()

LicenseFeature LicenseSpring.License.Feature ( string  featureCode)

Get product (license) feature by feature code

Implements LicenseSpring.ILicense.

◆ Features()

LicenseFeature[] LicenseSpring.License.Features ( )

Product features available for the license

Implements LicenseSpring.ILicense.

◆ FloatingClientId()

string LicenseSpring.License.FloatingClientId ( )

Floating user (client) or instance id

Implements LicenseSpring.ILicense.

◆ FloatingEndDateTime()

DateTime LicenseSpring.License.FloatingEndDateTime ( )

Floating license validity end date time in local time zone

Implements LicenseSpring.ILicense.

◆ FloatingEndDateTimeUtc()

DateTime LicenseSpring.License.FloatingEndDateTimeUtc ( )

Floating license validity end date time in UTC

Implements LicenseSpring.ILicense.

◆ FloatingSlotsCount()

uint LicenseSpring.License.FloatingSlotsCount ( )

Overall Floating slots or users count. Amount of simultaneous users (instances) allowed for this license.

Implements LicenseSpring.ILicense.

◆ FloatingSlotsInUse()

uint LicenseSpring.License.FloatingSlotsInUse ( )

Current floatings slots in use count, including this user (instance).

Implements LicenseSpring.ILicense.

◆ FloatingTimeout()

uint LicenseSpring.License.FloatingTimeout ( )

Floating timeout in minutes

Implements LicenseSpring.ILicense.

◆ GetAirGapDeactivationCode()

string LicenseSpring.License.GetAirGapDeactivationCode ( string  initializationCode)

Get air gap Deactivation code.

Implements LicenseSpring.ILicense.

◆ GetDeviceVariables()

DeviceVariable[] LicenseSpring.License.GetDeviceVariables ( bool  getFromBackend = false)

Get device variables from the local license or from the backend

Implements LicenseSpring.ILicense.

◆ GetProductDetails()

ProductDetails LicenseSpring.License.GetProductDetails ( )

Get information about a product this license belongs to

Implements LicenseSpring.ILicense.

◆ GracePeriodEndDateTime()

DateTime LicenseSpring.License.GracePeriodEndDateTime ( )

Getter for grace period end date time in local time

Implements LicenseSpring.ILicense.

◆ GracePeriodEndDateTimeUTC()

DateTime LicenseSpring.License.GracePeriodEndDateTimeUTC ( )

Getter for grace period end date time in UTC

Implements LicenseSpring.ILicense.

◆ GracePeriodHoursRemaining()

double LicenseSpring.License.GracePeriodHoursRemaining ( )

How many hours remaining till grace period ends

Implements LicenseSpring.ILicense.

◆ Id()

LicenseID LicenseSpring.License.Id ( )

◆ IsAirGapped()

bool LicenseSpring.License.IsAirGapped ( )

Is this license was activated using air-gap activation

Implements LicenseSpring.ILicense.

◆ IsBorrowed()

bool LicenseSpring.License.IsBorrowed ( )

Checker for whether the license is borrowed

Implements LicenseSpring.ILicense.

◆ IsConsumptionOverageAllowed()

bool LicenseSpring.License.IsConsumptionOverageAllowed ( )

Is it allowed to exceed consumption for this license.

Implements LicenseSpring.ILicense.

◆ IsConsumptionResetEnabled()

bool LicenseSpring.License.IsConsumptionResetEnabled ( )

Indicates whether consumption resets after a certain period of time.

Implements LicenseSpring.ILicense.

◆ IsDeviceTransferAllowed()

bool LicenseSpring.License.IsDeviceTransferAllowed ( )

Checks if license can be transfered between devices

Implements LicenseSpring.ILicense.

◆ IsDeviceTransferLimited()

bool LicenseSpring.License.IsDeviceTransferLimited ( )

Checks if the license allows only limited number of transfers between devices

Implements LicenseSpring.ILicense.

◆ IsExpired()

bool LicenseSpring.License.IsExpired ( )

Is license expired

Implements LicenseSpring.ILicense.

◆ IsFloating()

bool LicenseSpring.License.IsFloating ( )

Is this license floating

Implements LicenseSpring.ILicense.

◆ IsGracePeriodStarted()

bool LicenseSpring.License.IsGracePeriodStarted ( )

Check if grace period started for a license

Implements LicenseSpring.ILicense.

◆ IsMaintenancePeriodExpired()

bool LicenseSpring.License.IsMaintenancePeriodExpired ( )

Is maintenance period expired

Implements LicenseSpring.ILicense.

◆ IsOfflineActivated()

bool LicenseSpring.License.IsOfflineActivated ( )

Is this license was activated offline

Implements LicenseSpring.ILicense.

◆ IsSubscriptionGracePeriodStarted()

bool LicenseSpring.License.IsSubscriptionGracePeriodStarted ( )

Check if grace period started for subscription license

Implements LicenseSpring.ILicense.

◆ IsTrial()

bool LicenseSpring.License.IsTrial ( )

Is this license trial

Implements LicenseSpring.ILicense.

◆ IsUnlimitedConsumptionAllowed()

bool LicenseSpring.License.IsUnlimitedConsumptionAllowed ( )

Is unlimited consumption allowed for the license

Implements LicenseSpring.ILicense.

◆ IsValid()

bool LicenseSpring.License.IsValid ( )

Fast and simple way to check current local state of the license.Equivalent to Status().IsOk() and !IsExpired()

Implements LicenseSpring.ILicense.

◆ Key()

string LicenseSpring.License.Key ( )

◆ LastCheckDate()

DateTime LicenseSpring.License.LastCheckDate ( )

The DateTime of the last sync with the LicenseSpring platform

Implements LicenseSpring.ILicense.

◆ LastCheckDateUTC()

DateTime LicenseSpring.License.LastCheckDateUTC ( )

The DateTime of the last sync with the LicenseSpring platform

Implements LicenseSpring.ILicense.

◆ LicenseUser()

LicenseUser LicenseSpring.License.LicenseUser ( )

License user

Implements LicenseSpring.ILicense.

◆ LocalCheck()

void LicenseSpring.License.LocalCheck ( )

Perform check for license validity locally

Implements LicenseSpring.ILicense.

◆ MaintenanceDaysRemaining()

int LicenseSpring.License.MaintenanceDaysRemaining ( )

How many days remaining till maintenance period expires in current time zone

Implements LicenseSpring.ILicense.

◆ MaintenancePeriod()

DateTime LicenseSpring.License.MaintenancePeriod ( )

Maintenance period for the license

Implements LicenseSpring.ILicense.

◆ MaintenancePeriodUTC()

DateTime LicenseSpring.License.MaintenancePeriodUTC ( )

Maintenance period for the license

Implements LicenseSpring.ILicense.

◆ MaxActivations()

uint LicenseSpring.License.MaxActivations ( )

How many times license can be activated

Implements LicenseSpring.ILicense.

◆ MaxBorrowTime()

uint LicenseSpring.License.MaxBorrowTime ( )

Maximum borrowing period in hours

Implements LicenseSpring.ILicense.

◆ MaxConsumption()

int LicenseSpring.License.MaxConsumption ( )

Maximum consumption of the license

Implements LicenseSpring.ILicense.

◆ MaxConsumptionOverage()

int LicenseSpring.License.MaxConsumptionOverage ( )

Extra amount of consumption that allows to go over MaxConsumption.

Implements LicenseSpring.ILicense.

◆ Metadata()

string LicenseSpring.License.Metadata ( )

License metadata

Implements LicenseSpring.ILicense.

◆ Owner()

Customer LicenseSpring.License.Owner ( )

Gets the information about license owner, commonly it's a person or organization associated with the license

Implements LicenseSpring.ILicense.

◆ PolicyId()

uint LicenseSpring.License.PolicyId ( )

License Policy id

Implements LicenseSpring.ILicense.

◆ Register()

void LicenseSpring.License.Register ( )

Register floating license and occupy floating slot.

Implements LicenseSpring.ILicense.

◆ Release()

void LicenseSpring.License.Release ( bool  throwExceptions = false)

Stop license watchdog thread and revoke floating license so other user can use it.

Implements LicenseSpring.ILicense.

◆ ResumeLicenseWatchdog()

void LicenseSpring.License.ResumeLicenseWatchdog ( )

Restart background thread, you can call this within you callback in order to resume periodic license checks.

Implements LicenseSpring.ILicense.

◆ SendDeviceVariables()

bool LicenseSpring.License.SendDeviceVariables ( )

Send current device variables list to the backend (see device variables on the platform)Please note this data will be linked to the current running device ID.

Implements LicenseSpring.ILicense.

◆ SetupLicenseWatchdog() [1/2]

void LicenseSpring.License.SetupLicenseWatchdog ( LicenseWatchdogCallback  callback,
uint  timeout = 0 
)

Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive.This is especially useful for floating licenses, but can be used for any.

Implements LicenseSpring.ILicense.

◆ SetupLicenseWatchdog() [2/2]

void LicenseSpring.License.SetupLicenseWatchdog ( LicenseWatchdogSettings  settings)

Setup and run license watchdog, a background thread which periodically checks the license, by so keeping it alive.This is especially useful for floating licenses, but can be used for any.

Implements LicenseSpring.ILicense.

◆ SetWatchdogTimeout()

void LicenseSpring.License.SetWatchdogTimeout ( uint  timeout = 0)

Set new timout for license watchdog.

Implements LicenseSpring.ILicense.

◆ StartDate()

DateTime LicenseSpring.License.StartDate ( )

License start date

Implements LicenseSpring.ILicense.

◆ Status()

LicenseStatus LicenseSpring.License.Status ( )

Method for getting local license status, see LicenseStatus documentation

Implements LicenseSpring.ILicense.

◆ StopLicenseWatchdog()

void LicenseSpring.License.StopLicenseWatchdog ( )

Stops license watchdog background thread.

Implements LicenseSpring.ILicense.

◆ SubscriptionGracePeriod()

uint LicenseSpring.License.SubscriptionGracePeriod ( )

Grace period in hours

Implements LicenseSpring.ILicense.

◆ SyncConsumption()

bool LicenseSpring.License.SyncConsumption ( OverageRequest  overageRequest = null)

Sync Consumption license with the LicenseSpring platform

Implements LicenseSpring.ILicense.

◆ SyncFeatureConsumption()

bool LicenseSpring.License.SyncFeatureConsumption ( string  featureCode = null)

Sync Consumption feature with the LicenseSpring platform

Implements LicenseSpring.ILicense.

◆ TimesActivated()

uint LicenseSpring.License.TimesActivated ( )

How many times license already been activated

Implements LicenseSpring.ILicense.

◆ TotalConsumption()

int LicenseSpring.License.TotalConsumption ( )

Current total consumption of the license

Implements LicenseSpring.ILicense.

◆ TransferCount()

uint LicenseSpring.License.TransferCount ( )

How many times license has been transferred between devices

Implements LicenseSpring.ILicense.

◆ TransferLimit()

uint LicenseSpring.License.TransferLimit ( )

Maximum number of allowed license transfers between devices

Implements LicenseSpring.ILicense.

◆ Type()

LicenseType LicenseSpring.License.Type ( )

Type of license

Implements LicenseSpring.ILicense.

◆ UpdateConsumption()

void LicenseSpring.License.UpdateConsumption ( int  value = 1)

Increase local consumption counter for consumption license

Implements LicenseSpring.ILicense.

◆ UpdateFeatureConsumption()

void LicenseSpring.License.UpdateFeatureConsumption ( string  featureCode,
int  value = 1 
)

Increase local consumption counter for consumption product feature.

Implements LicenseSpring.ILicense.

◆ UpdateOffline()

bool LicenseSpring.License.UpdateOffline ( string  path)

Update license data accordingly to provided file.

Implements LicenseSpring.ILicense.

◆ User()

string LicenseSpring.License.User ( )

Email of the License user

Implements LicenseSpring.ILicense.

◆ ValidityPeriod()

DateTime LicenseSpring.License.ValidityPeriod ( )

The DateTime until the license is valid

Implements LicenseSpring.ILicense.

◆ ValidityPeriodUTC()

DateTime LicenseSpring.License.ValidityPeriodUTC ( )

The DateTime until the license is valid

Implements LicenseSpring.ILicense.

◆ ValidityWithGracePeriod()

DateTime LicenseSpring.License.ValidityWithGracePeriod ( )

The DateTime until the license is valid including grace period

Implements LicenseSpring.ILicense.

◆ ValidityWithGracePeriodUTC()

DateTime LicenseSpring.License.ValidityWithGracePeriodUTC ( )

The DateTime until the license is valid including grace period

Implements LicenseSpring.ILicense.


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