TemperatureControlTemplate

Kotlin |Java

class TemperatureControlTemplate : ControlTemplate

kotlin.Any
↳	android.service.controls.templates.ControlTemplate
	↳	android.service.controls.templates.TemperatureControlTemplate

A template for a temperature related Control that supports multiple modes. Both the current mode and the active mode for the control can be specified. The combination of the Control.getDeviceType and the current and active mode will determine colors and transitions for the UI element.

Summary

Constants
static Int	`FLAG_MODE_COOL` Flag to indicate that the device supports cool mode.
static Int	`FLAG_MODE_ECO` Flag to indicate that the device supports eco mode.
static Int	`FLAG_MODE_HEAT` Flag to indicate that the device supports heat mode.
static Int	`FLAG_MODE_HEAT_COOL` Flag to indicate that the device supports heat-cool mode.
static Int	`FLAG_MODE_OFF` Flag to indicate that the device supports off mode.
static Int	`MODE_COOL` Indicates that the current or active mode of the device is set to cool.
static Int	`MODE_ECO` Indicates that the current or active mode of the device is set to eco.
static Int	`MODE_HEAT` Indicates that the current or active mode of the device is set to heat.
static Int	`MODE_HEAT_COOL` Indicates that the current or active mode of the device is set to heat-cool.
static Int	`MODE_OFF` Indicates that the current or active mode of the device is off.
static Int	`MODE_UNKNOWN` Use when the current or active mode of the device is not known.

Inherited constants

From class ControlTemplate

`Int`	`TYPE_ERROR` Type identifier of the template returned by `getErrorTemplate()`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_NO_TEMPLATE` Type identifier of `ControlTemplate.getNoTemplateObject`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_RANGE` Type identifier of `RangeTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_STATELESS` Type identifier of `StatelessTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_TEMPERATURE` Type identifier of `TemperatureControlTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_THUMBNAIL` Type identifier of `ThumbnailTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_TOGGLE` Type identifier of `ToggleTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`
`Int`	`TYPE_TOGGLE_RANGE` Type identifier of `ToggleRangeTemplate`. Value is one of the following: `TYPE_ERROR` `TYPE_NO_TEMPLATE` `TYPE_TOGGLE` `TYPE_RANGE` `TYPE_THUMBNAIL` `TYPE_TOGGLE_RANGE` `TYPE_TEMPERATURE` `TYPE_STATELESS`

Public constructors
`TemperatureControlTemplate(templateId: String, controlTemplate: ControlTemplate, currentMode: Int, currentActiveMode: Int, modesFlag: Int)` Construct a new `TemperatureControlTemplate`.

Public methods
Int	`getCurrentActiveMode()`
Int	`getCurrentMode()`
Int	`getModes()`
ControlTemplate	`getTemplate()`
Int	`getTemplateType()`

Inherited functions

From class ControlTemplate

ControlTemplate

getErrorTemplate()

ControlTemplate

getNoTemplateObject()

Get a singleton ControlTemplate, which supports no direct user input. Used by Control.StatelessBuilder when there is no known state. Can also be used in Control.StatefulBuilder for conveying information to a user about the Control but direct user interaction is not desired. Since this template has no corresponding ControlAction, any user interaction will launch the Control.getAppIntent().

String

getTemplateId()

Parameters
`templateId`	String: the identifier for this template object. This value cannot be `null`.
`controlTemplate`	ControlTemplate: a template to use for interaction with the user. This value cannot be `null`.
`currentMode`	Int: the current mode for the `Control` Value is one of the following: `MODE_UNKNOWN` `MODE_OFF` `MODE_HEAT` `MODE_COOL` `MODE_HEAT_COOL` `MODE_ECO`
`currentActiveMode`	Int: the current active mode for the `Control` Value is one of the following: `MODE_UNKNOWN` `MODE_OFF` `MODE_HEAT` `MODE_COOL` `MODE_HEAT_COOL` `MODE_ECO`
`modesFlag`	Int: a flag representing the available modes for the `Control` Value is either `0` or a combination of the following: `FLAG_MODE_OFF` `FLAG_MODE_HEAT` `FLAG_MODE_COOL` `FLAG_MODE_HEAT_COOL` `FLAG_MODE_ECO`

TemperatureControlTemplate

Summary

Constants

FLAG_MODE_COOL

FLAG_MODE_ECO

FLAG_MODE_HEAT

FLAG_MODE_HEAT_COOL

FLAG_MODE_OFF

MODE_COOL

MODE_ECO

MODE_HEAT

MODE_HEAT_COOL

MODE_OFF

MODE_UNKNOWN

Public constructors

TemperatureControlTemplate

Public methods

getCurrentActiveMode

getCurrentMode

getModes

getTemplate

getTemplateType