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

# SuperOffice.WebApi.Data.StatusMonitor

# <a id="SuperOffice_WebApi_Data_StatusMonitor" /> Class StatusMonitor

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for StatusMonitor.
Definition of all properties for a status monitor

```csharp theme={null}
public class StatusMonitor : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[StatusMonitor](SuperOffice.WebApi.Data.StatusMonitor.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_StatusMonitor__ctor" /> StatusMonitor()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public StatusMonitor()
```

## Properties

### <a id="SuperOffice_WebApi_Data_StatusMonitor_DefaultTask" /> DefaultTask

"Default task type for this status; the default task text is in the text table (since it can be long), and may contain template variables"

```csharp theme={null}
public virtual int DefaultTask { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_DefaultTaskText" /> DefaultTaskText

Default task text for this status

```csharp theme={null}
public virtual string DefaultTaskText { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_Deleted" /> Deleted

Deleted flag, 1 if this record is deleted (never from the database)

```csharp theme={null}
public virtual bool Deleted { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_Description" /> Description

Description of the status monitor

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_GenerationStart" /> GenerationStart

When was the last regeneration started

```csharp theme={null}
public virtual DateTime GenerationStart { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_IsVisual" /> IsVisual

Should the status be visualized (active) in the client

```csharp theme={null}
public virtual bool IsVisual { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_LastGenerated" /> LastGenerated

When was this status last generated (i.e., statusValue rows created)

```csharp theme={null}
public virtual DateTime LastGenerated { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_Name" /> Name

Name of status monitor

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_NeedsUpdate" /> NeedsUpdate

Is the definition dirty, ie., ALL values are invalid until a recalculation; this flag is set when the status DEFINITION is changed, as opposed to the flag on StatusValue

```csharp theme={null}
public virtual bool NeedsUpdate { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_NumMatches" /> NumMatches

Number of targets that have this status, this should be the number of rows in StatusValue pointing to this definition, and that have isSignalled set to 1

```csharp theme={null}
public virtual int NumMatches { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_NumNeedUpdate" /> NumNeedUpdate

Number of targets that had this status, but have their needsUpdate bit set due to some change

```csharp theme={null}
public virtual int NumNeedUpdate { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_OwnerTable" /> OwnerTable

Id of table that owns the status monitor

```csharp theme={null}
public virtual int OwnerTable { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_PictureId" /> PictureId

Id of BinaryObject row that contains image for status monitor

```csharp theme={null}
public virtual int PictureId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_Rank" /> Rank

Priority rank, in case more than one status is signalled. Lowest wins

```csharp theme={null}
public virtual int Rank { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_StatusMonitor_StatusMonitorId" /> StatusMonitorId

Primary key

```csharp theme={null}
public virtual int StatusMonitorId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

## See Also

[SaintAgent](SuperOffice.WebApi.Agents.SaintAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.StatusMonitorPeriods](/en/api/reference/webapi/SuperOffice.WebApi.Data.StatusMonitorPeriods.md)
- [SuperOffice.WebApi.Agents.ISaintAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ISaintAgent.md)
- [SuperOffice.WebApi.Agents.SaintAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SaintAgent.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.System](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.System.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.ROU](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.ROU.md)
- [SuperOffice.WebApi.Data.Saint GetStatusMonitorRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Saint_GetStatusMonitorRequest.md)