Starter

class Starter : Node, HasOutput

kotlin.Any
↳	com.google.home.automation.Node
	↳	com.google.home.automation.Starter

Defines the initial triggers that activate an automation, such as a change to a trait.

Either trait or event must be set.

Summary

Public constructors
`Starter( entityExpression: Expression, trait: TraitFactory<Trait>, output: String )` Create a `Starter` instance from an entity expression, a `DeviceType`, and a `Trait`.
`Starter( entityExpression: Expression, event: EventFactory<Event>, parameters: List<Parameter>, output: String )` Create a `Starter` from an entity expression, a `DeviceType`, and an `Event`.
`Starter( entity: HasId, deviceType: DeviceTypeFactory<DeviceType>?, trait: TraitFactory<Trait>, output: String )` Create a `Starter` instance from an entity, a `DeviceType`, and a `Trait`.
`Starter( entity: HasId, deviceType: DeviceTypeFactory<DeviceType>?, event: EventFactory<Event>, parameters: List<Parameter>, output: String )` Create a `Starter` from an entity, a `DeviceType`, and an `Event`.

Public properties
`DeviceTypeFactory<DeviceType>?`	`deviceType` The device type associated with this `Starter`.
`HasId?`	`entity` The unique ID for the entity associated with the `Starter`.
`Expression`	`entityExpression` An expression that selects an entity or a list of entity associated with the `Starter` at runtime.
`EventFactory<Event>?`	`event` The `Event` associated with this `Starter`.
`open String`	`output` The output.
`List<Parameter>`	`parameters` The Parameters for the `Event` associated with this `Starter`.
`TraitFactory<Trait>?`	`trait` The `Trait` associated with this `Starter`.
`String`	`traitId` The ID for the `Trait` associated with this `Starter`.

Inherited properties

From com.google.home.automation.Node

String?

nodeId

String identifier of this node.

Public constructors

Starter

Starter(
    entityExpression: Expression,
    trait: TraitFactory<Trait>,
    output: String
)

Create a Starter instance from an entity expression, a DeviceType, and a Trait. An entity may be a Device or a Structure.

Parameters
`entityExpression: Expression`	An expression that selects an entity or a list of entities associated with the `Starter`.
`trait: TraitFactory<Trait>`	The `Trait` associated with this `Starter`.
`output: String`	The output.

Starter

Starter(
    entityExpression: Expression,
    event: EventFactory<Event>,
    parameters: List<Parameter> = emptyList(),
    output: String
)

Create a Starter from an entity expression, a DeviceType, and an Event. An entity may be a Device or a Structure.

Parameters
`entityExpression: Expression`	An expression that selects an entity or a list of entities associated with the `Starter`.
`event: EventFactory<Event>`	The `Event` associated with this `Starter`.
`parameters: List<Parameter> = emptyList()`	The parameters for the `Event` associated with this `Starter`. If no `Event` is associated with this `Starter`, `parameters` is set to `null`.
`output: String`	The output.

Starter

Starter(
    entity: HasId,
    deviceType: DeviceTypeFactory<DeviceType>? = null,
    trait: TraitFactory<Trait>,
    output: String
)

Create a Starter instance from an entity, a DeviceType, and a Trait. An entity may be a Device or a Structure.

Parameters
`entity: HasId`	The unique ID for the entity associated with the `Starter`.
`deviceType: DeviceTypeFactory<DeviceType>? = null`	The device type associated with this `Starter`.
`trait: TraitFactory<Trait>`	The `Trait` associated with this `Starter`.
`output: String`	The output.

Starter

Starter(
    entity: HasId,
    deviceType: DeviceTypeFactory<DeviceType>? = null,
    event: EventFactory<Event>,
    parameters: List<Parameter> = emptyList(),
    output: String
)

Create a Starter from an entity, a DeviceType, and an Event. An entity may be a Device or a Structure.

Parameters
`entity: HasId`	The unique ID for the entity associated with the `Starter`.
`deviceType: DeviceTypeFactory<DeviceType>? = null`	The device type associated with this `Starter`. If the entity is a `Structure`, this is set to `null`.
`event: EventFactory<Event>`	The `Event` associated with this `Starter`.
`parameters: List<Parameter> = emptyList()`	The parameters for the `Event` associated with this `Starter`. If no `Event` is associated with this `Starter`, `parameters` is set to `null`.
`output: String`	The output.

Public properties

deviceType

val deviceType: DeviceTypeFactory<DeviceType>?

The device type associated with this Starter.

entity

val entity: HasId?

The unique ID for the entity associated with the Starter. If the target is not a static entity, this is set to null.

entityExpression

val entityExpression: Expression

An expression that selects an entity or a list of entity associated with the Starter at runtime.

event

val event: EventFactory<Event>?

The Event associated with this Starter.

output

open val output: String

The output.

parameters

val parameters: List<Parameter>

The Parameters for the Event associated with this Starter.

trait

val trait: TraitFactory<Trait>?

The Trait associated with this Starter.

traitId

val traitId: String

The ID for the Trait associated with this Starter.