Table of Contents

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

IReadOnlyList<CommandDefinition>

QualifiedName

Qualified name of the device controllable type (e.g. "io:RollerShutterGenericIOComponent").

public string? QualifiedName { get; init; }

Property Value

string

States

All states the device can report.

public IReadOnlyList<StateDefinition> States { get; init; }

Property Value

IReadOnlyList<StateDefinition>

UiClass

UI class name used by the Overkiz app to categorise the device.

public string? UiClass { get; init; }

Property Value

string

WidgetName

UI widget name used by the Overkiz app to render the device.

public string? WidgetName { get; init; }

Property Value

string