Action.Builder

Builder()

Creates an empty Builder instance.

@RequiresCarApi(value = 2)
Builder(action: Action)

Returns a Builder instance configured with the same data as the given Action instance.

fun build(): Action

Constructs the Action defined by this builder.

fun setBackgroundColor(backgroundColor: CarColor): Action.Builder

Sets the background color to be used for the action.

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system. See the documentation on where the Action is added for more details on any other restriction(s) that might apply.

@RequiresCarApi(value = 5)
fun setEnabled(enabled: Boolean): Action.Builder

Sets the initial enabled state for Action.

The default state of a Action is enabled.

@RequiresCarApi(value = 4)
fun setFlags(flags: Int): Action.Builder

Sets flags affecting how this action should be treated.

fun setIcon(icon: CarIcon): Action.Builder

Sets the icon to display in the action.

Unless set with this method, the action will not have an icon.

See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.

fun setOnClickListener(listener: OnClickListener): Action.Builder

Sets the OnClickListener to call when the action is clicked.

Unless set with this method, the action will not have a click listener.

Note that the listener relates to UI events and will be executed on the main thread using getMainLooper.

fun setTitle(title: CarText): Action.Builder

Sets the title to display in the action, with support for multiple length variants.

Support for text spans depends on where the action is used. For example, most templates taking an action support ForegroundCarColorSpan, but this may vary. See the documentation of the specific APIs taking an Action for details.

fun setTitle(title: CharSequence): Action.Builder

Sets the title to display in the action.

Support for text spans depends on where the action is used. See the documentation of the specific APIs taking an Action for details.