AgentTaskEvent.Builder

Builder

public Builder (AgentTaskEvent.Builder other)

Creates a new Builder from another Builder.

Builder

public Builder (CharSequence text)

Creates a new Builder with a given non-empty text for the event.

In this case, the lists of icons are empty by default.

Builder

public Builder (List<Icon> leadingIcons, 
                List<Icon> trailingIcons)

Creates a new Builder with given lists of leading and trailing icons.

In this case, the text to show is empty by default.

At least one of the two lists must be non-empty.

The icons will be shown as is, with no tinting (only scaling to size).

If any of the list has more elements than the corresponding AgentTaskEvent.getMaxAllowedLeadingIcons() or AgentTaskEvent.getMaxAllowedTrailingIcons(), that list will be truncated to that size.

build

public AgentTaskEvent build ()

Creates the AgentTaskEvent instance.

The lists of icons may be truncated if more than AgentTaskEvent.getMaxAllowedLeadingIcons() or AgentTaskEvent.getMaxAllowedTrailingIcons() icons were set respectively.

setBackground

public AgentTaskEvent.Builder setBackground (Icon background)

Sets the background for the event.

This drawable will be masked to an appropriate shape and size, without changing the underlying proportions of the drawable. The mask will be centered on the scaled drawable. It is recommended for the drawable to be "wide", to ensure that top and bottom are not cropped.

If null, the background will be chosen by the implementation.

setClickAction

public AgentTaskEvent.Builder setClickAction (PendingIntent action)

Sets the click action.

If the PendingIntent was created with PendingIntent.FLAG_MUTABLE, as well as Intent.FILL_IN_SOURCE_BOUNDS, then the source bounds will be filled in with the coordinates on screen of the UI element that triggered this intent.

Based on the value of StatusBarManager.isAgentTaskLaunchSupported(), this value will be used differently by the implementation:

• If StatusBarManager.isAgentTaskLaunchSupported() is true, the value will be used as is if non-null. If the value is null, the default set using StatusBarManager.ACTION_AGENT_TASK_MAIN will be used as the click action for this event.
• If StatusBarManager.isAgentTaskLaunchSupported() is false, this value will be ignored by the implementation, regardless of whether it's null or not.

setContentDescription

public AgentTaskEvent.Builder setContentDescription (CharSequence contentDescription)

Sets the content description to be used by the built AgentTaskEvent

This should describe the whole element (including any icons or text). If null, it will fall back to AgentTaskEvent.getText() if possible or the implementation will use a suitable description.

setLeadingIcons

public AgentTaskEvent.Builder setLeadingIcons (List<Icon> leadingIcons)

Set the leading icons to show in the event

The list can be empty. Events must have text, icons, or both.

The icons will be shown as is, with no tinting (only scaling to size).

If the list has more than AgentTaskEvent.getMaxAllowedLeadingIcons() elements, it will be truncated to that size.

setText

public AgentTaskEvent.Builder setText (CharSequence text)

Sets the text to show.

If null, the event will show no text. Events must have either text, or icons, or both.

setTrailingIcons

public AgentTaskEvent.Builder setTrailingIcons (List<Icon> trailingIcons)

Set the trailing icons to show in the event

The list can be empty. Events must have text, icons, or both.

The icons will be shown as is, with no tinting (only scaling to size).

If the list has more than AgentTaskEvent.getMaxAllowedTrailingIcons() elements, it will be truncated to that size.