NSModuleLicense - SuperOffice

Represents a single module license info.

Constructors

NSModuleLicense()

NSModuleLicense

Initializes a new instance of the NSModuleLicense class.

Methods

GetAllowedUserType()

Integer GetAllowedUserType()

Returns: CRMScript.Global.Integer - Allowed associate type for user licenses internal(0), external(4). Example:

NSModuleLicense thing;
Integer allowedUserType = thing.GetAllowedUserType();

GetExtraFlags()

Integer GetExtraFlags()

Returns: CRMScript.Global.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. Example:

NSModuleLicense thing;
Integer extraFlags = thing.GetExtraFlags();

GetExtraInfo()

String GetExtraInfo()

Returns: CRMScript.Global.String - Free field, can be used by the module owner (for example host domain, for Service).

For rows with extraFlags=1 this field contains the list of modules that this plan comprises

Example:

NSModuleLicense thing;
String extraInfo = thing.GetExtraInfo();

GetIsHidden()

Bool GetIsHidden()

Returns: CRMScript.Global.Bool - If true, then this module should not appear in GUI and is not assignable by users. Example:

NSModuleLicense thing;
Bool isHidden = thing.GetIsHidden();

GetLicenseType()

Integer GetLicenseType()

Returns: CRMScript.Global.Integer - Entire system, per database, or per associate. See <xref href=“CRMScript.NetServer.LicenseType” data-throw-if-not-resolved=“false”></xref>. Example:

NSModuleLicense thing;
Integer licenseType = thing.GetLicenseType();

GetModuleDescription()

String GetModuleDescription()

Returns: CRMScript.Global.String - Human-readable description of module, shown in GUI, default language.

Additional languages can be added to LocaleText, resource type 25

Example:

NSModuleLicense thing;
String moduleDescription = thing.GetModuleDescription();

GetModuleName()

String GetModuleName()

Returns: CRMScript.Global.String - 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.

Example:

NSModuleLicense thing;
String moduleName = thing.GetModuleName();

GetModuleTooltip()

String GetModuleTooltip()

Returns: CRMScript.Global.String - Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language.

Additional languages can be added to LocaleText, resource type 27

Example:

NSModuleLicense thing;
String moduleTooltip = thing.GetModuleTooltip();

GetModuleVersion()

String GetModuleVersion()

Returns: CRMScript.Global.String - Version string for this module. Example:

NSModuleLicense thing;
String moduleVersion = thing.GetModuleVersion();

GetNumberOfLicenses()

Integer GetNumberOfLicenses()

Returns: CRMScript.Global.Integer - Number of licenses purchased. Example:

NSModuleLicense thing;
Integer numberOfLicenses = thing.GetNumberOfLicenses();

GetOwnerName()

String GetOwnerName()

Returns: CRMScript.Global.String - 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.

Example:

NSModuleLicense thing;
String ownerName = thing.GetOwnerName();

GetPrerequisiteModuleName()

String GetPrerequisiteModuleName()

Returns: CRMScript.Global.String - If set, specifies a module license needed before this license can be granted. Example:

NSModuleLicense thing;
String prerequisiteModuleName = thing.GetPrerequisiteModuleName();

GetSignature()

String GetSignature()

Returns: CRMScript.Global.String - Signature that verifies that this row is correctly transferred from SuperLicense. Example:

NSModuleLicense thing;
String signature = thing.GetSignature();

GetSortOrder()

Integer GetSortOrder()

Returns: CRMScript.Global.Integer - Ordering value, generated by SuperLicense and transferred here. Must be followed for signatures to be correct. Example:

NSModuleLicense thing;
Integer sortOrder = thing.GetSortOrder();

GetUnrestricted()

Bool GetUnrestricted()

Returns: CRMScript.Global.Bool - If true, then there is no licenseNumber limit on how many of these modules may be assigned. Example:

NSModuleLicense thing;
Bool unrestricted = thing.GetUnrestricted();

SetAllowedUserType(Integer)

Void SetAllowedUserType(Integer allowedUserType)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Integer allowedUserType;
thing.SetAllowedUserType(allowedUserType);

SetExtraFlags(Integer)

Void SetExtraFlags(Integer extraFlags)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Integer extraFlags;
thing.SetExtraFlags(extraFlags);

SetExtraInfo(String)

