Added in API level 30

StatelessBuilder

class StatelessBuilder
kotlin.Any
   ↳ 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

Creates a StatelessBuilder using an existing Control as a base.
StatelessBuilder(controlId: String, appIntent: PendingIntent)
Public methods
Control

Control.StatelessBuilder

Control.StatelessBuilder
setControlId(controlId: String)
Control.StatelessBuilder

Optional color to be shown with the Control.
Control.StatelessBuilder
setCustomIcon(customIcon: Icon?)

Optional icon to be shown with the Control.
Control.StatelessBuilder
setDeviceType(deviceType: Int)
Control.StatelessBuilder

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

Control.StatelessBuilder

Control.StatelessBuilder

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

Public constructors

StatelessBuilder

Added in API level 30
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.

StatelessBuilder

Added in API level 30
StatelessBuilder(
    controlId: String, 
    appIntent: PendingIntent)
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.

Public methods

build

Added in API level 30
fun build(): Control
Return
Control a valid Control
This value cannot be null.

setAppIntent

Added in API level 30
fun setAppIntent(appIntent: PendingIntent): Control.StatelessBuilder
Parameters
appIntent PendingIntent: a PendingIntent linking to an Activity for the Control
This value cannot be null.
Return
Control.StatelessBuilder this
This value cannot be null.

setControlId

Added in API level 30
fun setControlId(controlId: String): Control.StatelessBuilder
Parameters
controlId String: the identifier for the Control
This value cannot be null.
Return
Control.StatelessBuilder this
This value cannot be null.

setCustomColor

Added in API level 30
fun setCustomColor(customColor: ColorStateList?): Control.StatelessBuilder

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.
Return
Control.StatelessBuilder this
This value cannot be null.

setCustomIcon

Added in API level 30
fun setCustomIcon(customIcon: Icon?): Control.StatelessBuilder

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.
Return
Control.StatelessBuilder this
This value cannot be null.

setDeviceType

Added in API level 30
fun setDeviceType(deviceType: Int): Control.StatelessBuilder
Parameters
deviceType Int: type of device represented by this Control, used to determine the default icon and color.
Value is one of the following:
Return
Control.StatelessBuilder this
This value cannot be null.

setStructure

Added in API level 30
fun setStructure(structure: CharSequence?): Control.StatelessBuilder

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.
Return
Control.StatelessBuilder this
This value cannot be null.

setSubtitle

Added in API level 30
fun setSubtitle(subtitle: CharSequence): Control.StatelessBuilder
Parameters
subtitle CharSequence: additional information about the Control, to appear underneath the title.
This value cannot be null.
Return
Control.StatelessBuilder this
This value cannot be null.

setTitle

Added in API level 30
fun setTitle(title: CharSequence): Control.StatelessBuilder
Parameters
title CharSequence: the user facing name of the Control
This value cannot be null.
Return
Control.StatelessBuilder this
This value cannot be null.

setZone

Added in API level 30
fun setZone(zone: CharSequence?): Control.StatelessBuilder

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.
Return
Control.StatelessBuilder this
This value cannot be null.