ActionNodeDsl

interface ActionNodeDsl : AutomationFlowContributor

Known direct subclasses
ParallelFlowBuilder

Type-safe builder that builds a ParallelFlow node.

SequentialFlowBuilder

Type-safe builder that builds a SequentialFlow Node.


Interface for constructing Action nodes and contributing them to an automation flow.

Summary

Public functions

open Unit
action(structure: Structure, block: ActionBuilder.() -> Unit)

Build and add an Action.

open Unit
action(
    device: HomeDevice,
    deviceType: DeviceTypeFactory<DeviceType>,
    block: ActionBuilder.() -> Unit
)

Build and add an Action.

open Unit
action(
    unknownEntity: UnknownEntity,
    entityType: TypeFactory<HomeObjectType>,
    block: ActionBuilder.() -> Unit
)

Build an Action using an UnknownEntity.

Public functions

action

open fun action(structure: Structure, block: ActionBuilder.() -> Unit): Unit

Build and add an Action.

Parameters
structure: Structure

The Structure associated with the Action.

block: ActionBuilder.() -> Unit

The ActionBuilder used to build the Action.

action

open fun action(
    device: HomeDevice,
    deviceType: DeviceTypeFactory<DeviceType>,
    block: ActionBuilder.() -> Unit
): Unit

Build and add an Action.

Parameters
device: HomeDevice

The HomeDevice associated with the Action.

deviceType: DeviceTypeFactory<DeviceType>

The DeviceType associated with the Action.

block: ActionBuilder.() -> Unit

The ActionBuilder used to build the Action.

action

open fun action(
    unknownEntity: UnknownEntity,
    entityType: TypeFactory<HomeObjectType>,
    block: ActionBuilder.() -> Unit
): Unit

Build an Action using an UnknownEntity. Automations created using this method will not be valid. This method can be used to create draft automations.

Parameters
unknownEntity: UnknownEntity

The UnknownEntity associated with the Action.

entityType: TypeFactory<HomeObjectType>

The type associated with the Starter.

block: ActionBuilder.() -> Unit

The ActionBuilder used to build the Action.