Uses of Interface
org.openhab.core.types.CommandDescription

Packages that use CommandDescription

Package	Description
org.openhab.core.io.rest.core.item
org.openhab.core.items
org.openhab.core.library.items
org.openhab.core.service
org.openhab.core.thing.binding
org.openhab.core.thing.dto
org.openhab.core.thing.i18n
org.openhab.core.thing.type
org.openhab.core.types

Uses of CommandDescription in org.openhab.core.io.rest.core.item

Fields in org.openhab.core.io.rest.core.item declared as CommandDescription

Modifier and Type	Field	Description
CommandDescription	EnrichedItemDTO.commandDescription

Constructors in org.openhab.core.io.rest.core.item with parameters of type CommandDescription

Modifier	Constructor	Description
	EnrichedItemDTO(ItemDTO itemDTO, String link, String state, String transformedState, StateDescription stateDescription, CommandDescription commandDescription, String unitSymbol)

Uses of CommandDescription in org.openhab.core.items

Methods in org.openhab.core.items that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	GenericItem.getCommandDescription(@Nullable Locale locale)
default @Nullable CommandDescription	Item.getCommandDescription()	Returns the CommandDescription for this item.
@Nullable CommandDescription	Item.getCommandDescription(@Nullable Locale locale)	Returns the CommandDescription for the given locale.
protected @Nullable CommandDescription	GenericItem.getCommandOptions(@Nullable Locale locale)

Uses of CommandDescription in org.openhab.core.library.items

Methods in org.openhab.core.library.items that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	CallItem.getCommandDescription(@Nullable Locale locale)
@Nullable CommandDescription	ContactItem.getCommandDescription(@Nullable Locale locale)
@Nullable CommandDescription	ImageItem.getCommandDescription(@Nullable Locale locale)

Uses of CommandDescription in org.openhab.core.service

Methods in org.openhab.core.service that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	CommandDescriptionService.getCommandDescription(String itemName, @Nullable Locale locale)	Returns the locale specific CommandDescription for the given item name.

Uses of CommandDescription in org.openhab.core.thing.binding

Methods in org.openhab.core.thing.binding that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	BaseDynamicCommandDescriptionProvider.getCommandDescription(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale)

Methods in org.openhab.core.thing.binding with parameters of type CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	BaseDynamicCommandDescriptionProvider.getCommandDescription(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale)

Uses of CommandDescription in org.openhab.core.thing.dto

Fields in org.openhab.core.thing.dto declared as CommandDescription

Modifier and Type	Field	Description
CommandDescription	ChannelTypeDTO.commandDescription

Constructors in org.openhab.core.thing.dto with parameters of type CommandDescription

Modifier	Constructor	Description
	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 CommandDescription in org.openhab.core.thing.i18n

Methods in org.openhab.core.thing.i18n that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	ChannelTypeI18nLocalizationService.createLocalizedCommandDescription(org.osgi.framework.Bundle bundle, @Nullable CommandDescription command, ChannelTypeUID channelTypeUID, @Nullable Locale locale)

Methods in org.openhab.core.thing.i18n with parameters of type CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	ChannelTypeI18nLocalizationService.createLocalizedCommandDescription(org.osgi.framework.Bundle bundle, @Nullable CommandDescription command, ChannelTypeUID channelTypeUID, @Nullable Locale locale)

Uses of CommandDescription in org.openhab.core.thing.type

Methods in org.openhab.core.thing.type that return CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	ChannelType.getCommandDescription()	Returns the CommandDescription which should be rendered as push-buttons.
@Nullable CommandDescription	DynamicCommandDescriptionProvider.getCommandDescription(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale)	For a given Channel, return a CommandDescription that should be used for the channel, instead of the one defined statically in the ChannelType.

Methods in org.openhab.core.thing.type with parameters of type CommandDescription

Modifier and Type	Method	Description
@Nullable CommandDescription	DynamicCommandDescriptionProvider.getCommandDescription(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale)	For a given Channel, return a CommandDescription that should be used for the channel, instead of the one defined statically in the ChannelType.
StateChannelTypeBuilder	StateChannelTypeBuilder.withCommandDescription(@Nullable CommandDescription commandDescription)	Sets the list of CommandOptions for the ChannelType

Constructors in org.openhab.core.thing.type with parameters of type CommandDescription

Modifier	Constructor	Description
protected	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 CommandDescription in org.openhab.core.types

Methods in org.openhab.core.types that return CommandDescription

Modifier and Type	Method	Description
CommandDescription	CommandDescriptionBuilder.build()	Build a CommandDescription from the values of this builder.
@Nullable CommandDescription	CommandDescriptionProvider.getCommandDescription(String itemName, @Nullable Locale locale)	Returns the item specific, localized CommandDescription.