Class EventObject

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

An event pushed to a registered event listener by the Overkiz gateway or cloud. The meaningful fields depend on the event type — check Name (mapped from EventName) before reading type-specific fields.

public sealed class EventObject

Inheritance

object

EventObject

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

CameraId

Camera identifier for camera-related events.

public string? CameraId { get; init; }

Property Value

string

ConditionGroupoid

OID of the condition group that triggered this event.

public string? ConditionGroupoid { get; init; }

Property Value

string

DeletedRawDevicesCount

Number of raw device records deleted during a synchronisation event.

public int? DeletedRawDevicesCount { get; init; }

Property Value

int?

DeviceStates

Changed state snapshots included in a DeviceStateChanged event.

public IReadOnlyList<EventState> DeviceStates { get; init; }

Property Value

IReadOnlyList<EventState>

DeviceUrl

Device URL of the device that triggered the event (present on device events).

public string? DeviceUrl { get; init; }

Property Value

string

ExecId

Execution ID associated with this event (present on execution state-change events).

public string? ExecId { get; init; }

Property Value

string

FailedCommands

Raw failed-commands payload (structure varies by gateway firmware version).

public object? FailedCommands { get; init; }

Property Value

object

FailureType

Failure type string as returned by the API (use FailureTypeCode for the parsed enum).

public string? FailureType { get; init; }

Property Value

string

FailureTypeCode

Parsed failure type code for failed-execution events.

public FailureType? FailureTypeCode { get; init; }

Property Value

FailureType?

GatewayId

Serial number of the gateway that generated the event.

public string? GatewayId { get; init; }

Property Value

string

Label

Human-readable label associated with the event (e.g. scenario name).

public string? Label { get; init; }

Property Value

string

Metadata

Arbitrary metadata string attached to the event.

public string? Metadata { get; init; }

Property Value

string

Name

Event name string as returned by the API (see EventName for known values).

public string? Name { get; init; }

Property Value

string

NewState

New execution state (present on ExecutionStateChanged events).

public ExecutionState? NewState { get; init; }

Property Value

ExecutionState?

OldState

Previous execution state (present on ExecutionStateChanged events).

public ExecutionState? OldState { get; init; }

Property Value

ExecutionState?

OwnerKey

Owner key of the principal that triggered the execution.

public string? OwnerKey { get; init; }

Property Value

string

PlaceOid

OID of the place associated with this event.

public string? PlaceOid { get; init; }

Property Value

string

ProtocolType

Protocol type string for protocol-synchronisation events.

public string? ProtocolType { get; init; }

Property Value

string

Setupoid

OID of the setup this event relates to.

public string? Setupoid { get; init; }

Property Value

string

SubType

Raw event sub-type integer as returned by the API.

public int? SubType { get; init; }

Property Value

int?

TimeToNextState

Estimated seconds until the next scheduled state transition.

public int? TimeToNextState { get; init; }

Property Value

int?

Timestamp

Unix epoch millisecond timestamp when the event occurred, or null if not provided.

public long? Timestamp { get; init; }

Property Value

long?

Type

Raw event type integer as returned by the API.

public int? Type { get; init; }

Property Value

int?