Action

public static final @NonNull Action APP_ICON

A standard action to show the app's icon.

This action is non-interactive.

public static final @NonNull Action BACK

A standard action to navigate back in the user interface.

The default behavior for a back press will call pop.

To override the default behavior, register a OnBackPressedCallback via addCallback, which you can retrieve from getOnBackPressedDispatcher.

@ExperimentalCarApi
@RequiresCarApi(value = 7)
public static final @NonNull Action COMPOSE_MESSAGE

A standard action to show the message compose button

This action is interactive.

@RequiresCarApi(value = 5)
public static final int FLAG_DEFAULT = 4

Indicates that this action is the default action out of a set of other actions.

The action with this flag may be treated differently by the host depending on where they are used. For example, it may be set as the default action to be triggered when the Alerter times out in the AlertCard. The first action with the FLAG_DEFAULT in an action list will be treated as the Default Action. See the documentation on where the Action is added for more details on any restriction(s) that might apply.

@RequiresCarApi(value = 5)
public static final int FLAG_IS_PERSISTENT = 2

Indicates that this action will not fade in/out inside an ActionStrip.

@RequiresCarApi(value = 4)
public static final int FLAG_PRIMARY = 1

Indicates that this action is the most important one, out of a set of other actions.

The action with this flag may be treated differently by the host depending on where they are used. For example, it may be colored or ordered differently to align with the vehicle's look and feel. See the documentation on where the Action is added for more details on any restriction(s) that might apply.

@ExperimentalCarApi
@RequiresCarApi(value = 8)
@RequiresPermission(value = "androidx.car.app.MEDIA_TEMPLATES")
public static final @NonNull Action MEDIA_PLAYBACK

A standard action to show the media playback button.

Note: ONLY apps with androidx.car.app.MEDIA_TEMPLATES can use this action. There are 2 ways to use this action.

1. Used as a floating action button in a browse view, the action must provide an OnClickListener which pushes a Screen that provides a MediaPlaybackTemplate.
2. Used as a mActions to indicate the currently playing song. An optional OnClickListener can be added.

public static final @NonNull Action PAN

A standard action to toggle the pan mode in a map-based template.

If the app does not provide a custom icon, a default pan icon will be used.

You can set a custom icon in a pan action with the following code:

Action panAction = new Action.Builder(Action.PAN).setIcon(customIcon).build();

public static final int TYPE_APP_ICON = 65538

An action representing an app's icon.

public static final int TYPE_BACK = 65539

An action to navigate back in the user interface.

@ExperimentalCarApi
@RequiresCarApi(value = 7)
public static final int TYPE_COMPOSE_MESSAGE = 65541

An action to allow user compose a message.

public static final int TYPE_CUSTOM = 1

An app-defined custom action type.

@ExperimentalCarApi
@RequiresCarApi(value = 8)
@RequiresPermission(value = "androidx.car.app.MEDIA_TEMPLATES")
public static final int TYPE_MEDIA_PLAYBACK = 65542

A standard action to show the media playback button.

Note: ONLY apps with androidx.car.app.MEDIA_TEMPLATES can use this action. There are 2 ways to use this action.

1. Used as a floating action button in a browse view, the action must provide an OnClickListener which pushes a Screen that provides a MediaPlaybackTemplate.
2. Used as a mActions to indicate the currently playing song. An optional OnClickListener can be added.

public static final int TYPE_PAN = 65540

An action to toggle the pan mode in a map-based template.

public @Nullable CarColor getBackgroundColor()

Returns the CarColor used for the background color of the action.

@RequiresCarApi(value = 4)
public int getFlags()

Returns flags affecting how this action should be treated

public @Nullable CarIcon getIcon()

Returns the CarIcon to display in the action or null if the action does not have an icon.

public @Nullable OnClickDelegate getOnClickDelegate()

Returns the OnClickDelegate that should be used for this action.

public @Nullable CarText getTitle()

Returns the title displayed in the action or null if the action does not have a title.

public int getType()

Returns the type of the action.

@RequiresCarApi(value = 5)
public boolean isEnabled()

Returns true if the action is enabled.

public boolean isStandard()

Returns whether the action is a standard action such as BACK.

public static @NonNull String typeToString(int type)

Converts the given type into a string representation.