Namespace OverKizApi.Enums

Enums

APIType

Determines whether the client communicates with the Overkiz cloud or a local gateway.

EventName

Identifies the type of an event returned by the event listener endpoint (events/{listenerId}/fetch).

ExecutionState

Lifecycle states of an execution as reported by the Overkiz API.

ExecutionSubType

Further classifies the origin of an execution.

ExecutionType

Indicates how an execution was triggered.

FailureType

Failure reason codes reported on a failed execution.

GatewayConnectivityState

Indicates whether the gateway is reachable by the Overkiz cloud.

GatewayMode

Describes the role of a gateway within its installation.

GatewaySubType

Identifies the hardware sub-model / variant of a gateway.

GatewayType

Identifies the hardware model / product family of a gateway.

GatewayUpdateStatus

Tracks the firmware/software update lifecycle of a gateway.

MeasuredValueType

Identifies the physical quantity and unit of a numeric sensor state value. Used alongside the raw state value to interpret measurements correctly.

ProductType

Classifies a device as an actuator, a sensor, or unknown.

Protocol

Identifies the radio/wired communication protocol used by a device. The value is parsed from the device URL prefix (e.g. io://, rts://).

Server

Identifies a specific named Overkiz-based cloud server. Use these keys to look up endpoint details in SupportedServers.

UIClass

Maps to the uiClass field returned in a device definition. The UI class broadly categorises what a device is (e.g. a shutter, a sensor, a lock) and is used by applications to choose the correct control template.

UIWidget

Maps to the widgetName field returned in a device definition. The widget name selects the specific UI control rendered by the Overkiz app for a device. Where a widget name matches a UIClass name the semantics are identical; not every UIClass value has a corresponding widget.