Class NSModuleLicense
Represents a single module license info.
Constructors
NSModuleLicense()
Initializes a new instance of the NSModuleLicense class.
Declaration
NSModuleLicenseMethods
GetAllowedUserType()
Declaration
Integer GetAllowedUserType()Examples
NSModuleLicense thing;
Integer allowedUserType = thing.GetAllowedUserType();Returns
| Type | Description |
| Integer | Allowed associate type for user licenses internal(0), external(4). |
GetExtraFlags()
Declaration
Integer GetExtraFlags()Examples
NSModuleLicense thing;
Integer extraFlags = thing.GetExtraFlags();Returns
| Type | Description |
| Integer | Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view. |
GetExtraInfo()
Declaration
String GetExtraInfo()Examples
NSModuleLicense thing;
String extraInfo = thing.GetExtraInfo();Returns
| Type | Description |
| String | Free field, can be used by the module owner (for example host domain, for Service). |
GetIsHidden()
Declaration
Bool GetIsHidden()Examples
NSModuleLicense thing;
Bool isHidden = thing.GetIsHidden();Returns
| Type | Description |
| Bool | If true, then this module should not appear in GUI and is not assignable by users. |
GetLicenseType()
Declaration
Integer GetLicenseType()Examples
NSModuleLicense thing;
Integer licenseType = thing.GetLicenseType();Returns
| Type | Description |
| Integer | Entire system, per database, or per associate. See <xref href="CRMScript.NetServer.LicenseType" data-throw-if-not-resolved="false"></xref>. |
GetModuleDescription()
Declaration
String GetModuleDescription()Examples
NSModuleLicense thing;
String moduleDescription = thing.GetModuleDescription();Returns
| Type | Description |
| String | Human-readable description of module, shown in GUI, default language. |
GetModuleName()
Declaration
String GetModuleName()Examples
NSModuleLicense thing;
String moduleName = thing.GetModuleName();Returns
| Type | Description |
| String | The name of the module, not visible in GUI but used in the code. |
GetModuleTooltip()
Declaration
String GetModuleTooltip()Examples
NSModuleLicense thing;
String moduleTooltip = thing.GetModuleTooltip();Returns
| Type | Description |
| String | Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language. |
GetModuleVersion()
Declaration
String GetModuleVersion()Examples
NSModuleLicense thing;
String moduleVersion = thing.GetModuleVersion();Returns
| Type | Description |
| String | Version string for this module. |
GetNumberOfLicenses()
Declaration
Integer GetNumberOfLicenses()Examples
NSModuleLicense thing;
Integer numberOfLicenses = thing.GetNumberOfLicenses();Returns
| Type | Description |
| Integer | Number of licenses purchased. |
GetOwnerName()
Declaration
String GetOwnerName()Examples
NSModuleLicense thing;
String ownerName = thing.GetOwnerName();Returns
| Type | Description |
| String | The name of the module owner, not visible in GUI but used in the code. |
GetPrerequisiteModuleName()
Declaration
String GetPrerequisiteModuleName()Examples
NSModuleLicense thing;
String prerequisiteModuleName = thing.GetPrerequisiteModuleName();Returns
| Type | Description |
| String | If set, specifies a module license needed before this license can be granted. |
GetSignature()
Declaration
String GetSignature()Examples
NSModuleLicense thing;
String signature = thing.GetSignature();Returns
| Type | Description |
| String | Signature that verifies that this row is correctly transferred from SuperLicense. |
GetSortOrder()
Declaration
Integer GetSortOrder()Examples
NSModuleLicense thing;
Integer sortOrder = thing.GetSortOrder();Returns
| Type | Description |
| Integer | Ordering value, generated by SuperLicense and transferred here. Must be followed for signatures to be correct. |
GetUnrestricted()
Declaration
Bool GetUnrestricted()Examples
NSModuleLicense thing;
Bool unrestricted = thing.GetUnrestricted();Returns
| Type | Description |
| Bool | If true, then there is no licenseNumber limit on how many of these modules may be assigned. |
SetAllowedUserType(Integer)
Declaration
Void SetAllowedUserType(Integer allowedUserType)Examples
NSModuleLicense thing;
Integer allowedUserType;
thing.SetAllowedUserType(allowedUserType);Parameters
| Type | Name | Description |
| Integer | allowedUserType | Allowed associate type for user licenses internal(0), external(4). See <xref href="CRMScript.NetServer.AssociateType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetExtraFlags(Integer)
Declaration
Void SetExtraFlags(Integer extraFlags)Examples
NSModuleLicense thing;
Integer extraFlags;
thing.SetExtraFlags(extraFlags);Parameters
| Type | Name | Description |
| Integer | extraFlags | Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view. |
Returns
| Type | Description |
| Void |
SetExtraInfo(String)
Declaration
Void SetExtraInfo(String extraInfo)Examples
NSModuleLicense thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);Parameters
| Type | Name | Description |
| String | extraInfo | Free field, can be used by the module owner (for example host domain, for Service). |
Returns
| Type | Description |
| Void |
SetIsHidden(Bool)
Declaration
Void SetIsHidden(Bool isHidden)Examples
NSModuleLicense thing;
Bool isHidden;
thing.SetIsHidden(isHidden);Parameters
| Type | Name | Description |
| Bool | isHidden | If true, then this module should not appear in GUI and is not assignable by users. |
Returns
| Type | Description |
| Void |
SetLicenseType(Integer)
Sets the licence type.
Declaration
Void SetLicenseType(Integer licenseType)Examples
NSModuleLicense thing;
Integer licenseType;
thing.SetLicenseType(licenseType);Parameters
| Type | Name | Description |
| Integer | licenseType | The entire system, per database, or per associate. See <xref href="CRMScript.NetServer.LicenseType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetModuleDescription(String)
Declaration
Void SetModuleDescription(String moduleDescription)Examples
NSModuleLicense thing;
String moduleDescription;
thing.SetModuleDescription(moduleDescription);Parameters
| Type | Name | Description |
| String | moduleDescription | Human-readable description of module, shown in GUI, default language. |
Returns
| Type | Description |
| Void |
SetModuleName(String)
Declaration
Void SetModuleName(String moduleName)Examples
NSModuleLicense thing;
String moduleName;
thing.SetModuleName(moduleName);Parameters
| Type | Name | Description |
| String | moduleName | The name of the module, not visible in GUI but used in the code. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please. |
Returns
| Type | Description |
| Void |
SetModuleTooltip(String)
Declaration
Void SetModuleTooltip(String moduleTooltip)Examples
NSModuleLicense thing;
String moduleTooltip;
thing.SetModuleTooltip(moduleTooltip);Parameters
| Type | Name | Description |
| String | moduleTooltip | Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language. |
Returns
| Type | Description |
| Void |
SetModuleVersion(String)
Declaration
Void SetModuleVersion(String moduleVersion)Examples
NSModuleLicense thing;
String moduleVersion;
thing.SetModuleVersion(moduleVersion);Parameters
| Type | Name | Description |
| String | moduleVersion | Version string for this module. |
Returns
| Type | Description |
| Void |
SetNumberOfLicenses(Integer)
Declaration
Void SetNumberOfLicenses(Integer numberOfLicenses)Examples
NSModuleLicense thing;
Integer numberOfLicenses;
thing.SetNumberOfLicenses(numberOfLicenses);Parameters
| Type | Name | Description |
| Integer | numberOfLicenses | Number of licenses purchased. |
Returns
| Type | Description |
| Void |
SetOwnerName(String)
Declaration
Void SetOwnerName(String ownerName)Examples
NSModuleLicense thing;
String ownerName;
thing.SetOwnerName(ownerName);Parameters
| Type | Name | Description |
| String | ownerName | The name of the module owner, not visible in GUI but used in the code. OwnerName SUPEROFFICE is reserved and may NEVER be used by partners. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please. |
Returns
| Type | Description |
| Void |
SetPrerequisiteModuleName(String)
Declaration
Void SetPrerequisiteModuleName(String prerequisiteModuleName)Examples
NSModuleLicense thing;
String prerequisiteModuleName;
thing.SetPrerequisiteModuleName(prerequisiteModuleName);Parameters
| Type | Name | Description |
| String | prerequisiteModuleName | If set, specifies a module license needed before this license can be granted. |
Returns
| Type | Description |
| Void |
SetSignature(String)
Declaration
Void SetSignature(String signature)Examples
NSModuleLicense thing;
String signature;
thing.SetSignature(signature);Parameters
| Type | Name | Description |
| String | signature | Signature that verifies that this row is correctly transferred from SuperLicense. |
Returns
| Type | Description |
| Void |
SetSortOrder(Integer)
Declaration
Void SetSortOrder(Integer sortOrder)Examples
NSModuleLicense thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);Parameters
| Type | Name | Description |
| Integer | sortOrder | Ordering value* generated by SuperLicense and transferred here. Must be followed for signatures to be correct. |
Returns
| Type | Description |
| Void |
SetUnrestricted(Bool)
Declaration
Void SetUnrestricted(Bool unrestricted)Examples
NSModuleLicense thing;
Bool unrestricted;
thing.SetUnrestricted(unrestricted);Parameters
| Type | Name | Description |
| Bool | unrestricted | If true, then there is no licenseNumber limit on how many of these modules may be assigned. |
Returns
| Type | Description |
| Void |