Skip to content

State

Source code in docs_src/capo_iot_events/types/state.py
class State(TypedDict, closed=True):
    state_name: "capo_iot_events.types.state_name.StateName"
    """<p>The name of the state.</p>"""
    on_input: NotRequired["capo_iot_events.types.on_input_lifecycle.OnInputLifecycle"]
    """<p>When an input is received and the <code>condition</code> is TRUE, perform the specified <code>actions</code>.</p>"""
    on_enter: NotRequired["capo_iot_events.types.on_enter_lifecycle.OnEnterLifecycle"]
    """<p>When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.</p>"""
    on_exit: NotRequired["capo_iot_events.types.on_exit_lifecycle.OnExitLifecycle"]
    """<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>.</p>"""

on_enter instance-attribute

on_enter: NotRequired[OnEnterLifecycle]

When entering this state, perform these actions if the condition is TRUE.

on_exit instance-attribute

on_exit: NotRequired[OnExitLifecycle]

When exiting this state, perform these actions if the specified condition is TRUE.

on_input instance-attribute

on_input: NotRequired[OnInputLifecycle]

When an input is received and the condition is TRUE, perform the specified actions.

state_name instance-attribute

state_name: StateName

The name of the state.