ChimeThemesTrait.ThemeStruct

class ChimeThemesTrait.ThemeStruct : ClusterStruct


A theme.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

ThemeStruct(
    name: String,
    startTimeSeconds: OptionalValue<ULong>,
    endTimeSeconds: OptionalValue<ULong>,
    chimeSounds: List<ChimeThemesTrait.ChimeStruct>
)

Creates the ThemeStruct class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

List<ChimeThemesTrait.ChimeStruct>

The chime sounds of the theme.

OptionalValue<ULong>

The time that the theme ends.

String

The name of the theme.

OptionalValue<ULong>

The time that the theme starts.

Public constructors

ThemeStruct

ThemeStruct(
    name: String = "",
    startTimeSeconds: OptionalValue<ULong> = OptionalValue.absent(),
    endTimeSeconds: OptionalValue<ULong> = OptionalValue.absent(),
    chimeSounds: List<ChimeThemesTrait.ChimeStruct> = emptyList()
)

Creates the ThemeStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

chimeSounds

val chimeSoundsList<ChimeThemesTrait.ChimeStruct>

The chime sounds of the theme.

endTimeSeconds

val endTimeSecondsOptionalValue<ULong>

The time that the theme ends.

name

val nameString

The name of the theme.

startTimeSeconds

val startTimeSecondsOptionalValue<ULong>

The time that the theme starts.