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

# <a id="SuperOffice_WebApi_Data_UiEvent" /> Class UiEvent

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

Carrier object for UiEvent.
An event that the user interface should know about. The origin may be something that happens in the user interface (in any session), or in the database (for instance, background process)

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[UiEvent](SuperOffice.WebApi.Data.UiEvent.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_UiEvent__ctor" /> UiEvent()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_UiEvent_AssociateId" /> AssociateId

The ID of the associate causing the event

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_AssociateName" /> AssociateName

The full person name of the associate causing the event

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_EntityKey" /> EntityKey

Primary key of entity the event concerns

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_EntityType" /> EntityType

Name of entity, for instance 'ticket'

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_EventDateTime" /> EventDateTime

When did the event happen

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_EventId" /> EventId

Id of event, increasing in chronological order, assigned by server

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UiEvent_EventName" /> EventName

Name of event, for instance 'change' or 'edit'

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.ViewState PublishAndRetrieveUiEventsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ViewState_PublishAndRetrieveUiEventsRequest.md)
- [SuperOffice.WebApi.Agents.IViewStateAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IViewStateAgent.md)
- [SuperOffice.WebApi.Agents.ViewStateAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ViewStateAgent.md)
- [SuperOffice.WebApi.Data.LiveUiConfig](/en/api/reference/webapi/SuperOffice.WebApi.Data.LiveUiConfig.md)
- [SuperOffice.WebApi.Data.Ticket GetForRmUiRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Ticket_GetForRmUiRequest.md)
- [SuperOffice.WebApi.Data.ViewState GetLiveUiConfigRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ViewState_GetLiveUiConfigRequest.md)