StateReaderNodeDsl

interface StateReaderNodeDsl : 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 StateReader nodes and contributing them to an automation flow.

Summary

Public functions

open TypedExpression
Trait> stateReader(
    entityExpression: TypedExpression<TypedEntity<HomeObjectType>?>,
    trait: TraitFactory
)

Build a StateReader.

open TypedExpression<Map<TypedEntity, T>>
Trait, U : HomeObjectType> stateReader(
    entityExpression: TypedExpression<List<TypedEntity>?>,
    trait: TraitFactory
)

Build a StateReader.

open TypedExpression
Trait> stateReader(structure: Structure, trait: TraitFactory)

Build a StateReader.

open TypedExpression
Trait> stateReader(
    device: HomeDevice,
    deviceType: DeviceTypeFactory<DeviceType>,
    trait: TraitFactory
)

Build a StateReader.

open TypedExpression
Trait> stateReader(
    unknownEntity: UnknownEntity,
    entityType: TypeFactory<HomeObjectType>,
    trait: TraitFactory
)

Build a StateReader using an UnknownEntity.

Public functions

stateReader

open fun Trait> stateReader(
    entityExpression: TypedExpression<TypedEntity<HomeObjectType>?>,
    trait: TraitFactory
): TypedExpression

Build a StateReader.

Parameters
entityExpression: TypedExpression<TypedEntity<HomeObjectType>?>

The entity Expression associated with the StateReader.

trait: TraitFactory

The Trait associated with the StateReader.

Returns
TypedExpression

A StateReader instance.

stateReader

open fun Trait, U : HomeObjectType> stateReader(
    entityExpression: TypedExpression<List<TypedEntity>?>,
    trait: TraitFactory
): TypedExpression<Map<TypedEntity, T>>

Build a StateReader.

Parameters
entityExpression: TypedExpression<List<TypedEntity>?>

The entity list Expression associated with the StateReader.

trait: TraitFactory

The Trait associated with the StateReader.

Returns
TypedExpression<Map<TypedEntity, T>>

A StateReader instance.

stateReader

open fun Trait> stateReader(structure: Structure, trait: TraitFactory): TypedExpression

Build a StateReader.

Parameters
structure: Structure

The Structure associated with the StateReader.

trait: TraitFactory

The Trait associated with the StateReader.

Returns
TypedExpression

A StateReader instance.

stateReader

open fun Trait> stateReader(
    device: HomeDevice,
    deviceType: DeviceTypeFactory<DeviceType>,
    trait: TraitFactory
): TypedExpression

Build a StateReader.

Parameters
device: HomeDevice

The Device associated with the StateReader.

deviceType: DeviceTypeFactory<DeviceType>

The DeviceType associated with the StateReader.

trait: TraitFactory

The Trait associated with the StateReader.

Returns
TypedExpression

A StateReader instance.

stateReader

open fun Trait> stateReader(
    unknownEntity: UnknownEntity,
    entityType: TypeFactory<HomeObjectType>,
    trait: TraitFactory
): TypedExpression

Build a StateReader 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 StateReader.

entityType: TypeFactory<HomeObjectType>

The type associated with the Starter.

trait: TraitFactory

The Trait associated with the StateReader.

Returns
TypedExpression

A StateReader instance.