Class Definition
- Namespace
- OverKizApi.Models
- Assembly
- OverKizApi.dll
Full capability definition for a device, describing every command it accepts and every state it can report.
public sealed class Definition
- Inheritance
-
Definition
- Inherited Members
Properties
Commands
All commands supported by the device.
public IReadOnlyList<CommandDefinition> Commands { get; init; }
Property Value
QualifiedName
Qualified name of the device controllable type (e.g. "io:RollerShutterGenericIOComponent").
public string? QualifiedName { get; init; }
Property Value
States
All states the device can report.
public IReadOnlyList<StateDefinition> States { get; init; }
Property Value
UiClass
UI class name used by the Overkiz app to categorise the device.
public string? UiClass { get; init; }
Property Value
WidgetName
UI widget name used by the Overkiz app to render the device.
public string? WidgetName { get; init; }