IdentifyTrait.TriggerEffectCommand.Request
class IdentifyTrait.TriggerEffectCommand.Request : ClusterStruct
The request payload for the TriggerEffect command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the TriggerEffect command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
IdentifyTrait.EffectIdentifierEnum |
The identify effect to use. |
IdentifyTrait.EffectVariantEnum |
Variant of the effect, indicated by the |
Public constructors
Request
Request(
effectIdentifier: IdentifyTrait.EffectIdentifierEnum = EffectIdentifierEnum.Blink,
effectVariant: IdentifyTrait.EffectVariantEnum = EffectVariantEnum.Default
)
Creates a request payload for the TriggerEffect command.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
effectIdentifier
val effectIdentifier: IdentifyTrait.EffectIdentifierEnum
The identify effect to use. Must be a value from IdentifyTrait.EffectIdentifierEnum.
effectVariant
val effectVariant: IdentifyTrait.EffectVariantEnum
Variant of the effect, indicated by the effectIdentifier parameter, that is triggered. This must be one of the values in IdentifyTrait.EffectVariantEnum.