ZooClientParameters

References
public class ZooClientParameters
ZooClientParameters is a read-only set of parameters that control the flow of licensing inside ZooClient. Because this class flows through a number of other classes, functions, and UI, it is read-only so that inadvertent changes are not made to the data as it propagates from the caller.

Constructors

ZooClientParameters

#Since v6.0
ZooClientParameters Constructor
public ZooClientParameters(
productGuid,
Guid used by ZooClient to identify the plug-in requesting a license from ZooClient. This Guid may be used by different versions of the plug-in. If different licenses are used by different versions of the plug-in, the plug-in must also specify a LicenseGuid.
licenseGuid,
Guid used by ZooClient to identify the license saved by ZooClient. This differs from ProductGuid because different versions of a plug-in with the same Plug-in ID may need different licenses.
productTitle,
Title of product displayed in user interface
productBuildType,
capabilities,
Enum that declares whether this product supports evalation, licensing, purchasing, and cloud zoo
licenseEntryTextMask,
Text mask used to limit input. EG: RH50-AAAA-AAAA-AAAA-AAAA-AAAA
productPath,
Full path to DLL implementing product
parentWindow,
Object used to parent UI DLLs
selectedLicenseType,
Type of license currently used by this product
validateProductKey,
Delegate called to validate the structure of a license key
onLeaseChangedDelegate,
Delegate called when a cloud zoo lease changes
verifyLicenseKeyDelegate,
Delegate called to verify the structure of a license key
verifyPreviousVersionLicenseKeyDelegate
Delegate called to verify the structure of an upgrade license key
)

Properties

Capabilities

#Since v6.0
LicenseCapabilities flags that set options for how licenses can be obtained for this product
public LicenseCapabilities Capabilities { get; set; }

LicenseEntryTextMask

#Since v6.0
Text mask in the form @"RH4A-AAAA-AAAA-AAAA-AAAA-AAAA" that informs the user what numbers they are looking for
public string LicenseEntryTextMask { get; }

LicenseGuid

#Since v6.0
Guid used by ZooClient to identify the license saved by ZooClient. This differs from ProductGuid because different versions of a plug-in with the same Plug-in ID may need different licenses.
public Guid LicenseGuid { get; }

OnLeaseChanged

#Since v6.0
Delegate called by ZooClient when a cloud zoo lease is changed
public OnLeaseChangedDelegate OnLeaseChanged { get; }

ParentWindow

#Since v6.0
Parent window assigned to any licensing dialogs that appear. If null, the Rhino main window is used.
public object ParentWindow { get; }

ProductBuildType

#Since v6.0
Product build type. Must be one of LicenseBuildType values.
public int ProductBuildType { get; }

ProductGuid

#Since v6.0
Guid used by ZooClient to identify the plug-in requesting a license from ZooClient. This Guid may be used by different versions of the plug-in. If different licenses are used by different versions of the plug-in, the plug-in must also specify a LicenseGuid.
public Guid ProductGuid { get; }

ProductPath

#Since v6.0
Path to the application calling ZooClient
public string ProductPath { get; }

ProductTitle

#Since v6.0
Title of the product, "Rhinoceros 6" for example.
public string ProductTitle { get; }

SelectedLicenseType

#Since v6.0
License type selected by default when user is prompted to enter a license key
public LicenseTypes SelectedLicenseType { get; set; }

Methods

VerifyLicenseKey

#Since v6.0
Called by GetLicense to ensure that the license key entered by the user is legitimate and can be used.
public ValidateResult VerifyLicenseKey(
licenseKey,
License key string entered by user
validationCode,
Validation code entered by user (only if a previous call to VerifyLicenseKey set LicenseData.RequiresOnlineValidation to true).
validationCodeInstallDate,
Date that validation code was entered by user (only if a previous call to VerifyLicenseKey set LicenseData.RequiresOnlineValidation to true).
gracePeriodExpired,
Date by which license validation must complete successfully.
licenseData
Output parameter where return data about the license is set.
)

VerifyPreviousVersionLicense

#Since v6.0
When a caller calls GetLicense, ZooClient may call VerifyPreviousVersionLicense to ensure previousVersionLicense is legitimate and can be used to upgrade license.
public bool VerifyPreviousVersionLicense(
license,
License key for current product. This was returned by a previous call to VerifyLicenseKey or ValidateProductKey.
previousVersionLicense,
License key entered by user to show upgrade eligibility for license.
out string
errorMessage
Error message to be displayed to user if something isn't correct.
)