Control.StatelessBuilder

public static final class Control.StatelessBuilder
extends Object

java.lang.Object
   ↳ android.service.controls.Control.StatelessBuilder


Builder class for Control. This class facilitates the creation of Control with no state. Must be used to provide controls for ControlsProviderService#createPublisherForAllAvailable and ControlsProviderService#createPublisherForSuggested. It provides the following defaults for non-optional parameters:

This fixes the values relating to state of the Control as required by ControlsProviderService#createPublisherForAllAvailable:

Summary

Public constructors

StatelessBuilder(String controlId, PendingIntent appIntent)
StatelessBuilder(Control control)

Creates a StatelessBuilder using an existing Control as a base.

Public methods

Control build()
Control.StatelessBuilder setAppIntent(PendingIntent appIntent)
Control.StatelessBuilder setControlId(String controlId)
Control.StatelessBuilder setCustomColor(ColorStateList customColor)

Optional color to be shown with the Control.

Control.StatelessBuilder setCustomIcon(Icon customIcon)

Optional icon to be shown with the Control.

Control.StatelessBuilder setDeviceType(int deviceType)
Control.StatelessBuilder setStructure(CharSequence structure)

Optional top-level group to help define the Control's location, visible to the user.

Control.StatelessBuilder setSubtitle(CharSequence subtitle)
Control.StatelessBuilder setTitle(CharSequence title)
Control.StatelessBuilder setZone(CharSequence zone)

Optional group name to help define the Control's location within a structure, visible to the user.

Inherited methods

Public constructors

StatelessBuilder

Added in API level 30
public StatelessBuilder (String controlId, 
                PendingIntent appIntent)

Parameters
controlId String: the identifier for the Control This value cannot be null.

appIntent PendingIntent: the pending intent linking to the device Activity This value cannot be null.

StatelessBuilder

Added in API level 30
public StatelessBuilder (Control control)

Creates a StatelessBuilder using an existing Control as a base.

Parameters
control Control: base for the builder. This value cannot be null.

Public methods

build

Added in API level 30
public Control build ()

Returns
Control a valid Control This value cannot be null.

setAppIntent

Added in API level 30
public Control.StatelessBuilder setAppIntent (PendingIntent appIntent)

Parameters
appIntent PendingIntent: a PendingIntent linking to an Activity for the Control This value cannot be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setControlId

Added in API level 30
public Control.StatelessBuilder setControlId (String controlId)

Parameters
controlId String: the identifier for the Control This value cannot be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setCustomColor

Added in API level 30
public Control.StatelessBuilder setCustomColor (ColorStateList customColor)

Optional color to be shown with the Control. It is highly recommended to let the system default the color unless the default is not suitable for the application.

Parameters
customColor ColorStateList: background color to use This value may be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setCustomIcon

Added in API level 30
public Control.StatelessBuilder setCustomIcon (Icon customIcon)

Optional icon to be shown with the Control. It is highly recommended to let the system default the icon unless the default icon is not suitable.

Parameters
customIcon Icon: icon to show This value may be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setDeviceType

Added in API level 30
public Control.StatelessBuilder setDeviceType (int deviceType)

Parameters
deviceType int: type of device represented by this Control, used to determine the default icon and color Value is DeviceTypes.TYPE_GENERIC_ON_OFF, DeviceTypes.TYPE_GENERIC_START_STOP, DeviceTypes.TYPE_GENERIC_OPEN_CLOSE, DeviceTypes.TYPE_GENERIC_LOCK_UNLOCK, DeviceTypes.TYPE_GENERIC_ARM_DISARM, DeviceTypes.TYPE_GENERIC_TEMP_SETTING, DeviceTypes.TYPE_GENERIC_VIEWSTREAM, DeviceTypes.TYPE_UNKNOWN, DeviceTypes.TYPE_AC_HEATER, DeviceTypes.TYPE_AC_UNIT, DeviceTypes.TYPE_AIR_FRESHENER, DeviceTypes.TYPE_AIR_PURIFIER, DeviceTypes.TYPE_COFFEE_MAKER, DeviceTypes.TYPE_DEHUMIDIFIER, DeviceTypes.TYPE_DISPLAY, DeviceTypes.TYPE_FAN, DeviceTypes.TYPE_HOOD, DeviceTypes.TYPE_HUMIDIFIER, DeviceTypes.TYPE_KETTLE, DeviceTypes.TYPE_LIGHT, DeviceTypes.TYPE_MICROWAVE, DeviceTypes.TYPE_OUTLET, DeviceTypes.TYPE_RADIATOR, DeviceTypes.TYPE_REMOTE_CONTROL, DeviceTypes.TYPE_SET_TOP, DeviceTypes.TYPE_STANDMIXER, DeviceTypes.TYPE_STYLER, DeviceTypes.TYPE_SWITCH, DeviceTypes.TYPE_TV, DeviceTypes.TYPE_WATER_HEATER, DeviceTypes.TYPE_DISHWASHER, DeviceTypes.TYPE_DRYER, DeviceTypes.TYPE_MOP, DeviceTypes.TYPE_MOWER, DeviceTypes.TYPE_MULTICOOKER, DeviceTypes.TYPE_SHOWER, DeviceTypes.TYPE_SPRINKLER, DeviceTypes.TYPE_WASHER, DeviceTypes.TYPE_VACUUM, DeviceTypes.TYPE_AWNING, DeviceTypes.TYPE_BLINDS, DeviceTypes.TYPE_CLOSET, DeviceTypes.TYPE_CURTAIN, DeviceTypes.TYPE_DOOR, DeviceTypes.TYPE_DRAWER, DeviceTypes.TYPE_GARAGE, DeviceTypes.TYPE_GATE, DeviceTypes.TYPE_PERGOLA, DeviceTypes.TYPE_SHUTTER, DeviceTypes.TYPE_WINDOW, DeviceTypes.TYPE_VALVE, DeviceTypes.TYPE_LOCK, DeviceTypes.TYPE_SECURITY_SYSTEM, DeviceTypes.TYPE_HEATER, DeviceTypes.TYPE_REFRIGERATOR, DeviceTypes.TYPE_THERMOSTAT, DeviceTypes.TYPE_CAMERA, DeviceTypes.TYPE_DOORBELL, or DeviceTypes.TYPE_ROUTINE

Returns
Control.StatelessBuilder this This value cannot be null.

setStructure

Added in API level 30
public Control.StatelessBuilder setStructure (CharSequence structure)

Optional top-level group to help define the Control's location, visible to the user. If not present, the application name will be used as the top-level group. A structure contains zones which contains controls.

Parameters
structure CharSequence: name of the structure containing the control This value may be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setSubtitle

Added in API level 30
public Control.StatelessBuilder setSubtitle (CharSequence subtitle)

Parameters
subtitle CharSequence: additional information about the Control, to appear underneath the title This value cannot be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setTitle

Added in API level 30
public Control.StatelessBuilder setTitle (CharSequence title)

Parameters
title CharSequence: the user facing name of the Control This value cannot be null.

Returns
Control.StatelessBuilder this This value cannot be null.

setZone

Added in API level 30
public Control.StatelessBuilder setZone (CharSequence zone)

Optional group name to help define the Control's location within a structure, visible to the user. A structure contains zones which contains controls.

Parameters
zone CharSequence: name of the zone containing the control This value may be null.

Returns
Control.StatelessBuilder this This value cannot be null.