> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSModuleLicenseLink

> Carrier object for ModuleLicenseLink.

Carrier object for ModuleLicenseLink.

## Constructors

### NSModuleLicenseLink()

```crmscript theme={null}
NSModuleLicenseLink
```

Initializes a new instance of the NSModuleLicenseLink class.

## Methods

## GetAssigned()

```crmscript theme={null}
Bool GetAssigned()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the module license assigned to a given user.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool assigned = thing.GetAssigned();
```

## GetCanAssign()

```crmscript theme={null}
Bool GetCanAssign()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Can a specific user assign this module license.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool canAssign = thing.GetCanAssign();
```

## GetDescription()

```crmscript theme={null}
String GetDescription()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The description of the module license.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String description = thing.GetDescription();
```

## GetFree()

```crmscript theme={null}
Integer GetFree()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The number of licenses that are free to be assigned.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer free = thing.GetFree();
```

## GetInUse()

```crmscript theme={null}
Integer GetInUse()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The total number of licenses (of a given license module) that are occupied.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer inUse = thing.GetInUse();
```

## GetIsHidden()

```crmscript theme={null}
Bool GetIsHidden()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is hidden from Ui.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool isHidden = thing.GetIsHidden();
```

## GetModuleLicenseId()

```crmscript theme={null}
Integer GetModuleLicenseId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The identifier of the module license.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer moduleLicenseId = thing.GetModuleLicenseId();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the module license.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String name = thing.GetName();
```

## GetPrerequisiteModuleName()

```crmscript theme={null}
String GetPrerequisiteModuleName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String prerequisiteModuleName = thing.GetPrerequisiteModuleName();
```

## GetSortOrder()

```crmscript theme={null}
Integer GetSortOrder()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer sortOrder = thing.GetSortOrder();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The tooltip to be shown in some gui with details on the module license.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String tooltip = thing.GetTooltip();
```

## GetTotal()

```crmscript theme={null}
Integer GetTotal()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The total number of module licenses. In other words the number of free license added to the number of licenses in use equals the total number of licenses.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer total = thing.GetTotal();
```

## GetUnrestricted()

```crmscript theme={null}
Bool GetUnrestricted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is this module license restricted or unrestricted.

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool unrestricted = thing.GetUnrestricted();
```

## SetAssigned(Bool)

```crmscript theme={null}
Void SetAssigned(Bool assigned)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool assigned;
thing.SetAssigned(assigned);
```

## SetCanAssign(Bool)

```crmscript theme={null}
Void SetCanAssign(Bool canAssign)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool canAssign;
thing.SetCanAssign(canAssign);
```

## SetDescription(String)

```crmscript theme={null}
Void SetDescription(String description)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String description;
thing.SetDescription(description);
```

## SetFree(Integer)

```crmscript theme={null}
Void SetFree(Integer free)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer free;
thing.SetFree(free);
```

## SetInUse(Integer)

```crmscript theme={null}
Void SetInUse(Integer inUse)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer inUse;
thing.SetInUse(inUse);
```

## SetIsHidden(Bool)

```crmscript theme={null}
Void SetIsHidden(Bool isHidden)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool isHidden;
thing.SetIsHidden(isHidden);
```

## SetModuleLicenseId(Integer)

```crmscript theme={null}
Void SetModuleLicenseId(Integer moduleLicenseId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer moduleLicenseId;
thing.SetModuleLicenseId(moduleLicenseId);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String name;
thing.SetName(name);
```

## SetPrerequisiteModuleName(String)

```crmscript theme={null}
Void SetPrerequisiteModuleName(String prerequisiteModuleName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String prerequisiteModuleName;
thing.SetPrerequisiteModuleName(prerequisiteModuleName);
```

## SetSortOrder(Integer)

```crmscript theme={null}
Void SetSortOrder(Integer sortOrder)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetTotal(Integer)

```crmscript theme={null}
Void SetTotal(Integer total)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Integer total;
thing.SetTotal(total);
```

## SetUnrestricted(Bool)

```crmscript theme={null}
Void SetUnrestricted(Bool unrestricted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSModuleLicenseLink thing;
Bool unrestricted;
thing.SetUnrestricted(unrestricted);
```


## Related topics

- [NSLicenseOwner](/en/automation/crmscript/reference/CRMScript.NetServer.NSLicenseOwner.md)
- [NSLicenseAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSLicenseAgent.md)
- [SuperOffice.WebApi.Data.ModuleLicenseLink](/en/api/reference/webapi/SuperOffice.WebApi.Data.ModuleLicenseLink.md)
- [Module licenses](/en/admin/license/dev/module-licenses.md)
- [ModuleLicense table](/en/database/tables/modulelicense.md)
- [LicenseAssocLink table](/en/database/tables/licenseassoclink.md)