FlowArgument

homey.flow_argument

An argument for a flow card as defined in the app's app.json.

This class must not be initialized by the developer, but retrieved by calling FlowCard.get_argument().

Ancestors

  • SimpleClass
  • homey.util.event_emitter.EventEmitter
  • typing.Generic

Methods

register_autocomplete_listener

def register_autocomplete_listener(self, listener: ArgumentAutocompleteListener) ‑> None

Register an autocomplete listener for this argument.

Args

NameTypeDescription
listener ArgumentAutocompleteListener An async ArgumentAutocompleteListener for when an autocomplete value is requested for this argument. It receives the query typed by the user, as well as any arguments in the flow card, as currently selected by the user.

Raises

AlreadyExists
Raised if a listener was already registered for this argument.

Inherited members