Table of Contents

Key Types

The generated API reference includes the most useful entry points for consumers of the library.

Main Entry Points

  • OverkizClient — the primary client class for cloud and local API communication

Common Supporting Types

  • Server — enumeration used to select a descriptor from OverkizConst.SupportedServers
  • OverkizServer — server descriptor containing endpoints and authentication/API metadata
  • Device — represents a discovered smart-home device
  • State — represents a named typed device state
  • Command — represents an executable device command

Full Reference

For the full type list, use the generated API Reference.