FlowCardTrigger

homey.flow_card_trigger

A flow card with type trigger, as defined in the app's app.json.

Methods

def register_run_listener(self, listener: RunListener[bool]) ‑> Self

Register a listener for when this flow card is activated. Raising an exception in the listener will make the flow fail with the exception's message.

Name	Type	Description
`listener`	RunListener[bool]	An async listener ran when the flow card is activated, which returns whether the flow should start. It receives the arguments of the flow card, and arguments passed when triggering the flow card.

This flow card, for chained calls.

AlreadyExists: Raised if a listener was already registered for this flow card.

async def trigger(self, tokens: dict[str, Any] = {}, **trigger_kwargs) ‑> None

Activate the flow card, and thereby any flows it is used in.

Name	Type	Description
`tokens`	dict[str, Any]	A mapping from tokens to their values in the flow, as defined in `app.json`.
`trigger_kwargs`		Arguments that will be passed to the card's run listener.