ChimeThemesTrait.GetAvailableThemesCommand.Response
class ChimeThemesTrait.GetAvailableThemesCommand.Response : ClusterStruct
The list of available themes. To see which chime themes are available for a user, create a timebox filter and use it to filter the results of this command. A theme is considered active if the current time is within its startTimeSeconds and endTimeSeconds values in the ThemeStruct. If a start time isn't set, the theme is considered active from the beginning of time. If an end time isn't set, the theme continues to be active indefinitely. If both are missing, the theme is always active.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's response fields. |
Public constructors |
|---|
Response(themes: List<ChimeThemesTrait.ThemeStruct>)Creates a response payload from the GetAvailableThemes command. |
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.ThemeStruct> |
Public constructors
Response
Response(themes: List<ChimeThemesTrait.ThemeStruct> = emptyList())
Creates a response payload from the GetAvailableThemes command.
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.