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

Class for performing basic requests to LicenseSpring backend and managing licenses.Implements ILicenseManager interface More...

Inheritance diagram for LicenseSpring.LicenseManager:
LicenseSpring.BaseManager LicenseSpring.ILicenseManager

Public Member Functions

ILicense ActivateAirGapLicense (string code, string policyPath, string licenseKey, UInt32 policyId)
 
ILicense ActivateLicense (LicenseID licenseID)
 Activate license with given LicenseID More...
 
ILicense ActivateLicense (string data, string accountCode=null, bool useToken=false)
 Activate license using SSO More...
 
ILicense ActivateLicenseOffline (string activationResponseFile=null)
 Activate provided offline activation file More...
 
bool ChangePassword (LicenseID licenseID, string newPassword)
 Change user password, meaningful only for user-based products. More...
 
string GetAirGapActivationCode (string initializationCode, string licenseKey)
 Get air gap Activation code. More...
 
string[] GetAllVersions (LicenseID licenseID)
 Get all available versions for given license More...
 
ILicenseUser[] GetCustomerLicenseUsers (Customer customer)
 Get license users information by customer More...
 
InstallationFile GetInstallationFile (LicenseID licenseID, IInstallationFileOptions options=null)
 Get InstallationFile information for given license More...
 
string GetOfflineActivationFile (LicenseID licenseID, string activationRequestFile=null)
 Creates offline activation file request More...
 
ProductDetails GetProductDetails ()
 Retrieve information about a product from LicenseSpring backend. More...
 
string GetSSOUrl (string accountCode=null, bool useToken=false)
 Get URL for Single sign-on license activation. More...
 
LicenseID GetTrialLicense (Customer user=null, string licensePolicy=null)
 Request trial license from LicenseSpring More...
 
LicenseID GetTrialLicense (string email)
 Request trial license from LicenseSpring platform. Overloaded method. More...
 
bool IsOnline (bool throwExceptions=false)
 Helper method, it checks connection to the LicenseSpring backend More...
 
 LicenseManager ()
 Constructor of LicenseManager More...
 
ILicense RelinkLicense (DeviceIDAlgorithm deviceIdAlgorithm, string userPassword=null)
 This method helps upgrade to new device id algorithm. It deactivates current license with old device id and activate with new one. Internet connection is required. More...
 
- Public Member Functions inherited from LicenseSpring.BaseManager
void ClearLocalStorage ()
 Remove license file, license log if present and folders created by the SDK More...
 
ILicense CurrentLicense ()
 Load license from local storage (if not yet loaded) More...
 
void Initialize (Configuration configuration, ILicenseStorage storage=null)
 Initialize license manager with given configuration More...
 
bool IsInitialized ()
 Check whether license manager has been initialized More...
 
string LicenseFilePath ()
 Returns full path to the license file, meaningful only if LicenseFileStorage (or derived) is used More...
 
ILicense ReloadLicense ()
 Resets current license and loads it again from local storage More...
 
- Public Member Functions inherited from LicenseSpring.ILicenseManager
ILicense ActivateAirGapLicense (string confirmationCode, string policyPath, string licenseKey, uint policyId)
 Verify Confirmation code and activate air gap license using given license policy or policies More...
 
ILicense ActivateLicense (LicenseID licenseID)
 Activate license with given LicenseID More...
 
ILicense ActivateLicense (string data, string accountCode=null, bool useToken=false)
 Activate license using SSO More...
 
ILicense ActivateLicenseOffline (string activationResponseFile=null)
 Activate provided offline activation file More...
 
bool ChangePassword (LicenseID licenseID, string newPassword)
 Change user password, meaningful only for user-based products. More...
 
void ClearLocalStorage ()
 BaseManager.ClearLocalStorage
 
ILicense CurrentLicense ()
 BaseManager.CurrentLicense
 
string GetAirGapActivationCode (string initializationCode, string licenseKey)
 Get air gap Activation code. More...
 
string[] GetAllVersions (LicenseID licenseID)
 Get all available versions for given license More...
 
ILicenseUser[] GetCustomerLicenseUsers (Customer customer)
 Get license users information by customer More...
 
InstallationFile GetInstallationFile (LicenseID licenseID, IInstallationFileOptions options=null)
 Get InstallationFile information for given license More...
 
string GetOfflineActivationFile (LicenseID licenseID, string activationRequestFile=null)
 Creates offline activation file request More...
 
ProductDetails GetProductDetails ()
 Retrieve information about a product from LicenseSpring backend. More...
 
string GetSSOUrl (string accountCode=null, bool useToken=false)
 Get URL for Single sign-on license activation. More...
 
LicenseID GetTrialLicense (Customer user=null, string licensePolicy=null)
 Request trial license from LicenseSpring More...
 
LicenseID GetTrialLicense (string email)
 Request trial license from LicenseSpring platform. Overloaded method. More...
 
void Initialize (Configuration configuration, ILicenseStorage storage=null)
 BaseManager.Initialize
 
bool IsInitialized ()
 BaseManager.IsInitialized
 
bool IsOnline (bool throwExceptions=false)
 Helper method, it checks connection to the LicenseSpring backend More...
 
string LicenseFilePath ()
 BaseManager.LicenseFilePath
 
