Added in version 37.2

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

AgentTaskEvent

---

Kotlin |Java

public final class AgentTaskEvent
extends Object implements Parcelable

java.lang.Object
↳	android.agenticon.AgentTaskEvent

---

Information about a one-time agent-related event to communicate to the user.

These will be shown to the user in the status bar for a short period of time, possibly hiding the current AgentTaskState.

The event must contain text, icons, or both. The order of display from start to end is:

1. Leading icons
2. Text
3. Trailing icons

where not empty/null. Some of these may be ellipsized or omitted if there's not enough space.

These events may not be shown in some cases, for example when many are sent in a short period of time, or if the user's status bar is hidden, or if other critical information must be displayed in the status bar instead.

Summary

Nested classes
class	AgentTaskEvent.Builder Builder for AgentTaskEvent.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<AgentTaskEvent>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Icon	getBackground() Background icon to use for the event.
PendingIntent	getClickAction() PendingIntent to send when the event text in the status bar is clicked.
CharSequence	getContentDescription() Returns the content description for this element.
List<Icon>	getLeadingIcons() List of leading icons to show at the start of the event content, before any text (if available) or the trailing icons.
static int	getMaxAllowedLeadingIcons() Maximum allowed number of leading icons to appear before the text (if any).
static int	getMaxAllowedTrailingIcons() Maximum allowed number of trailing icons to appear after the text (if any).
CharSequence	getText() Optional text to show to the user.
List<Icon>	getTrailingIcons() List of trailing icons to show at the end of the event content, after the text (if available) or the leading icons.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in version 37.2

public static final Creator<AgentTaskEvent> CREATOR

Public methods

describeContents

Added in version 37.2

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getBackground

Added in version 37.2

public Icon getBackground ()

Background icon to use for the event.

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

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

Returns
Icon	the background to use for the event. If null, the implementation will decide.

getClickAction

Added in version 37.2

public PendingIntent getClickAction ()

PendingIntent to send when the event text in the status bar is clicked.

The PendingIntent should target an Activity.

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.

Returns
PendingIntent	the action to execute when the element is clicked.

See also:

• Intent.getSourceBounds()

getContentDescription

Added in version 37.2

public CharSequence getContentDescription ()

Returns the content description for this element.

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

Returns
CharSequence	the content description associated with this whole element.

getLeadingIcons

Added in version 37.2

public List<Icon> getLeadingIcons ()

List of leading icons to show at the start of the event content, before any text (if available) or the trailing icons.

This list could be empty. If so, getText() or getTrailingIcons() must not be empty.

Some of the icons may not be displayed, if there's not enough space.

Returns
List<Icon>	the list of leading icons. This value cannot be null.

See also:

• getMaxAllowedLeadingIcons()

getMaxAllowedLeadingIcons

Added in version 37.2

public static int getMaxAllowedLeadingIcons ()

Maximum allowed number of leading icons to appear before the text (if any).

Returns
int	the maximum number of allowed leading icons. Value is 1 or greater

getMaxAllowedTrailingIcons

Added in version 37.2

public static int getMaxAllowedTrailingIcons ()

Maximum allowed number of trailing icons to appear after the text (if any).

Returns
int	the maximum number of allowed trailing icons. Value is 1 or greater

getText

Added in version 37.2

public CharSequence getText ()

Optional text to show to the user.

This can only be null or empty if one of getLeadingIcons() or getTrailingIcons() is not empty.

The text may be truncated if there's not enough space to show it.

Returns
CharSequence	the text to show as part of the event.

getTrailingIcons

Added in version 37.2

public List<Icon> getTrailingIcons ()

List of trailing icons to show at the end of the event content, after the text (if available) or the leading icons.

This list could be empty. If so, getText() or getLeadingIcons() must not be empty.

Some of the icons may not be displayed, if there's not enough space.

Returns
List<Icon>	the list of trailing icons. This value cannot be null.

See also:

• getMaxAllowedTrailingIcons()

writeToParcel

Added in version 37.2

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE