Module homey.widget

Classes

class Widget

A widget, as defined in app.json.

Ancestors

• SimpleClass
• EventEmitter
• typing.Generic

Methods

def register_argument_autocomplete_listener(self,
id: str,
listener: SettingAutoCompleteListener) ‑> Self

Register an autocomplete listener for the setting with the given id.

Args

listener

An async listener for when an autocomplete value is requested for the setting. It receives the query typed by the user, as well as any settings in the widget, as currently selected by the user.

Raises

AlreadyExists

Raised if a listener was already registered for the setting.

NotFound

Raised if no setting with the given id is found.

Returns

This widget, for chained calls.

def get_setting(self, id: str) ‑> WidgetSetting

Get the setting with the given id.

Raises

NotFound

Raised if a setting with the given id is not found.:

Inherited members

• SimpleClass:
  • debug
  • emit
  • error
  • event_names
  • log
  • on
  • on_debug
  • on_error
  • on_log
  • once
  • remove_all_listeners
  • remove_listener

class SettingAutoCompleteResult

Ancestors

• builtins.dict

Instance variables

var name : str

The autocomplete value that will be shown to the user and used in the widget.

var description : str

A short description of the result that will be shown below the name.

var icon : str

A path to an .svg file to show as icon for the result.

var image : str

A path to an image that is not an .svg file to show as icon for the result.

var data : Any

Any additional data you wild like to pass to the widget for this autocomplete value.

class SettingAutoCompleteListener

A listener for when an autocomplete value is requested in a widget. It receives the query typed by the user, as well as the values of any settings in the widget, as currently selected by the user.

Ancestors

• typing.Protocol
• typing.Generic

Methods

async def __call__(self,
query: str,
settings: dict[str, SettingValue | SettingAutoCompleteResult]) ‑> list[SettingAutoCompleteResult]

Args

query

The query typed by the user.

settings

The values of any settings in the widget, as currently selected by the user.