Class ModuleLicense

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ModuleLicense. Represents a single module license info.

public class ModuleLicense

Inheritance

object ← ModuleLicense

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

ModuleLicense()

Default constructor - defaults any enum props to 0.

public ModuleLicense()

Properties

AllowedUserType

Allowed associate type for user licenses: internal(0), external(4). NULL if unknown enum value.

[JsonIgnore]
public UserType? AllowedUserType { get; set; }

Property Value

UserType?

AllowedUserType_String

Allowed associate type for user licenses: internal(0), external(4). Raw string enum value.

[JsonProperty("AllowedUserType")]
public string AllowedUserType_String { get; set; }

Property Value

string

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

public virtual int ExtraFlags { get; set; }

Property Value

int

ExtraInfo

Free field, can be used by the module owner (example: host domain, for eJournal). NOTE: For rows with extraFlags=1 this field contains the list of modules that this plan comprises

public virtual string ExtraInfo { get; set; }

Property Value

string

IsHidden

If true, then this module should not appear in GUI and is not assignable by users

public virtual bool IsHidden { get; set; }

Property Value

bool

LicenseType

Entire system, per database, or per associate NULL if unknown enum value.

[JsonIgnore]
public LicenseType? LicenseType { get; set; }

Property Value

LicenseType?

LicenseType_String

Entire system, per database, or per associate Raw string enum value.

[JsonProperty("LicenseType")]
public string LicenseType_String { get; set; }

Property Value

string

ModuleDescription

Human-readable description of module, shown in GUI, default language. Additional languages can be added to LocaleText, resource type 25

public virtual string ModuleDescription { get; set; }

Property Value

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.

public virtual string ModuleName { get; set; }

Property Value

string

ModuleTooltip

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

public virtual string ModuleTooltip { get; set; }

Property Value

string

ModuleVersion

Version string for this module

public virtual string ModuleVersion { get; set; }

Property Value

string

NumberOfLicenses

Number of licenses purchased.

public virtual int NumberOfLicenses { get; set; }

Property Value

int

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.

public virtual string OwnerName { get; set; }

Property Value

string

PrerequisiteModuleName

If set, specifies a module license needed before this license can be granted

public virtual string PrerequisiteModuleName { get; set; }

Property Value

string

Signature

Signature that verifies that this row is correctly transferred from SuperLicense

public virtual string Signature { get; set; }

Property Value

string

SortOrder

Ordering value - generated by SuperLicense and transferred here. Must be followed for signatures to be correct

public virtual int SortOrder { get; set; }

Property Value

int

Unrestricted

If true, then there is no licenseNumber limit on how many of these modules may be assigned

public virtual bool Unrestricted { get; set; }

Property Value

bool

​ Class ModuleLicense

​Inheritance

​Inherited Members

​Constructors

​ ModuleLicense()

​Properties

​ AllowedUserType

​Property Value

​See Also

​ AllowedUserType_String

​Property Value

​See Also

​ ExtraFlags

​Property Value

​ ExtraInfo

​Property Value

​ IsHidden

​Property Value

​ LicenseType

​Property Value

​See Also

​ LicenseType_String

​Property Value

​See Also

​ ModuleDescription

​Property Value

​ ModuleName

​Property Value

​ ModuleTooltip

​Property Value

​ ModuleVersion

​Property Value

​ NumberOfLicenses

​Property Value

​ OwnerName

​Property Value

​ PrerequisiteModuleName

​Property Value

​ Signature

​Property Value

​ SortOrder

​Property Value

​ Unrestricted

​Property Value

​See Also

Class ModuleLicense

Inheritance

Inherited Members

Constructors

ModuleLicense()

Properties

AllowedUserType

Property Value

See Also

AllowedUserType_String

Property Value

See Also

ExtraFlags

Property Value

ExtraInfo

Property Value

IsHidden

Property Value

LicenseType

Property Value

See Also

LicenseType_String

Property Value

See Also

ModuleDescription

Property Value

ModuleName

Property Value

ModuleTooltip

Property Value

ModuleVersion

Property Value

NumberOfLicenses

Property Value

OwnerName

Property Value

PrerequisiteModuleName

Property Value

Signature

Property Value

SortOrder

Property Value

Unrestricted

Property Value

See Also