LicenseSpring.ILicenseID Interface Reference

LicenseID interface, see LicenseID class. More...

Inheritance diagram for LicenseSpring.ILicenseID:

Public Member Functions
long	GetServerId ()
	COM-friendly accessor for ServerId. Returns 0 when the server id is not set.
string	Id ()
	Returns license key or user identifier, depending of what is present.
bool	IsEmpty ()
	Checks if LicenseID is empty.
bool	IsValid ()
	Checks if LicenseID is valid.
void	SetServerId (long serverId)
	COM-friendly setter for ServerId. Pass 0 to clear it (latest license will be activated).

Properties
string	Key [get]
	License key or empty string, if key is not set, for example in case of user-based product.
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.
long?	ServerId [get, set]
	Serverside license id, used for activating user licenses if a single user has multiple licenses for the same product. If not set, latest license will be activated.
string	User [get]
	User identifier or empty string, if user is not set, for example in case of key-based product.

Detailed Description

LicenseID interface, see LicenseID class.

Member Function Documentation

GetServerId()

long LicenseSpring.ILicenseID.GetServerId

(

)

COM-friendly accessor for ServerId. Returns 0 when the server id is not set.

Implemented in LicenseSpring.LicenseID.

Id()

string LicenseSpring.ILicenseID.Id

(

)

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

Returns

License key or user identifier string

Implemented in LicenseSpring.LicenseID.

IsEmpty()

bool LicenseSpring.ILicenseID.IsEmpty

(

)

Checks if LicenseID is empty.

LicenseID considered empty if both license key and user are empty strings.

Returns

True if empty and false otherwise

Implemented in LicenseSpring.LicenseID.

IsValid()

bool LicenseSpring.ILicenseID.IsValid

(

)

Checks if LicenseID is valid.

LicenseID considered valid if one of the members (key or user) is not empty. Equivalent of !IsEmpty().

Returns

True if valid and false otherwise

Implemented in LicenseSpring.LicenseID.

SetServerId()

void LicenseSpring.ILicenseID.SetServerId

(

long

serverId

)

COM-friendly setter for ServerId. Pass 0 to clear it (latest license will be activated).

Parameters

serverId

Serverside license id, or 0 to clear.

Implemented in LicenseSpring.LicenseID.

Property Documentation

Key

string LicenseSpring.ILicenseID.Key

get

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

Implemented in LicenseSpring.LicenseID.

Password

string LicenseSpring.ILicenseID.Password

getset

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

Implemented in LicenseSpring.LicenseID.

ServerId

long? LicenseSpring.ILicenseID.ServerId

getset

Serverside license id, used for activating user licenses if a single user has multiple licenses for the same product. If not set, latest license will be activated.

This member is not COM compatible (nullable value type). COM clients should use GetServerId and SetServerId instead.

Implemented in LicenseSpring.LicenseID.

User

string LicenseSpring.ILicenseID.User

get

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

Implemented in LicenseSpring.LicenseID.

---

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

• LicenseID.cs