WidgetSetting
homey.widget_setting
A setting for a widget, as defined in app.json.
This class must not be initialized by the developer, but retrieved by calling Widget.get_setting().
Ancestors
- SimpleClass
- homey.util.event_emitter.EventEmitter
- typing.Generic
Methods
register_autocomplete_listener
def register_autocomplete_listener(self, listener: SettingAutocompleteListener) ‑> NoneRegister an autocomplete listener for this setting.
Args
| Name | Type | Description |
|---|---|---|
listener |
SettingAutocompleteListener | An async SettingAutocompleteListener for when an autocomplete value is requested for this 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 this setting.