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

# NSResourceEntity

> The resource entity contains resource information.

The resource entity contains resource information.

## Constructors

### NSResourceEntity()

```crmscript theme={null}
NSResourceEntity
```

Initializes a new instance of the NSResourceEntity class.

## Methods

## GetDeleted()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - If true, the resource is deleted.

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetIsLocation()

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

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - If true the resource is a location.

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Bool isLocation = thing.GetIsLocation();
```

## GetLocationAddress()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Address of location, if this is a resource that is a location.

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
String locationAddress = thing.GetLocationAddress();
```

## GetName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Initials, also login name, possibly database user name.

**Example:**

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

## GetRank()

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

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

**Example:**

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

## GetResourceId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Integer resourceId = thing.GetResourceId();
```

## GetTooltip()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Tooltip or other description.

**Example:**

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

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

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

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetIsLocation(Bool)

```crmscript theme={null}
Void SetIsLocation(Bool isLocation)
```

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

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Bool isLocation;
thing.SetIsLocation(isLocation);
```

## SetLocationAddress(String)

```crmscript theme={null}
Void SetLocationAddress(String locationAddress)
```

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

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
String locationAddress;
thing.SetLocationAddress(locationAddress);
```

## SetName(String)

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

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

**Example:**

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

## SetRank(Integer)

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

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

**Example:**

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

## SetResourceId(Integer)

```crmscript theme={null}
Void SetResourceId(Integer resourceId)
```

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

**Example:**

```crmscript theme={null}
NSResourceEntity thing;
Integer resourceId;
thing.SetResourceId(resourceId);
```

## SetTooltip(String)

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

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

**Example:**

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


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Delete Resource Entity](/en/api/reference/restful/agent/list_agent/delete-resource-entity.md)
- [Save Resource Entity](/en/api/reference/restful/agent/list_agent/save-resource-entity.md)
- [Get Resource Entity](/en/api/reference/restful/agent/list_agent/get-resource-entity.md)
- [Create Default Resource Entity](/en/api/reference/restful/agent/list_agent/create-default-resource-entity.md)
- [SuperOffice.WebApi.Data.ResourceEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ResourceEntity.md)