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

Class that represents License identifier More...

Inheritance diagram for LicenseSpring.LicenseID:
LicenseSpring.ILicenseID

Public Member Functions

bool Equals (LicenseID id)
 Compare this object with given LicenseID More...
 
override bool Equals (object obj)
 Overrides Object.Equals
 
override int GetHashCode ()
 Overrides Object.GetHashCode
 
string Id ()
 Returns license key or user identifier, depending of what is present More...
 
bool IsEmpty ()
 Checks if LicenseID is empty More...
 
bool IsValid ()
 Checks if LicenseID is valid More...
 
string Id ()
 Returns license key or user identifier, depending of what is present More...
 
bool IsEmpty ()
 Checks if LicenseID is empty More...
 
bool IsValid ()
 Checks if LicenseID is valid More...
 

Static Public Member Functions

static LicenseID FromKey (string licenseKey)
 Constructs LicenseID with given license key. More...
 
static LicenseID FromUser (string user, string password="")
 Constructs LicenseID with given user credentials. More...
 
static bool operator!= (LicenseID lhs, LicenseID rhs)
 Compare two LicenseIDs More...
 
static bool operator== (LicenseID lhs, LicenseID rhs)
 Compare two LicenseIDs More...
 

Properties

string Key [get]
 License key or empty string, if key is not set, for example in case of user-based product. More...
 
string Password [get, set]
 Returns user password or empty string, if password is not set. SDK does not store password on disk or anywhere else. More...
 
string User [get]
 User identifier or empty string, if user is not set, for example in case of key-based product. More...
 
- Properties inherited from LicenseSpring.ILicenseID
string Key [get]
 License key or empty string, if key is not set, for example in case of user-based product. More...
 
string Password [get, set]
 Returns user password or empty string, if password is not set. SDK does not store password on disk or anywhere else. More...
 
string User [get]
 User identifier or empty string, if user is not set, for example in case of key-based product. More...
 

Detailed Description

Class that represents License identifier

For key-based products it is license key, for user-based products it is user credentials - user identifier (typically email) and password.

Please note: password only required for license activation, other API does not require password. This class does not throw exceptions.

Member Function Documentation

◆ Equals()

bool LicenseSpring.LicenseID.Equals ( LicenseID  id)

Compare this object with given LicenseID

Returns
True if objects equal and false otherwise

◆ FromKey()

static LicenseID LicenseSpring.LicenseID.FromKey ( string  licenseKey)
static

Constructs LicenseID with given license key.

The license key used to activate your license.

Returns
LicenseID object

◆ FromUser()

static LicenseID LicenseSpring.LicenseID.FromUser ( string  user,
string  password = "" 
)
static

Constructs LicenseID with given user credentials.

Returns
LicenseID object

◆ Id()

string LicenseSpring.LicenseID.Id ( )

Returns license key or user identifier, depending of what is present

Implements LicenseSpring.ILicenseID.

◆ IsEmpty()

bool LicenseSpring.LicenseID.IsEmpty ( )

Checks if LicenseID is empty

Implements LicenseSpring.ILicenseID.

◆ IsValid()

bool LicenseSpring.LicenseID.IsValid ( )

Checks if LicenseID is valid

Implements LicenseSpring.ILicenseID.

◆ operator!=()

static bool LicenseSpring.LicenseID.operator!= ( LicenseID  lhs,
LicenseID  rhs 
)
static

Compare two LicenseIDs

Returns
True if objects are not equal and false otherwise

◆ operator==()

static bool LicenseSpring.LicenseID.operator== ( LicenseID  lhs,
LicenseID  rhs 
)
static

Compare two LicenseIDs

Returns
True if objects equal and false otherwise

Property Documentation

◆ Key

string LicenseSpring.LicenseID.Key
get

License key or empty string, if key is not set, for example in case of user-based product.

Implements LicenseSpring.ILicenseID.

◆ Password

string LicenseSpring.LicenseID.Password
getset

Returns user password or empty string, if password is not set. SDK does not store password on disk or anywhere else.

Implements LicenseSpring.ILicenseID.

◆ User

string LicenseSpring.LicenseID.User
get

User identifier or empty string, if user is not set, for example in case of key-based product.

Implements LicenseSpring.ILicenseID.


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