Void SetExtraInfo(String extraInfo)

Returns: CRMScript.Global.Void

For rows with extraFlags=1 this field contains the list of modules that this plan comprises

Example:

NSModuleLicense thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);

SetIsHidden(Bool)

Void SetIsHidden(Bool isHidden)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Bool isHidden;
thing.SetIsHidden(isHidden);

SetLicenseType(Integer)

Sets the licence type.

Void SetLicenseType(Integer licenseType)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Integer licenseType;
thing.SetLicenseType(licenseType);

SetModuleDescription(String)

Void SetModuleDescription(String moduleDescription)

Returns: CRMScript.Global.Void

Additional languages can be added to LocaleText, resource type 25

Example:

NSModuleLicense thing;
String moduleDescription;
thing.SetModuleDescription(moduleDescription);

SetModuleName(String)

Void SetModuleName(String moduleName)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
String moduleName;
thing.SetModuleName(moduleName);

SetModuleTooltip(String)

Void SetModuleTooltip(String moduleTooltip)

Returns: CRMScript.Global.Void

Additional languages can be added to LocaleText, resource type 27

Example:

NSModuleLicense thing;
String moduleTooltip;
thing.SetModuleTooltip(moduleTooltip);

SetModuleVersion(String)

Void SetModuleVersion(String moduleVersion)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
String moduleVersion;
thing.SetModuleVersion(moduleVersion);

SetNumberOfLicenses(Integer)

Void SetNumberOfLicenses(Integer numberOfLicenses)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Integer numberOfLicenses;
thing.SetNumberOfLicenses(numberOfLicenses);

SetOwnerName(String)

Void SetOwnerName(String ownerName)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
String ownerName;
thing.SetOwnerName(ownerName);

SetPrerequisiteModuleName(String)

Void SetPrerequisiteModuleName(String prerequisiteModuleName)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
String prerequisiteModuleName;
thing.SetPrerequisiteModuleName(prerequisiteModuleName);

SetSignature(String)

Void SetSignature(String signature)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
String signature;
thing.SetSignature(signature);

SetSortOrder(Integer)

Void SetSortOrder(Integer sortOrder)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);

SetUnrestricted(Bool)

Void SetUnrestricted(Bool unrestricted)

Returns: CRMScript.Global.Void Example:

NSModuleLicense thing;
Bool unrestricted;
thing.SetUnrestricted(unrestricted);

​Constructors

​NSModuleLicense()

​Methods

​GetAllowedUserType()

​GetExtraFlags()

​GetExtraInfo()

​GetIsHidden()

​GetLicenseType()

​GetModuleDescription()

​GetModuleName()

​GetModuleTooltip()

​GetModuleVersion()

​GetNumberOfLicenses()

​GetOwnerName()

​GetPrerequisiteModuleName()

​GetSignature()

​GetSortOrder()

​GetUnrestricted()

​SetAllowedUserType(Integer)

​SetExtraFlags(Integer)

​SetExtraInfo(String)

​SetIsHidden(Bool)

​SetLicenseType(Integer)

​SetModuleDescription(String)

​SetModuleName(String)

​SetModuleTooltip(String)

​SetModuleVersion(String)

​SetNumberOfLicenses(Integer)

​SetOwnerName(String)

​SetPrerequisiteModuleName(String)

​SetSignature(String)

​SetSortOrder(Integer)

​SetUnrestricted(Bool)

Constructors

NSModuleLicense()

Methods

GetAllowedUserType()

GetExtraFlags()

GetExtraInfo()

GetIsHidden()

GetLicenseType()

GetModuleDescription()

GetModuleName()

GetModuleTooltip()

GetModuleVersion()

GetNumberOfLicenses()

GetOwnerName()

GetPrerequisiteModuleName()

GetSignature()

GetSortOrder()

GetUnrestricted()

SetAllowedUserType(Integer)

SetExtraFlags(Integer)

SetExtraInfo(String)

SetIsHidden(Bool)

SetLicenseType(Integer)

SetModuleDescription(String)

SetModuleName(String)

SetModuleTooltip(String)

SetModuleVersion(String)

SetNumberOfLicenses(Integer)

SetOwnerName(String)

SetPrerequisiteModuleName(String)

SetSignature(String)

SetSortOrder(Integer)

SetUnrestricted(Bool)