> ## 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.

# NSFavourite

> Favourite carrier.

Favourite carrier.

## Constructors

### NSFavourite()

```crmscript theme={null}
NSFavourite
```

Initializes a new instance of the NSFavourite class.

## Methods

## GetAssociateId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of the associate this favorite belongs to.

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer associateId = thing.GetAssociateId();
```

## GetExtraInfo()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Extra information for this favorite.

**Example:**

```crmscript theme={null}
NSFavourite thing;
String extraInfo = thing.GetExtraInfo();
```

## GetRank()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Rank order.

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer rank = thing.GetRank();
```

## GetRecordId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of the record this favorite belongs to.

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer recordId = thing.GetRecordId();
```

## GetTableName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Name of the table this favorite belongs to.

**Example:**

```crmscript theme={null}
NSFavourite thing;
String tableName = thing.GetTableName();
```

## SetAssociateId(Integer)

```crmscript theme={null}
Void SetAssociateId(Integer associateId)
```

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

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer associateId;
thing.SetAssociateId(associateId);
```

## SetExtraInfo(String)

```crmscript theme={null}
Void SetExtraInfo(String extraInfo)
```

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

**Example:**

```crmscript theme={null}
NSFavourite thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

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

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer rank;
thing.SetRank(rank);
```

## SetRecordId(Integer)

```crmscript theme={null}
Void SetRecordId(Integer recordId)
```

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

**Example:**

```crmscript theme={null}
NSFavourite thing;
Integer recordId;
thing.SetRecordId(recordId);
```

## SetTableName(String)

```crmscript theme={null}
Void SetTableName(String tableName)
```

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

**Example:**

```crmscript theme={null}
NSFavourite thing;
String tableName;
thing.SetTableName(tableName);
```


## Related topics

- [NSFavouriteAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSFavouriteAgent.md)
- [Favourites](/en/api/archive-providers/reference/favourites.md)
- [Is Favourite](/en/api/reference/restful/agent/favourite_agent/is-favourite.md)
- [Get Favourites](/en/api/reference/restful/agent/favourite_agent/get-favourites.md)
- [Remove Favourite](/en/api/reference/restful/agent/favourite_agent/remove-favourite.md)
- [Remove Favourites](/en/api/reference/restful/agent/favourite_agent/remove-favourites.md)