Uses of Class
org.openhab.core.types.StateDescription
Packages that use StateDescription
Package
Description
-
Uses of StateDescription in org.openhab.core.io.rest.core.item
Fields in org.openhab.core.io.rest.core.item declared as StateDescriptionConstructors in org.openhab.core.io.rest.core.item with parameters of type StateDescriptionModifierConstructorDescriptionEnrichedGroupItemDTO
(ItemDTO itemDTO, EnrichedItemDTO[] members, String link, String state, String lastState, Long lastStateUpdate, Long lastStateChange, String transformedState, StateDescription stateDescription, String unitSymbol) EnrichedItemDTO
(ItemDTO itemDTO, String link, String state, String lastState, Long lastStateUpdate, Long lastStateChange, String transformedState, StateDescription stateDescription, CommandDescription commandDescription, String unitSymbol) -
Uses of StateDescription in org.openhab.core.items
Methods in org.openhab.core.items that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
GenericItem.getStateDescription()
@Nullable StateDescription
GenericItem.getStateDescription
(@Nullable Locale locale) @Nullable StateDescription
Item.getStateDescription()
Returns the first provided state description (uses the default locale).@Nullable StateDescription
Item.getStateDescription
(@Nullable Locale locale) Returns the first provided state description for a given locale. -
Uses of StateDescription in org.openhab.core.library.items
Methods in org.openhab.core.library.items that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
NumberItem.getStateDescription
(@Nullable Locale locale) -
Uses of StateDescription in org.openhab.core.service
Methods in org.openhab.core.service that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
StateDescriptionService.getStateDescription
(String itemName, @Nullable Locale locale) Implementations of this method merge the StateDescriptions provided from multiple StateDescriptionProviders into one final StateDescription. -
Uses of StateDescription in org.openhab.core.thing.binding
Methods in org.openhab.core.thing.binding that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
BaseDynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription original, @Nullable Locale locale) Methods in org.openhab.core.thing.binding with parameters of type StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
BaseDynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription original, @Nullable Locale locale) -
Uses of StateDescription in org.openhab.core.thing.dto
Fields in org.openhab.core.thing.dto declared as StateDescriptionModifier and TypeFieldDescriptionChannelDefinitionDTO.stateDescription
ChannelTypeDTO.stateDescription
Constructors in org.openhab.core.thing.dto with parameters of type StateDescriptionModifierConstructorDescriptionChannelDefinitionDTO
(String id, String typeUID, String label, String description, Set<String> tags, String category, StateDescription stateDescription, boolean advanced, Map<String, String> properties) ChannelTypeDTO
(String uid, String label, String description, String category, String itemType, String unitHint, ChannelKind kind, List<ConfigDescriptionParameterDTO> parameters, List<ConfigDescriptionParameterGroupDTO> parameterGroups, StateDescription stateDescription, Set<String> tags, boolean advanced, CommandDescription commandDescription) -
Uses of StateDescription in org.openhab.core.thing.i18n
Methods in org.openhab.core.thing.i18n with parameters of type StateDescriptionModifier and TypeMethodDescription@Nullable StateDescriptionFragment
ChannelTypeI18nLocalizationService.createLocalizedStateDescriptionFragment
(org.osgi.framework.Bundle bundle, @Nullable StateDescription state, ChannelTypeUID channelTypeUID, @Nullable Locale locale) -
Uses of StateDescription in org.openhab.core.thing.type
Methods in org.openhab.core.thing.type that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
ChannelType.getState()
Returns theStateDescription
of an items state which gives information how to interpret it.@Nullable StateDescription
DynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription originalStateDescription, @Nullable Locale locale) For a givenChannel
, return aStateDescription
that should be used for the channel, instead of the one defined statically in theChannelType
.Methods in org.openhab.core.thing.type with parameters of type StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
DynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription originalStateDescription, @Nullable Locale locale) For a givenChannel
, return aStateDescription
that should be used for the channel, instead of the one defined statically in theChannelType
.Constructors in org.openhab.core.thing.type with parameters of type StateDescriptionModifierConstructorDescriptionprotected
ChannelType
(ChannelTypeUID uid, boolean advanced, @Nullable String itemType, @Nullable String unitHint, ChannelKind kind, String label, @Nullable String description, @Nullable String category, @Nullable Set<String> tags, @Nullable StateDescription state, @Nullable CommandDescription commandDescription, @Nullable EventDescription event, @Nullable URI configDescriptionURI, @Nullable AutoUpdatePolicy autoUpdatePolicy) Creates a new instance of this class with the specified parameters. -
Uses of StateDescription in org.openhab.core.types
Methods in org.openhab.core.types that return StateDescriptionModifier and TypeMethodDescription@Nullable StateDescription
StateDescriptionFragment.toStateDescription()
Create and return aStateDescription
from this fragment.Methods in org.openhab.core.types with parameters of type StateDescriptionModifier and TypeMethodDescriptionStateDescriptionFragmentBuilder.create
(StateDescription legacy) Creates a builder instance and initializes all fields from the givenStateDescription
.