ThumbnailTemplate

Kotlin |Java

class ThumbnailTemplate : ControlTemplate

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

A template for a Control that displays an image.

Summary

Inherited constants

From class ControlTemplate

`Int`	`TYPE_ERROR` Type identifier of the template returned by `getErrorTemplate()`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_NO_TEMPLATE` Type identifier of `ControlTemplate.getNoTemplateObject`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_RANGE` Type identifier of `RangeTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_STATELESS` Type identifier of `StatelessTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_TEMPERATURE` Type identifier of `TemperatureControlTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_THUMBNAIL` Type identifier of `ThumbnailTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_TOGGLE` Type identifier of `ToggleTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`
`Int`	`TYPE_TOGGLE_RANGE` Type identifier of `ToggleRangeTemplate`. Value is `android.service.controls.templates.ControlTemplate#TYPE_ERROR`, `android.service.controls.templates.ControlTemplate#TYPE_NO_TEMPLATE`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE`, `android.service.controls.templates.ControlTemplate#TYPE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_THUMBNAIL`, `android.service.controls.templates.ControlTemplate#TYPE_TOGGLE_RANGE`, `android.service.controls.templates.ControlTemplate#TYPE_TEMPERATURE`, or `android.service.controls.templates.ControlTemplate#TYPE_STATELESS`

Public constructors
`ThumbnailTemplate(templateId: String, active: Boolean, thumbnail: Icon, contentDescription: CharSequence)`

Public methods
CharSequence	`getContentDescription()` The description of the image returned by `ThumbnailTemplate.getThumbnail()`
Int	`getTemplateType()`
Icon	`getThumbnail()` The `Icon` (image) displayed by this template.
Boolean	`isActive()`

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()

Public constructors

ThumbnailTemplate

Added in API level 31

ThumbnailTemplate(
    templateId: String, 
    active: Boolean, 
    thumbnail: Icon, 
    contentDescription: CharSequence)

Parameters
`templateId`	String: the identifier for this template object This value cannot be `null`.
`active`	Boolean: whether the image corresponds to an active (live) stream.
`thumbnail`	Icon: an image to display on the `Control` This value cannot be `null`.
`contentDescription`	CharSequence: a description of the image for accessibility. This value cannot be `null`.

Public methods

getContentDescription

Added in API level 31

fun getContentDescription(): CharSequence

The description of the image returned by ThumbnailTemplate.getThumbnail()

Return
`CharSequence`	This value cannot be `null`.

getTemplateType

Added in API level 31

fun getTemplateType(): Int

Return
`Int`	`ControlTemplate.TYPE_THUMBNAIL`

getThumbnail

Added in API level 31

fun getThumbnail(): Icon

The Icon (image) displayed by this template.

Return
`Icon`	This value cannot be `null`.

isActive

Added in API level 31

fun isActive(): Boolean