CommandCandidate

class CommandCandidate : ActionCandidate


Represents automation candidate node corresponding to a command. These can be used in actions.

Summary

Public constructors

CommandCandidate(
    entity: HasId,
    types: List<DeviceTypeFactory<DeviceType>>,
    trait: TraitFactory<Trait>,
    fields: Map<String, CommandFieldDetails>,
    fieldDetailsMap: Map<Field, FieldDetails>,
    unsupportedReasons: List<UnsupportedCandidateReason>,
    commandId: String,
    commandDescriptor: CommandDescriptor
)

Public functions

open operator Boolean
equals(other: Any?)
open Int
open String

Public properties

CommandDescriptor
String

This property is deprecated. Use commandDescriptor instead

open HasId
open Map<Field, FieldDetails>
open Map<String, CommandFieldDetails>

This property is deprecated. Use fieldDetailsMap instead

open TraitFactory<Trait>
open List<DeviceTypeFactory<DeviceType>>
open List<UnsupportedCandidateReason>

Public constructors

CommandCandidate

CommandCandidate(
    entity: HasId,
    types: List<DeviceTypeFactory<DeviceType>>,
    trait: TraitFactory<Trait>,
    fields: Map<String, CommandFieldDetails>,
    fieldDetailsMap: Map<Field, FieldDetails> = emptyMap(),
    unsupportedReasons: List<UnsupportedCandidateReason> = emptyList(),
    commandId: String,
    commandDescriptor: CommandDescriptor
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

commandDescriptor

val commandDescriptor: CommandDescriptor

commandId

val commandId: String

entity

open val entity: HasId

fieldDetailsMap

open val fieldDetailsMap: Map<Field, FieldDetails>

fields

open val fields: Map<String, CommandFieldDetails>

trait

open val trait: TraitFactory<Trait>

types

open val types: List<DeviceTypeFactory<DeviceType>>

unsupportedReasons

open val unsupportedReasons: List<UnsupportedCandidateReason>