Class Helpers

Helper methods to ease interaction with Web API 3. These methods require .NET Framework 4.0 or 4.6.

Inheritance

System.Object

Helpers

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SKM.V3.Methods

Assembly: Cryptolens.Licensing.dll

Syntax

public static class Helpers

Methods

| Improve this Doc View Source

GetFloatingLicenseInformation(ActivateModel, KeyInfoResult)

Returns floating license related information.

Declaration

public static FloatingLicenseInformation GetFloatingLicenseInformation(ActivateModel activationModel, KeyInfoResult activationResult)

Parameters

Type	Name	Description
ActivateModel	activationModel
KeyInfoResult	activationResult

Returns

Type	Description
FloatingLicenseInformation

| Improve this Doc View Source

GetFloatingLicenseInformation(Int32, Int32, Int32)

Returns floating license related information.

Declaration

public static FloatingLicenseInformation GetFloatingLicenseInformation(int MaxOverdraft, int MaxNoOfMachines, int UsedFloatingMachines)

Parameters

Type	Name	Description
System.Int32	MaxOverdraft
System.Int32	MaxNoOfMachines
System.Int32	UsedFloatingMachines

Returns

Type	Description
FloatingLicenseInformation

| Improve this Doc View Source

GetMachineCode(Boolean)

Returns the machine code of the current device with SHA-256 as the hash function. This method works differently depending on the binaries that you use. By default, machine code is computed using COM, which requires System.Management. This is only supported on Windows, it's better to set platformIndependent=true. If you use a version of library without System.Management, the platform independent machine code will be computed by default.

The supported platforms are Windows, Mac and Linux. Note, sudo access is required if Linux is used.

In newer projects, we recommend to always set platformIndependent=true or use GetMachineCodePI().

Declaration

[Obsolete]
public static string GetMachineCode(bool platformIndependent = false)

Parameters

Type	Name	Description
System.Boolean	platformIndependent

Returns

Type	Description
System.String

| Improve this Doc View Source

GetMachineCodePI()

Computes a platform independent machine code that works on Windows, Linux and Mac and does not require System.Management.

Note: On Linux, sudo access is necessary.

Declaration

public static string GetMachineCodePI()

Returns

Type	Description
System.String

| Improve this Doc View Source

GetPlatform()

Declaration

public static Helpers.OSType GetPlatform()

Returns

Type	Description
Helpers.OSType

| Improve this Doc View Source

IsOnRightMachine(LicenseKey, Boolean, Boolean, Boolean)

Checks if the current license key is on the correct device with SHA-256 as the hash function.

Declaration

public static bool IsOnRightMachine(LicenseKey licenseKey, bool isFloatingLicense = false, bool allowOverdraft = false, bool platformIndependent = false)

Parameters

Type	Name	Description
LicenseKey	licenseKey	The license key object.
System.Boolean	isFloatingLicense	If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting FloatingTimeInterval to a value greater than 0.
System.Boolean	allowOverdraft	If floating licensing is enabled with overdraft, this parameter should be set to true. You can enable overdraft by setting MaxOverdraft to a value greater than 0.
System.Boolean	platformIndependent	Allows you to specify if you want to use the old machine code method that is based on COM and requires System.Management or use the new platform independent method, i.e. GetMachineCodePI().

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsOnRightMachine(LicenseKey, String, Boolean, Boolean)

Checks if the current license key is on the correct device with SHA-256 as the hash function.

Declaration

public static bool IsOnRightMachine(LicenseKey licenseKey, string machineCode, bool isFloatingLicense = false, bool allowOverdraft = false)

Parameters

Type	Name	Description
LicenseKey	licenseKey	The license key object.
System.String	machineCode	A unique identifier of the machine.
System.Boolean	isFloatingLicense	If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting FloatingTimeInterval to a value greater than 0.
System.Boolean	allowOverdraft	If floating licensing is enabled with overdraft, this parameter should be set to true. You can enable overdraft by setting MaxOverdraft to a value greater than 0.

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsOnRightMachinePI(LicenseKey, Boolean, Boolean)

Checks if the current license key is on the correct device with SHA-256 as the hash function.

Declaration

public static bool IsOnRightMachinePI(LicenseKey licenseKey, bool isFloatingLicense = false, bool allowOverdraft = false)

Parameters

Type	Name	Description
LicenseKey	licenseKey	The license key object.
System.Boolean	isFloatingLicense	If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting FloatingTimeInterval to a value greater than 0.
System.Boolean	allowOverdraft	If floating licensing is enabled with overdraft, this parameter should be set to true. You can enable overdraft by setting MaxOverdraft to a value greater than 0.

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsSuccessful(BasicResult)

Checks if the result obtained from an API call is successful.

Declaration

public static bool IsSuccessful(BasicResult result)

Parameters

Type	Name	Description
BasicResult	result

Returns

Type	Description
System.Boolean