ILicense RelinkLicense (DeviceIDAlgorithm deviceIdAlgorithm, string userPassword=null)
 This method helps upgrade to new device id algorithm. It deactivates current license with old device id and activate with new one. Internet connection is required. More...
 
ILicense ReloadLicense ()
 BaseManager.ReloadLicense
 

Static Public Member Functions

static ILicenseManager GetInstance ()
 Get singleton LicenseManager instance More...
 

Additional Inherited Members

- Properties inherited from LicenseSpring.BaseManager
string DataLocation [get, set]
 Folder path where LicenseSpring data is being stored More...
 
string LicenseFileName [get, set]
 License filename with extension (optional), meaningful only if LicenseFileStorage is used More...
 
- Properties inherited from LicenseSpring.ILicenseManager
string DataLocation [get, set]
 BaseManager.DataLocation
 
string LicenseFileName [get, set]
 BaseManager.LicenseFileName
 

Detailed Description

Class for performing basic requests to LicenseSpring backend and managing licenses.Implements ILicenseManager interface

Constructor & Destructor Documentation

◆ LicenseManager()

LicenseSpring.LicenseManager.LicenseManager ( )

Constructor of LicenseManager

You can rather use singleton instance by LicenseManager.GetInstance or create manager directly by this constructor.

Member Function Documentation

◆ ActivateLicense() [1/2]

ILicense LicenseSpring.LicenseManager.ActivateLicense ( LicenseID  licenseID)

Activate license with given LicenseID

Implements LicenseSpring.ILicenseManager.

◆ ActivateLicense() [2/2]

ILicense LicenseSpring.LicenseManager.ActivateLicense ( string  data,
string  accountCode = null,
bool  useToken = false 
)

Activate license using SSO

Implements LicenseSpring.ILicenseManager.

◆ ActivateLicenseOffline()

ILicense LicenseSpring.LicenseManager.ActivateLicenseOffline ( string  activationResponseFile = null)

Activate provided offline activation file

Implements LicenseSpring.ILicenseManager.

◆ ChangePassword()

bool LicenseSpring.LicenseManager.ChangePassword ( LicenseID  licenseID,
string  newPassword 
)

Change user password, meaningful only for user-based products.

Implements LicenseSpring.ILicenseManager.

◆ GetAirGapActivationCode()

string LicenseSpring.LicenseManager.GetAirGapActivationCode ( string  initializationCode,
string  licenseKey 
)

Get air gap Activation code.

Implements LicenseSpring.ILicenseManager.

◆ GetAllVersions()

string[] LicenseSpring.LicenseManager.GetAllVersions ( LicenseID  licenseID)

Get all available versions for given license

Implements LicenseSpring.ILicenseManager.

◆ GetCustomerLicenseUsers()

ILicenseUser[] LicenseSpring.LicenseManager.GetCustomerLicenseUsers ( Customer  customer)

Get license users information by customer

Implements LicenseSpring.ILicenseManager.

◆ GetInstallationFile()

InstallationFile LicenseSpring.LicenseManager.GetInstallationFile ( LicenseID  licenseID,
IInstallationFileOptions  options = null 
)

Get InstallationFile information for given license

Implements LicenseSpring.ILicenseManager.

◆ GetInstance()

static ILicenseManager LicenseSpring.LicenseManager.GetInstance ( )
static

Get singleton LicenseManager instance

Returns
LicenseManager instance

◆ GetOfflineActivationFile()

string LicenseSpring.LicenseManager.GetOfflineActivationFile ( LicenseID  licenseID,
string  activationRequestFile = null 
)

Creates offline activation file request

Implements LicenseSpring.ILicenseManager.

◆ GetProductDetails()

ProductDetails LicenseSpring.LicenseManager.GetProductDetails ( )

Retrieve information about a product from LicenseSpring backend.

Implements LicenseSpring.ILicenseManager.

◆ GetSSOUrl()

string LicenseSpring.LicenseManager.GetSSOUrl ( string  accountCode = null,
bool  useToken = false 
)

Get URL for Single sign-on license activation.

Implements LicenseSpring.ILicenseManager.

◆ GetTrialLicense() [1/2]

LicenseID LicenseSpring.LicenseManager.GetTrialLicense ( Customer  user = null,
string  licensePolicy = null 
)

Request trial license from LicenseSpring

Implements LicenseSpring.ILicenseManager.

◆ GetTrialLicense() [2/2]

LicenseID LicenseSpring.LicenseManager.GetTrialLicense ( string  email)

Request trial license from LicenseSpring platform. Overloaded method.

Implements LicenseSpring.ILicenseManager.

◆ IsOnline()

bool LicenseSpring.LicenseManager.IsOnline ( bool  throwExceptions = false)

Helper method, it checks connection to the LicenseSpring backend

Implements LicenseSpring.ILicenseManager.

◆ RelinkLicense()

ILicense LicenseSpring.LicenseManager.RelinkLicense ( DeviceIDAlgorithm  deviceIdAlgorithm,
string  userPassword = null 
)

This method helps upgrade to new device id algorithm. It deactivates current license with old device id and activate with new one. Internet connection is required.

Implements LicenseSpring.ILicenseManager.


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