Namespace OverKizApi.Models
Classes
- Action
A set of commands targeting a single device, used as a unit within an execution request. One Action maps directly to one device URL.
- Command
A command to be sent to a device as part of an execution action. Commands are defined in the device's Commands list.
- CommandDefinition
Describes a single command that a device exposes in its capability definition.
- Connectivity
Real-time connectivity information for a Gateway.
- Definition
Full capability definition for a device, describing every command it accepts and every state it can report.
- Device
Represents a physical or virtual device registered in a setup. The DeviceUrl uniquely identifies the device across the entire API.
- EventObject
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.
- EventState
A snapshot of a single device state as embedded within an EventObject payload. Semantically identical to State but typed separately by the API.
- Execution
Represents an execution that is currently active (in-progress or queued) on a gateway. Returned by
exec/current. For completed executions see HistoryExecution.
- Feature
A feature flag or subscription option active on a setup.
- Gateway
Represents a physical Overkiz-compatible gateway (hub) registered in a setup. A setup may have more than one gateway.
- GatewayCandidate
Represents a Rexel gateway candidate discovered from the end-user directory API.
- HistoryExecution
A completed execution record as stored in the gateway history log.
- HistoryExecutionCommand
A single command record within a HistoryExecution.
- LocalToken
Descriptor for a local gateway API token generated via GenerateLocalToken(string) and activated with ActivateLocalToken(string, string, string, string).
- OptionObject
A subscribed option (add-on feature or service) active on a setup, as returned by
setup/options.
- OptionParameter
A key/value configuration parameter belonging to a setup OptionObject.
- OverkizServer
Describes a named Overkiz-compatible cloud server endpoint. Instances are stored in SupportedServers and passed to OverkizClient on construction.
- Partner
Information about a third-party partner integration registered on a gateway.
- Place
A place in the home hierarchy (house, floor, or room).
- Scenario
A named scenario (action group) stored in the setup that can be triggered by name or OID. Scenarios can include optional notification settings and scheduled triggers.
- Setup
The complete home setup as returned by the
setupendpoint. Contains all gateways, devices, zones, places and location metadata.
- State
A named state value reported by a device (e.g.
"core:ClosureState"=50). Use Type to determine the appropriate typed accessor.
- StateDefinition
Describes a state that a device can report, including its type and allowed values.
- States
An ordered, name-indexed collection of State objects for a device. Implements IEnumerable<T> so it can be used directly in foreach loops.
- Zone
A logical zone.